email-IncomingAccount

email-IncomingAccount

This component is required for a station to receive email.

Figure 6. Incoming Account Property Sheet

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. Typically, the incoming email account number is 110. If you leave the setting at its default value of minus one (-1), the IncomingAccount 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.
Store	email retrieval standards	Selects the email retrieval standard. Use the option supported by your mail server: Imap Pop3
Delivery Policy	various	Provides a list of options that control how the incoming email account handles incoming emails at the mail server. `Delete` causes the account to remove all emails from the mail server when it checks the account to retrieve new email. This happens even if the emails are already marked as read by another email client. `Mark As Read` sets all emails to the read state when the account checks to retrieve new email from the server. `Mark as Unread` sets all emails to the unread state when the account checks to retrieve new email from the server
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.

Email Authentication 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.
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.