Using Email Adapters with Ensemble
Settings for the Email Inbound Adapter
[Home]  [Next]
InterSystems: The power behind what matters   
Class Reference   
Search:    

Provides reference information for settings of the email inbound adapter.
Summary
The inbound email adapter has the following settings:
Group Settings
Basic Settings POP3 Server, POP3 Port, Credentials, Call Interval
Connection Settings SSL Configuration
Additional Settings Match From, Match To, Match Subject
The remaining settings are common to all business services. For information, see Settings for All Business Services in Configuring Ensemble Productions.
Call Interval
Number of seconds that the adapter will wait before checking again for new email, before checking for a shutdown signal from the Ensemble framework.
If the adapter finds input, it acquires the data and passes it to the business service. The business service processes the data, and then the adapter immediately begins waiting for new input. This cycle continues whenever the production is running and the business service is enabled and scheduled to be active.
The default Call Interval is 5 seconds. The minimum is 0.1 seconds.
Credentials
ID of the Ensemble credentials that contain the username and password of a valid mailbox on the given POP3 server. For information on creating Ensemble credentials, see Configuring Ensemble Productions.
Match From
A list of strings to look for in the From: field of incoming email messages, separated by semicolons (;). If this setting is null, the From: field is ignored when selecting messages to retrieve. For details, see Specifying the Messages to Retrieve,” earlier in this book.
Match Subject
A list of strings to look for in the Subject: field of email messages, separated by semicolons (;). If this setting is null, the Subject: field is ignored when selecting messages to retrieve. For details, see Specifying the Messages to Retrieve,” earlier in this book.
Match To
A list of strings to look for in the To: field of email messages, separated by semicolons (;). If this setting is null, the To: field is ignored when selecting messages to retrieve. For details, see Specifying the Messages to Retrieve,” earlier in this book.
POP3 Port
TCP port on the POP3 email server to get mail from. The default value is 110.
POP3 Server
Address of the POP3 email server to get mail from.
SSL Configuration
The name of an existing SSL/TLS configuration to use to authenticate this connection. Choose a client SSL/TLS configuration, because the adapter initiates the communication.
To create and manage SSL/TLS configurations, use the Management Portal. See the chapter Using SSL/TLS with Caché in the Caché Security Administration Guide. The first field on the Edit SSL/TLS Configuration form is Configuration Name. Use this string as the value for the SSLConfig setting.