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 outgoing account port numbers are port "25", however, if you leave the setting at its default value of "-1" the OutgoingAccount 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 "joejones@acme.com" on the host described above, the account name is simply "joejones". The Hostname in this case could be "mail.acme.com".

Password

This is the login credential for the Account specified in the previous field. Increasing the pollrate value increases the time between polls. During the time between polls, emails may be queued (up to the max queue size) until the next poll time. At the next poll time all queued emails are sent.

Pollrate

This field allows you to specify how often the account executes a send action.

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:

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 on the OutgoingAccount 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.

Transport

This field allows you to select from available options for email communication. The default setting and most common is SMTP.

Connection Timeout

This configurable field setting controls how long the station waits for a response from the mail server before generating an exception and setting the fault cause. It waits for the next scheduled poll and attempts to contact the mail server again at that frequency.

Use Authentication

This property allows you to specify that login credentials are required for sending any email. Sometimes authentication is not required for emails routed to recipients in the same domain. Setting this property to true makes the login credentials mandatory for any email.

Reply To

This field specifies the contents of the "From:" field in the email that is sent.

Persistent, Persistent Directory

Setting the Persistent property to true saves each queued email as an xml file in the designated persistence directory. Once the emails are actually sent, the xml files are deleted from the directory. The purpose of this is to keep a copy of the emails in the queue which would be lost if the station was stopped prior to the emails being sent. When the station restarts, emails are loaded from the "Persistent Directory" back to the queue.

Email Queue Tracking Properties

"Queue" is where emails reside while they are waiting to be sent. Assuming that the Account Status is "ok", typically, the length of time that an email is in the queue depends on the "Pollrate" setting. The following properties relate to the queue and mail management properties: