Email Server policy (EmailServer)

Attach an Email Server policy to one or more EmailInput nodes in a message flow to control the connection to an email server at run time.

You use an EmailInput node in a message flow to retrieve email from an email server. You can use an Email Server policy to control, at run time, the connection details for the email server.

To attach an Email Server policy to an EmailInput node, set the Email server property of the EmailInput node to the name of the policy, in the format {policyProjectName}:policyName. You must deploy this policy before the associated message flow is started.

If you redeploy an EmailServer policy, all message flows that are using the policy will be stopped and restarted.

The properties of this policy are described in the following table.
Table 1. Properties of the Email Server policy
Property Property name in .policyxml file Value
Email server name emailServer This mandatory property specifies the URL of the email server that contains incoming email messages. The URL includes the protocol, hostname, and port number, which is the minimum information you need to connect to the email server. The URL must be in the format protocol://hostname:port, where:
  • protocol can be pop3, pop3s, imap, or imops.
  • hostname is the TCP/IP address or DNS-resolvable hostname of the email host.
  • port is the port number that the email server is listening on for connections over Post Office Protocol 3 (POP3) or Internet Message Access Protocol (IMAP). You can enter an integer in the range 1 - 65535.
For example:
pop3://myemailserver.com:12345
imap://myemailserver.com:56789

You can configure secure pop3/imap with any of the following examples:

pop3s://myemailserver.com:12345
imaps://myemailserver.com:56789
If you use one of these methods, you must also configure your JVM with the keystore and truststore credentials (see Viewing and setting keystore and truststore runtime properties at integration node level).

You can obtain the hostname and port number from the email server or email server administrator.

Value type: String
Security identity (DSN) securityIdentity This mandatory property specifies the name of the security identity object that contains the user ID and password that is used to authenticate the connection to the email server.

Value type: String
Connection timeout (seconds) emailConnectionTimeout The socket connection timeout value, in seconds, of the EmailInput node. The default is an infinite timeout.
Read timeout (seconds) emailReadTimeout The socket connection read timeout value, in seconds, of the EmailInput node. The default is an infinite timeout.
Connection idle timeout (seconds) emailConnectionIdleTimeout The idle connection timeout, in seconds, of the EmailInput node. An idle connection is a connection that has received no emails. The default is an infinite timeout. The connection is closed if the idle timeout value is exceeded; a new connection can then be established.
Enable the use of the STARTTLS command starttlsEnable This property 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. If the server does not support STARTTLS, the connection continues without the use of TLS. The default value is false.

Value type: Boolean
Requires the use of the STARTTLS command starttlsRequired This property specifies that use of the STARTTLS command is required. If the server does not support the STARTTLS command, or if the command fails, the connect method fails. The default value is false.

Value type: Boolean