Configuration
The Configuration tab has the following fields.
Field |
Global Var? |
Description |
Name |
No |
The name to appear as the label for the activity in the process definition. |
Description |
No |
Short description of the activity. |
Host |
Yes |
Host name or IP address for the mail server. The default port (110) is used to connect to POP3 the server. If your server is configured to use a different port, you can specify it in this field using the syntax: < For example, |
Protocol |
No |
Protocol used by mail server. The drop-down list has two options: POP3 and IMAP. |
Authentication |
No |
This drop-down list is displayed only when you select the IMAP option in the Protocol drop-down list. It has two options: Basic Authentication and OAuth 2.0. If you select Basic Authentication, then the User Name and Password fields appear. If you select OAuth 2.0, then the User Name and Access Token Value fields appear. Note: You can obtain the field information for Access Token Value, User Name, and Password from a Service Provider.
|
User Name |
Yes |
User name to use when logging into the POP3 server. |
Password |
Yes |
Password to use when logging into the POP3 server. |
Client ID | Yes | The Client ID issued to the client during the client registration process. |
Client Secret | Yes | The Client Secret issued to the client during the client registration process. |
Access Token URL |
No |
The endpoint for the authentication server. This is used to exchange the authorization code for the access token. |
Scope | No | The scope of the access request. |
Grant Type | Yes |
Client Credentials. Currently Client Credentials as a grant type is supported. |
Polling Interval (sec) |
Yes |
Polling interval (in seconds) to check for new mail. The default, if no polling interval is specified, is 5 seconds. |
Delete Mail |
Yes |
If checked, mail gets deleted from the POP3 server once the process starter has retrieved it. Note: If you choose to delete mail, you should place a Checkpoint activity immediately after the Receive Mail process starter to ensure the message is not lost in the event of machine failure.
Alternatively, you can choose to leave this field unchecked, and then later in the process definition perform a checkpoint then use the Confirm activity to confirm the message. The Confirm activity deletes the message from the mail server. |
SSL |
Yes |
The Use SSL check box specifies that a Secure Sockets Layer (SSL) should be used to specify client SSL configuration. When this field is checked, the Configure SSL button is enabled. |
Upgrade Configuration |
No |
This field only appears in Mail palette resources placed into process definitions prior to release 5.2.0. In previous releases, attachments were lists in the input of the activity. In release 5.2.0 or later, a new schema is used to handle MIME attachments. If you have a Mail palette resource created prior to release 5.2.0, this field should be unchecked to maintain backward compatibility. This field does not appear for new resources created in release 5.2.0 or later. Unchecking this field disables the Advanced and Output Headers tab and changes the output schema. |