Settings for the Email Outbound Adapter
Provides reference information for settings of the settings outbound adapter.
Summary
The outbound email adapter has the following settings:
| Group |
Settings |
| Basic Settings |
SMTP Server, SMTP Port, Credentials |
| Connection Settings |
SSL Configuration, SSL Check Server Identity |
| OAuth2 |
OAuth2 Authorization Properties, OAuth2 Authorization Workflow Role, OAuth2 Callback Handler, OAuth2 Client Application Name, OAuth2 Grant Type, OAuth2 Scope |
| OAuth2 Grant Specific |
OAuth2 JWT Subject |
| Additional Settings |
Recipient, Cc, Bcc, From, ContinueIfInvalidRecipient |
The remaining settings are common to all business services. For information, see Settings for All Business Services.
Bcc
Specifies a comma-separated list of email addresses to add to the Bcc: list of each mail message sent.
Cc
Specifies a comma-separated list of email addresses to add to the Cc: list of each mail message sent.
ContinueIfInvalidRecipient
If selected, the adapter continues to send the message if one or more of the recipients have an invalid address.
Credentials
The ID of the production credentials that can authorize a connection to the given server. For information on creating production credentials, see Configuring Productions.
From
The default From: address to put in mail messages. May be overridden by the business operation implementation code.
OAuth2 Authorization Properties
Extra properties in the grant flow authorization process.
Comma separated key value pairs such as access_type=offline,prompt=consent.
OAuth2 Authorization Workflow Role
The Workflow Role to which authorization requests will be sent depending on Grant Type flow. For more information on workflow roles, see Workflow Roles and UsersOpens in a new tab.
OAuth2 Callback Handler
If OAuth2 Client Application Name is specified, this class is used to handle obtaining the access token. The default is Ens.Util.XOAuth2.Handler which can be subclassed for access token retrieval customization.
OAuth2 Client Application Name
OAuth2 Client Configuration Application name to use. This is the client configuration created in InterSystems IRIS® OAuth 2.0 settings. If specified, sub classes can use this as an indication that OAuth 2.0 is to be used and the name is used in the Authorization and Access Token retrieval process.
OAuth2 Grant Type
This is the grant type flow that the OAuth2 Callback Handler will follow. Ability to follow the grant flow type will depend on the OAuth2 Callback Handler implementation, as well as InterSystems IRIS® and the external OAuth2 server's support for the grant type flow.
OAuth2 Scope
This specifies the scope included in the authorization request. If not specified, it uses the default scope specified in the OAuth2 Client Application Name.
Recipient
Specifies a comma-separated list of email addresses to add to the To: list of each mail message sent.
SMTP Port
The port on the SMTP server to send mail to. The default value is 25.
SMTP Server
The IP address of the SMTP server to send mail to. (Note: the timeouts for connecting and sending mail can be more than 10 minutes).
SSL Configuration
The name of an existing TLS configuration to use to authenticate this connection. Choose a client TLS configuration, because the adapter initiates the communication.
To create and manage TLS configurations, use the Management Portal. See InterSystems TLS Guide. The first field on the Edit SSL/TLS Configuration form is Configuration Name. Use this string as the value for the SSLConfig setting.
Generally, when you specify a value for this setting, outbound email opens a socket on default port 465 and uses SMTP over TLS. However, the SSL Config setting also supports the server interaction described in the RFC3207 standard. Specifically, you can enable the system to initiate the connection by opening a standard TCP socket and then switching to a TLS connection on the same port. The system achieves the switch by issuing the issue the STARTTLS command. To enable this special type of connection, you include an asterisk at the end of the SSL Config value, for example, MySSLItem*. The default SMTP port in this case is 25.
For further information, see the description of the SSLConfigOpens in a new tab property in the Class Reference entry for EnsLib.EMail.OutboundAdapterOpens in a new tab.
SSL Check Server Identity
When connecting to a POP3 or SMTP server via TLS, the server name in the certificate must match the DNS name used to connect to the server. This match is based on the rules in section 3.1 of RFC 2818.
