You use this action to read e-mail from a specified mail server.
On the configuration screen, you need to specify the mail server, a valid e-mail account and password, and an attachment folder to store incoming attachments. For the mail server, you can define a number of predefined global variables and account values and link them to the action.
The properties in the Link Editorfor this action are listed in the following table:
Property |
Data Type |
Access |
Description |
ConnPropAlias |
String |
In and out |
The e-mail server connection alias name |
CredPropAlias |
String |
In and out |
The credentials to use to authenticate the call to the e-mail server |
MailProtocol |
String |
In and out |
The protocol to use when communicating with the e-mail server. For example, pop3. |
MailServer |
String |
In and out |
Identifies the incoming mail server. For example, pop3.yourCompany.com. |
MailAccount |
String |
In and out |
Controls the account from which the e-mail is read. It should correspond to a valid user account on the mail server. |
MailAccountPassword |
String |
In and out |
This property is optional. It provides credentials for access to the specified mail account on the server. |
AttachmentFolder |
String |
In and out |
Specifies the file path to the folder that contains attachments. |
Connection Timeout |
Integer |
In and out |
The amount of time the action waits to establish a connection to the e-mail server |
ReadTimeout |
Integer |
In and out |
The amount of time the action waits, after the connection is established, to receive e-mail messages |
Port |
Integer |
In and out |
The e-mail server connection TCP/IP port for communication |
ReadOnly |
Boolean |
In and out |
When this indicator is true, the read e-mail messages are kept on the server. When it is false, the system removes the read messages from the inbox. |
Messages |
XML |
Out |
Provides access to the output XML from the action including the date of the e-mail, sender, subject, body, and attachment file names. |
Success |
Boolean |
Out |
Indicates whether the request succeeded or failed. If it failed, errors are displayed in the server trace log. |