The Email Settings connect FlexDeploy to your email server, allowing for outgoing email notifications and, if enabled, incoming reply processing for approval responses. If you are using OAuth with Microsoft Office 365 or wish to utilize the Graph API for your email provider, please refer Microsoft Office 365 Email with OAuth or Microsoft Office 365 Email with Graph API.
Table of Contents | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
|
Outgoing Email Settings
...
Property | Description | Default Values | ||
---|---|---|---|---|
Auth Type | Authentication method for connecting to the outgoing email server. Typically, SMTP is used, but when OAuth is enabled, Microsoft Graph API is also supported. | Basic Auth | ||
Host Name | Hostname for the outgoing email server. |
| ||
Host Port | Port number for the outgoing email server. | 25 | ||
User Name | Outgoing email authentication username. If using OAuth, this must match the user who completed the Authorize action for Microsoft Azure application on the System Settings - Integration Settings page. | |||
Password | The outgoing email user's password. This is not required when using OAuth. | |||
OAuth Application | OAuth application configured and authorized on the System Settings - Integration Settings. | |||
From Address | Address from which all outbound emails are sent |
| ||
SMTP Enable STARTTLS | Enables the use of the STARTTLS command (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands. Reference - https://kunder.support/knowledgebase/400/SSL-vs-TLS-vs-STARTTLS.html | true | ||
SMTP Properties | SMTP Server Properties. These are all the properties applied when connecting to your mail server. Depending on your mail server you may need to add more properties than the default below. With this field you have access to the follow variables to use in the SMTP Properties:
Default SMTP Properties
| PROTOCOL=smtp |
...
Property | Description | Default Values | |||||
---|---|---|---|---|---|---|---|
Enable Email Approval | Enable approvals by email reply. This requires the hostname/port and additional properties based on the authentication type. | false | |||||
Auth Type | Authentication method for connecting to the incoming email server. Typically, IMAP is used, but when OAuth is enabled, Microsoft Graph API is also supported. | Basic Auth | |||||
Host Name | Hostname for the incoming email server. |
| |||||
Port | Port number for the incoming email server. | 993 | |||||
User Name | Incoming email authentication username. If using OAuth, this must match the user who completed the Authorize action for Microsoft Azure application on the System Settings - Integration Settings page. Defaults to the incoming email username. | ||||||
Password | The incoming email user's password. This is not required when using OAuth. Defaults to the incoming email password. | ||||||
OAuth Application | OAuth application configured and authorized on the System Settings - Integration Settings. Leave blank to use the same app as outgoing email. | ||||||
IMAP Enable STARTTLS | Enables the use of the STARTTLS command (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands. Reference - https://kunder.support/knowledgebase/400/SSL-vs-TLS-vs-STARTTLS.html | false | |||||
IMAP Properties | IMAP Server Properties. These are all the properties applied when connecting to your mail server. Depending on your mail server you may need to add more properties than the default below. With this field you have access to the follow variables to use in the IMAP Properties:
Default IMAP Properties
| PROTOCOL=imap | |||||
Email Reply Folder | The email folder to process replies from. Defaults to INBOX if not specified. All inbound emails will be sent to default inbox folder, but rules can generally be configured on mail servers to move them to other folders if desired.
| INBOX | |||||
Approval Reply Address | Return address for approval replies. Defaults to the outgoing email From Address.
| ||||||
Email Reply Process Interval | Frequency in which FlexDeploy processes inbound messages from the Email . Required if email approvals are enabled. Default value is 5 minutes. | 5 | |||||
Email Reply Process Count | Number of email messages which are read and processed each interval. The limit prevents Spam or DoS attacks from impacting the performance of the FlexDeploy server. Required if email approvals are enabled. Default value is 30 messages. | 30 |
...
Are you using TLS?
If TLS, make sure STARTTLS is disabled and IMAP Properties contains the line for "starttls.enable". Match the version of TLS version used on your IMAP server with the imap property: e.g. "mail.${{PROTOCOL}}.ssl.protocols=TLSv1.2".
Can you connect to IMAP server outside of FlexDeploy server? Running the below command will test for this:
openssl s_client -crlf -connect {YOUR_IMAP_HOST}:{YOUR_IMAP_PORT}
Can you connect to IMAP server within FlexDeploy server? Running the below command will test for this:
tag login {YOUR_ACCOUNT_USERNAME} {YOUR_ACCOUNT_PASSWORD}
Are you using a SSL port?
Set PROTOCOL to "imaps" in the IMAP Properties or add this line "mail.${{PROTOCOL}}.ssl.enable=true" to allow usage of SSL.
In the case of SSL certificate errors such as "javax.mail.AuthenticationFailedException: AUTHENTICATE failed" you may have to load certificate files in java keystore.
For PKCS12 certificates - https://jackstromberg.com/2013/05/importing-a-ssl-certificate-into-a-java-keystore-via-a-pkcs12-file/
...
Notes
Please make sure there are no extra special chars while copying SMTP or IMAP properties in the property box.
To run SMTP in debug mode set the Log level to finest .and logs can be found at catalina.out