The email IncomingAccount component is required for receiving emails in a station. One use of this component is for email alarm acknowledgement with the EmailAcknowledger component.
In order to use the EmailAcknowledger, you must set up the IncomingAccount under the EmailService and connect it’s “received”
slot to the EmailAcknowledger “received” slot, as shown below. More than one IncomingAccount may be connected to the EmailAcknowledger,
if desired.
This IncomingAccount component is located in the email palette and should be added under the EmailService component, as shown below.
With the default configuration (see Delivery Policy property, below) the incoming email account deletes all emails from the
mail server when it checks the account to retrieve new email, even if the emails are already marked as read by another email
client. If permanent retention of the emails is required then do one of the following: (1) change the Delivery Policy setting
from Delete to Mark As Read or Mark as Unread OR (2) configure a second service account which the mail server forwards emails to and configure the station's incoming account
to check the second service account
The IncomingAccount has the following properties:
-
Hostname
This is the name of the mail server. For example mail.acme.com could be a Hostname.
-
Port
This is the port number associated with the email account. Typically email incoming account port numbers are port "110", however, if you leave the setting at its default value of "-1" the IncomingAccount will search for and use a valid port.
-
Account
This is the name of the distinct account that is authorized for access to the "Hostname" mail server. For example, if you are using an email account named "controls@acme.com" on the host described above, the account name is simply "controls". The Hostname in this case could be "mail.acme.com".
-
Password
This is the login credential for the Account specified in the previous field.
-
Pollrate
This field allows you to specify how often the account connects to the mail server and checks for unread mail messages. Increasing the pollrate value increases the time between polls.
-
Enabled
This field allows you to activate or deactivate the account by choosing true or false, respectively.
-
Status
This is a read-only display of the condition of service. The status displays {ok} if the account is polling successfully. Other indications include:
-
{down} which means that the polling is unsuccessful, perhaps because of an incorrect Hostname, Password, or Account name
-
{disabled} because the Enable property is set to false
-
-
Last Poll Success, Last Poll Failure
These two properties display the time (in hours and minutes) of the last polling success and failure.
-
Last Poll Failure Cause
This display-only field provides an error message to indicate a reason for polling failure.
-
Debug
This Boolean property turns Debug mode on true or off, as desired. When Debug is turned on, you can see detailed debug information in a station's standard output view (WorkbenchAX Platform > Application Director view) when the Station tries to send or receive email. This can be used to troubleshoot the accounts and faults.
-
Use Ssl
The Ssl (Secure Socket Layer) option is available starting in NiagaraAX-3.5. The option list allows you to disable Ssl (false) or enable it (true). Enable Ssl for communication with a host email server that requires it.
-
Store
This property allows you to choose between two standards of mail retrieval. You need to choose the option that is in use by your host mail server:
-
Imap
-
Pop3
-
-
Delivery Policy
This property (available starting in NiagaraAX-3.5) provides an option list that allows you to select how the incoming email account handles incoming emails at the mail server. The following options are available:
-
Delete
With this configuration the incoming email account deletes all emails from the mail server when it checks the account to retrieve new email, even if the emails are already marked as read by another email client
-
Mark As Read
This option marks all emails as read on the mail server when it checks the account to retrieve new email
-
Mark As Unread
This option marks all emails as unread on the mail server when it checks the account to retrieve new email.
-