| | |
| Make/Model | Device Version | Connection Type |
| Generic/POP3 | N/A | IP |
POP3 is a simple protocol used to retrieve email. This driver will use the POP3 protocol to download the current number of emails in your inbox, as well as the email headers (Date, Sender, Subject). The primary purpose of this driver is to notify you of the emails in your inbox, it does not actually download the entire message. It driver also has the ability to search the email message for tokens you define that can be used to trigger events in CQC.
When loading the driver you will be prompted to enter your POP3 username and password. At this time only plaintext authentication is supported. POP3 Secure Authentication/APOP and SSL (i.e. GMAIL) are not supported natively. However, you can run this driver with an SSL proxy like stunnel which has been tested with the driver. For information on how to configure stunnel see below.
None known at this time.
The driver connects to your server over an ethernet connection. When you load the driver you will be prompted to enter the server name and port as well as the interval you want the driver to check for new mail. The driver can only connect to a single server/account. If you have several email accounts, you will need to load one driver instance for each.
The driver supports custom date/time formats as described in the CML Time Class. When you load the driver you can configure the format you want time displayed in the stringlist fields and LastUpdated field.
This prompt allows you to configure how you want the HeaderList stringlist to display email headers. The allowed tokens are below. It is recommended you include either the message id and/or date/time so that list entries are unique. If an email comes in and the line is not unique, the driver will prepend the message id and a colon to the line to force it to be unique.
- %(M) - Message ID Number
- %(D) - Date/Time Message Sent, Uses DateFormat
- %(S) - Subject Line
- %(N) - From Display Name
- %(E)- From Email Address
- %(F) - From Line (Display Name and Email Address)
When loading the driver you will be prompted to create custom fields, which are fields you would like to create that are updatable via emails. In the text box enter custom field names and their associated type one per line, separated by a comma. The driver supports creation of String, Card, Int, Float, and Boolean.
When loading the driver, you will also be prompted for a custom field authentication string. If you enter a string here, that string must be sent along with field tokens to update a custom field. If you leave the string blank, no authentication is required for command emails.
To update a field via an email, insert the field value between field tokens. Field tokens take the format <Fieldname>Value</Fieldname>. For example, to update a field named "MyBoolean", send an email with <MyBoolean>True</MyBoolean>. If the value is not valid for the type of field, the field will not be updated. Only the first 25 lines of the email are searched.
If you have setup an Authentication String, you will need to include it within an <Auth> token, for the fields to be updated. The format for the <Auth> token is <Auth>AuthString</Auth> and can be anywhere in the body of the same email. Each email is authenticated separately.
This section lists the fields that the driver makes available, their types, minimum and maximum values, etc...
Name Type R/W Description/Limits HostName String R Hostname of the POP3 server HostAddress String R IP and Port of the POP3 server Username String R/W Username used for POP3 authentication Password String W Password used for POP3 authentication MessageCount Card R Number of emails messages in inbox LastUpdatedTime Time R Time of last update LastUpdated String R Date of last update LastStatus String R Status of last update. Possible values are Success, Connect Error, Authentication Error (USER), Authentication Error (PASS), Status Error, Message Header Error, Connection Timeout, An Unknown Error Occurred DateList StringList R Date lines in message headers FromList StringList R From lines in message headers SubjectList StringList R Subject lines in message headers HeaderList StringList R Customized message headers AuthToken String R./W Authentication string fro Command Emails GetMail Boolean W Force mail download when set to True DeleteCmdMsg Boolean R/W Delete message with command tokens (Command Emails) DateFormat String R/W Format to display date/times in HeaderFormat String R/W Format to display HeaderList lines in