email-OutgoingAccount
This component is required for sending emails from a station through the smtp transport. It is in the email palette. You add this component under the EmailService component.
| Property | Value | Description |
|---|---|---|
| Hostname | mail.name.com, where name varies depending on the host. | Defines the name of the email server.
For example mail.acme.com. |
| Port | number | The number of the port that the system associates with the email account of the provider. Typically, the outgoing email account number is 25. If you leave the setting at its default value of minus one (-1), the OutgoingAccount searches for and uses a valid port. |
| Email Authenticator | additional properties (defaults to O Auth Email Client Secret Authenticator) | Defines the type of email authenticator. For property descriptions, refer to “Email Authenticator” properties below. |
| Pollrate | hours: minutes: seconds | Specifies how often the account executes a send action. 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. |
| Enabled | true or false | Activates (true)
and deactivates (false) use of the object (network,
device, point, component, table, schedule, descriptor, etc.). |
| Status | read-only | Reports the condition of the entity
or process at last polling. {ok} indicates that the component is licensed and polling successfully. {down} indicates that the last check was unsuccessful, perhaps because of an incorrect property, or possibly loss of network connection. {disabled} indicates that the Enable property is set to false. {fault} indicates another problem. Refer to Fault Cause for more information. |
| Last Poll Success, Last Poll Failure | hours and minutes | Each of these properties displays the time of the last polling success and failure, respectively. |
| Last Poll Failure Cause | read-only | Displays an error message to indicate the reason for the polling failure. |
| Debug | Boolean property | Turns debug mode on and off. When on, and the station sends or receives email, the system displays detailed information using the platform’s standard Application Director view. |
| Use Start Tls | true or false (default) | This property allows you to enable and disable communication
security. The option must be set to true or false according to the instructions provided by the email
provider. Note: Use Ssl and Use Start Tls are mutually exclusive. Both
may be false. To provide secure email, set one property to true, and
the other false. Do not enable or disable the Use Ssl or Use Start
Tls properties without configuring the Port. |
| Tls Min Protocol | defaults to TLSv1.2+ | Determines the minimum acceptable TLS version to use. |
| Use Ssl | true or false (default) | This encrypts the connection before it is opened. The encryption
automatically uses either SSL v3 or TLS (depending on email server
requirements). The option must be set to true or false according to the instructions provided by the email
provider. Note: Use Ssl and Use Start Tls are mutually exclusive. Both
may be false. To provide secure email, set one property to true, and
the other false. Do not enable or disable the Use Ssl or Use Start
Tls properties without configuring the Port. |
| Transport | text | Selects among the available email communication protocols. The most common value is SMTP. |
| Connection Timeout | time | Controls how long the station waits for a response from the mail server before generating an exception and setting the fault cause. At the next scheduled poll, the account attempts to contact the mail server again. |
| Use Authentication | true or false | Allows you to require logon credentials for sending any email (true). Sometimes authentication is not required for emails that are routed to recipients within the same domain (as an example of when false would be an appropriate option). The option must be set to true or false according to the instructions provided by the email provider. |
| Reply To | email address | This Property must follow the instructions provided by the email provider. Most often this is the same as the Account Property:myaccount@example.com. |
| Persistent, Persistent Directory | true or false | true saves each queued email as an .xml file in the designated persistence directory until all emails are sent. Once sent, the system deletes the xml files from the directory. This prevents lost email in the event the station stops before the system can send the emails. |
| Queue Tracking Properties | various | Emails wait in the queue to be sent the next time the system polls the account. The length of time in the queue depends on the poll rate. See "Queue Tracking Properties". |
| Property | Value | Description |
|---|---|---|
| Type | drop-down list | Selects the type of email authenticator. |
| Basic Email Client Authenticator | additional properties | account: Specifies account details. password: Enter password. |
| No Auth Email Client Authenticator | Indicates that no Auth Email Client Authenticator is used. | |
| O Auth Email Client Secret Authenticator | authServerMetadataEndpoint:Displays the URI (published by the Identity Provider) that is used to obtain metadata related to the authentication services provided by the Identity Provider. It is used to configure the authentication client for the services supported by the Identity Provider. When specifying this URI, leave off the ‘/.well-known/openid-configuration’ path segment, as it is appended to the property’s value by the authentication client when resolving the authorization server metadata. account: Specifies the email account/user name for which messages will be sent/received. clientId: Specifies the clientId of the application that has been registered with the Identity Provider. scope: Specifies the scopes for which an access token will be requested from the Identity Provider. clientSecret: Specifies the client secret that is associated with the OAuth client that has been registered with the Identity Provider. | |
| O Auth Email Client Certificate Authenticator | authServerMetadataEndpoint: Displays the URI (published by the Identity Provider) that is used to obtain metadata related to the authentication services provided by the Identity Provider. It is used to configure the authentication client for the services supported by the Identity Provider. When specifying this URI, leave off the ‘/.well-known/openid-configuration’ path segment, as it is appended to the property’s value by the authentication client when resolving the authorization server metadata. account: Specifies the email account/user name for which messages will be sent/received. clientId: Specifies the clientId of the application that has been registered with the Identity Provider. scope: Specifies the scopes for which an access token will be requested from the Identity Provider. clientCertificate: Specifies the certificate that is associated with the OAuth client that has been registered with the Identity Provider, which is used as proof of identity during authentication. privateKeyPassword: useJWTBearerAssertion: When set to false, token requests to the Identity Provider will use the OAuth Client Credentials grant. When set to true, token requests will use the OAuth JWT Bearer grant, which must be supported by the Identity Provider for this feature to work. |
Queue Tracking Properties
| Property | Value | Description |
|---|---|---|
| Allow Disabled Queuing | true or false | true allows emails to remain in the queue even when Enabled is false. |
| Queue Size | number | Refers to the number of emails waiting to be sent in the queue. To clear the queue at any time, right-click on the appropriate outgoing account name (OutgoingAccount) and click . |
| Max Queue Size | number | Specifies how many emails can wait in the queue. |
| Number Sent | number | Indicates the number of emails sent. To reset this number to zero at any time, right-click the appropriate outgoing account name (OutgoingAccount) and click . |
| Max Sendable Per Day | number | Allows you to limit the number of emails that may be sent daily according to the instructions of email provider. |
| Number Discarded | read-only number | Reports how many emails the system did not successfully send. |
| Last Discard | read-only | Displays the date and time of the last failed email. |
| Last Discard Cause | read-only | Displays an error message that indicates the cause of the last email send failure. |