SMTP Device Engines enable xMatters to send notifications to and receive responses from service providers using MAPI or POP protocols.
Note that the xMatters account to which email responses are sent handles deleted emails differently for IMAP and POP accounts:
|
Details |
Description |
|
Name |
Name used to identify this Device Engine. |
|
Description |
Brief description of this Device Engine (optional). |
|
Notification Polling |
How often (in seconds) the Device Engine polls the notification node for new alerts. Must be a whole number greater than or equal to 10 and less than or equal to 300. |
|
Concurrent Threads |
Number of requests or tasks that this Device Engine can run at the same time. Your Active Licenses control the maximum number of available threads. |
|
Logging |
For an explanation of Device Engine logging, see Enabling Device Engine logging. |
|
Incoming Protocol |
Protocol to use for incoming messages. |
|
Note: If you specify a POP or IMAP Incoming Protocol, xMatters prompts you to specify the following additional details for the SMTP Device Engine. The page with these settings will load after you click Continue. |
|
|
Email Account |
Email address used to send notifications. Note: This email address must not be the same as the email account specified in the Mail Sender field of the Bounced Mail Settings area on the Global Configuration page. |
|
Email Format |
Specifies which of the following formats is used by the POP/IMAP server to authenticate and display email accounts in notification messages from xMatters:
Note that different formats are required by different POP/IMAP servers; consult your provider’s documentation to determine the correct format. |
|
Password |
Password to access the SMTP/POP server. |
|
Incoming Email Server |
Email server to poll for responses. |
|
Incoming Server Port |
Server port to use for incoming responses. |
|
SSL Flag |
Specifies whether the protocol’s SSL flag is enabled or disabled. When selected, the encryption key supplied by the server as part of SSL is used for encryption; there is no need to install a client certificate. Note: The implementation of SSL in xMatters also supports Transport Layer Security (TLS). |
|
Mailbox Polling Interval (sec) |
Indicates how often (in seconds) the Device Engine polls the mailbox for a response. |
|
Notification Key |
String included in the body of the notification that identifies the original alert or notification to which the User is responding. Normally this key is enclosed with delimiting characters; e.g., the default value, <%Notification Key%>. If the delimiting character sequence is not guaranteed to be unique, the Device Engine may make an incorrect match, causing an exception and response failure. If no delimiters are present, the first word of the response will be used as the notification key. If the delimiters occur more than once in the body of the notification, the first instance is used as the notification key. |
|
Response Key |
String included in the body of the notification that identifies the beginning of the response portion of the User’s return message. |
|
Default Message |
Default notification message displayed to the recipient. |
|
Choice Message |
Portion of the notification message that defines User options. |
|
Response Message |
Portion of the notification message that contains the response instructions. |