Receive Mail is a process starter activity that polls a POP3 mail server for the new mail. After detecting and retrieving a new mail, the Receive Mail activity starts the process.
The General tab has the following fields.
|Field||Literal Value/Module Property/Process Property||Description|
|Name||None||The name to be displayed as the label for the activity in the process.|
|Host||Yes||The host name or IP address for the mail server.|
|Port||Yes||The default port (110) used to connect to POP3 server.|
|User Name||Yes||The username for logging into the POP3 server.|
|Password||Yes||The password for logging into the POP3 server.|
|Polling Interval (sec)||Yes||The polling interval (in seconds) to check for new mail. The default is 5, if no polling interval is specified.|
|Delete Mail||None|| Select this check box to delete the mail from the POP3 server after process starter has retrieved it.
You can leave this field clear.
|Enable Confidentiality||None||This check box specifies whether a Secure Sockets Layer (SSL) Client should be used to specify the SSL configuration. When this check box is selected, the SSL Client field displays.|
|SSL Client||Yes||The name of the resource. In the SslClientResource Resource Template wizard, create a resource to connect to the SSL client.|
Test Connection Button
The Test Connection button tests the connection to the specified mail server. Use this button to ensure that your Receive Mail activity is properly configured to receive mail from the specified mail server. This button is enabled only when the Host, User Name, and Password fields on the General tab are populated.
The Advanced tab contains the following fields:
|Sequencing Key||Contains an XPath expression that specifies which process runs in a sequence. Process instances with sequencing keys evaluating to the same value, are executed in the sequence the process instance was created.|
|Custom Job id||This field can contain an XPath expression that specifies a custom ID for the process instance.|
|Provide Raw Message|| When selected, this field specifies the whole message to be provided in the binary form. The output schema changes to include an element named rawMessage that contains the message instead of bodyText and mimeEnvelopeElements.
The Receive Mail process starter uses the javax.mail API. This API assumes that the content type of the message is multipart/mixed. When the multipart subtype is not mixed (such as multipart/signed or multipart/alternative) or when another content type is used (for example, application/*), the javax.mail API may not correctly parse the message.
Select this check box to send the raw message to a Java Invoke activity that uses the Java activation framework to implement the appropriate handlers to process the message. For more information on how the Java activation framework can be used for this purpose, refer to the API documentation for javax.activation and javax.mail.
You can also feed the binary message to the javax.mail.MimeMessage constructor in the form of a java.io.InputStream to construct a MimeMessage object. The default javax.mail API handler is used in such a case.
Incoming messages may contain custom headers. From the Output Editor tab, define a custom schema for the headers of the incoming mail messages. You can also specify any standard header supported by the javax.mail package. For example, X-Mailer or X-Priority. Values of headers in the incoming message populates the corresponding defined output headers of the same name.
The following is the output of the activity.
|from||string||The email address of the sender of the email.|
|to||string||The recipient list of the email.|
|cc||string||The cc (carbon copy) list of the email.|
|replyTo||string||The reply to list of the email.|
|subject||string||The subject of the email.|
|sentdate||string||The date the email was sent.|
|Headers||complex||This element contains the schema you defined on the Output Editor tab. You can specify custom headers that can be included in the incoming mail messages.|
|bodyElement||string||Contains a choice element.
You can provide the bodyText element.
|mimeEnvelopeElement||complex||This field is available when the
Provide Raw Message check box on the
Advanced tab is not selected.
Contains the message attachments. This element contains a repeating element named mimePart that comprises each mime attachment.
|mimeHeaders||complex||This element contains the mime header for each mimePart.
mimeHeaders contain the following information:
See http://www.faqs.org/rfcs/rfc2045.html for more information about MIME headers and their syntax.
|binaryContent | textContent||choice||This element contains the mime attachment. It can be any of the following:|