EmailInput node
Use the EmailInput node to retrieve an email, with or without attachments, from an email server that supports Post Office Protocol 3 (POP3) or Internet Message Access Protocol (IMAP).
This topic contains the following sections:
Purpose
Element Location | Element Data Type | Description |
---|---|---|
Root.EmailInputHeader.To | CHARACTER | A comma-separated list of email addresses. |
Root.EmailInputHeader.Cc | CHARACTER | A comma-separated list of email addresses. |
Root.EmailInputHeader.From | CHARACTER | A comma-separated list of email addresses. |
Root.EmailInputHeader.ReplyTo | CHARACTER | A comma-separated list of email addresses. |
Root.EmailInputHeader.Subject | CHARACTER | The summary of the email content or the subject of the email. |
Root.EmailInputHeader.Size | INTEGER | The size of the email, including any attachments. |
Root.EmailInputHeader.SentDate | CHARACTER | The sent delivery date of the email. |
Configuring the EmailInput node
All mandatory properties for which you must enter a value (those that do not have a default value defined) are marked with an asterisk.
To configure the EmailInput node by using the node properties in the IBM App Connect Enterprise Toolkit to retrieve an email, with or without attachments, see Receiving an email.
Terminals and properties
The EmailInput node terminals are described in the following table.
Terminal | Description |
---|---|
Failure | The output terminal to which the message is routed if an EmailInput node failure is detected when a message is propagated, or an EmailInput node fails to access the email server. Connect the Failure terminal of this node to another node in the message flow to process errors. |
Out | The output terminal to which the message is routed if it has been propagated successfully. Connect the Out terminal of this node to another node in the message flow to process the message further, or send the message to an additional destination. |
Catch | The output terminal to which the message is routed if an exception is thrown downstream and caught by this node. Exceptions are caught only if this terminal is attached. |
The following tables describe the EmailInput node properties.
The table column headed M indicates whether the property is mandatory. For example, the property is marked with an asterisk meaning that you must enter a value if no default is defined.
The column headed C indicates whether the property is configurable. For example, you can change the value when you add the message flow to the BAR file to deploy it.
The EmailInput node Description properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Node name | No | No | Email Input | The name of the node. |
Short description | No | No | None | A brief description of the node. |
Long description | No | No | None | Text that describes the purpose of the node in the message flow. |
The EmailInput node Basic properties are described in the following table.
Property | M | C | Default | Description | mqsiapplybaroverride command property |
---|---|---|---|---|---|
Email server | Yes | Yes | None | The Email server property is defined either as a policy name, for example:
{myPolicyProject}:myEmailPolicy, or as a URL. A URL allows you to specify a
protocol, host name, and port number, which is the minimum information you need to access the email
server. Specify a policy by using the format
The URL must be made up of the following structure: protocol://hostname:port Where:
You can configure secure pop3/imap with the following example: pop3s://myemailserver.com:12345 or imaps://myemailserver.com:56789. Then you must configure your JVM with the keystore/truststore credentials. There is no default value for this property, however this property is mandatory, and therefore must be configured with a policy name or a URL. You can obtain the hostname and port values from the email server or email server administrator. |
emailServer |
Property | M | C | Default | Description | mqsiapplybaroverride command property |
---|---|---|---|---|---|
Polling interval (in seconds) | Yes | Yes | 5 | The interval at which the EmailInput node polls the email server for new emails. | waitInterval |
Property | M | C | Default | Description | mqsiapplybaroverride command property |
---|---|---|---|---|---|
Security identity | No | Yes | None | The name of the security identity object that is created and
configured by the mqsicredentials command, which contains the
user ID and password to be used to authenticate with the email server. Use the mqsicredentials command to set the security identity user ID and
password to be accessed by the integration server. Alternatively, you can use
the mqsisetdbparms command. The default value for this property is None, which signifies that the user ID and password are not passed to the email server. For more information about email server security identity support, see mqsicredentials command or mqsisetdbparms command. |
securityIdentity |
Property | M | C | Default | Description | mqsiapplybaroverride command property |
---|---|---|---|---|---|
Retry mechanism | Yes | No | Short and Long Retry | How the EmailInput node handles a message flow failure. Valid values are Failure, Short Retry, or Short and Long Retry. | |
Retry threshold | Yes | Yes | 0 | The number of times to try the message flow transaction again when the Retry mechanism property value is set to Short Retry. | retryThreshold |
Short retry interval (in seconds) | No | Yes | 0 | The interval, in seconds, between each retry if the Retry threshold property value is not set to zero. | shortRetryInterval |
Long retry interval (in seconds) | No | Yes | 300 | The interval, in seconds, between each retry, if the Retry mechanism property value is Short and Long Retry and the retry threshold has been exhausted. | longRetryInterval |
Action on failing email | Yes | No | Delete Email | The action that the EmailInput node takes with the input data source after all attempts to process the contents fail. | emailFailureAction |
Property | M | C | Default | Description | mqsiapplybaroverride command property |
---|---|---|---|---|---|
Transaction mode | No | Yes | No | The transaction mode on the EmailInput node determines if the rest of the nodes in the message flow are run under sync point. Valid values are Yes or No. |
Property | M | C | Default | Description | mqsiapplybaroverride command property |
---|---|---|---|---|---|
Additional instances pool | No | Yes | Use Pool Associated with Message Flow | The pool from which additional instances are
obtained. If you select the property value Use Pool Associated with Message Flow, additional instances are obtained from the message flow pool. If you select the property value Use Pool Associated with Node, additional instances are allocated from the additional instances of the node, based on the number specified in the Additional instances property. |
componentLevel |
Additional instances | No | Yes | 0 | The number of additional instances that the EmailInput node can start if the Additional instances pool property is set to the value Use Pool Associated with Node. | additionalInstances |
Property | M | C | Default | Description |
---|---|---|---|---|
Events | No | No | None | Events that you have defined for the node are displayed on this tab. By
default, no monitoring events are defined on any node in a message flow. Use
Add, Edit, and Delete to
create, change or delete monitoring events for the node. You can enable and disable events that are shown here by selecting or clearing the Enabled check box. |