User Guide

10.5.0
- 10.5.3
- 10.4.0
- 10.2.3
- 10.2.2 HotFix 1
- 10.2.2
- 10.2.1
- 10.2

Back Next

Retrieve Email Task

The Retrieve Email task can access a standard POP-3 or IMAP Mail Box and retrieve emails stored on it.

Field	Definition
Basic Tab
Label	Specify a label for this task.
Mail Box	Select a pre-configured Mail Box from the drop-down list.
Mail Folder	Specify the name of the mail folder to open on the mail box server. Default Value: INBOX
Destination Directory	Specify the directory on the local system where the attachments and message body files should be saved to.
Save Attachments	Specify whether or not attachments of the email message should be downloaded. Default Value: true
Save Message Body	Specify whether or not the body of the email message should be saved to a file. Default Value: false
When File Exists	Specify the action to take when an attachment being downloaded already exists. The default value is 'rename' which changes the destination file name to a new name so the existing file remains untouched. Default Value: rename
Advanced Tab
Delete Messages	Specify whether or not to delete processed email messages from the mail box server. Default Value: false
Private Key Alias	Specify the private key alias to use when decrypting emails.
Output Variables Tab
Email List Variable	If desired, specify the name of a variable which will contain an EmailList variable. It will be created if it does not exist, or overwritten otherwise.
Downloaded Attachments Variable	If desired, specify the name of a variable which will contain the downloaded attachments. The variable will be of type File List. It will be created if it does not exist, or overwritten otherwise.
Downloaded Message Body Files Variable	If desired, specify the name of a variable which will contain the downloaded message body files. The variable will be of type File List. It will be created if it does not exist, or overwritten otherwise.
Number of Messages Retrieved Variable	If desired, specify the name of a variable which will contain the number of messages retrieved. The variable may be used in subsequent tasks. The variable will be created if it does not exist.
Mailbox Server
Refer to the Mail Box Resource page for the Mail Box Server field definitions.
Control Tab
Version	The version of this task.
Log Level	Specify the level of logging to use while executing this task. Valid options are - silent, normal, verbose and debug. Default Value: Inherited from parent Module
Execute Only If	Specify a condition that must be satisfied before this task can be executed. This task will be skipped if the specified condition is not met.
Disabled	Whether or not this task is disabled. Default Value: false
On Error Tab
On Error	Specify the action to take when this task errors out. Valid options are - abort, continue, call:[module] and setVariable:[name]=[value]. For call:[module] replace [module] with the name of the module in the project (e.g. call:ErrorModule). For setVariable:[name]=[value] replace [name] with a variable name and [value] with the variable value (e.g. setVariable:error=true). Default Value: Inherited from parent Module

Rename Saved Search

Table of Contents

User Guide

User Guide

Retrieve Email Task

Retrieve Email Task