E-Mail Processing Task Properties

The E-Mail Processing Task Properties window contains the settings for a job step that executes an E-Mail Processing Task.

Property Pages

In addition to the standard response events, this task defines the following events:

Event Description
No messages selected Occurs if no messages matched the selection criteria.
One or more messages selected Occurs if at least one message matches the selection crtieria.
Selected message count matches a value Occurs if the number of selected messages meets the specified criterion.

Message Source

Mail connection to use

Select an existing Incoming E-Mail Provider or create a new one. The e-mail provider represents a connection to a POP3 or IMAP mail server using a single login account.

IMAP Folder

For an IMAP connection you may optionally enter the name of the folder to select messages from. Leave blank to select from the default Inbox folder for the account.

Delete selected messages

If this option is checked, adTempus will delete from the mail server each message that is selected and processed by the e-mail processing operation. Messages that do not meet the selection criteria are not deleted.

If this option is not checked, adTempus will leave the messages on the server. However, adTempus remembers which messages it has already seen and will not reprocess the messages again in the future unless you clear the message list as described in the next section.

Some mail servers (such as Gmail) may not delete messages even if adTempus tells them to.

Clear list of previously-processed messages

Click this button to clear the list of messages that adTempus has already examined in this mailbox. This will cause adTempus to examine all messages in the mailbox the next time it connects to the server. Use this option if, for example, you have changed the message filtering rules and want adTempus to re-examine messages to select messages that were not processed in the past because they did not meet the selection rules.

Message Selection

This page allows you to define criteria controlling which messages adTempus will select for processing. If no criteria are defined, adTempus will select all new messages in the mailbox.

adTempus remembers which messages it has already seen, and will never re-read messages it has already seen, unless you clear its list using the Clear list of previously-processed messages button.

Selection Rules

If no rules are defined, adTempus will select all messages in the mailbox. To filter messages based on criteria based on their subject, content, sender, attachments, etc., add one or more selection filters.

If you add more than one rule, specify whether adTempus should select messages that match Any rule or only messages that match All rules.

Selection Script

For more advanced filtering, you can use a .NET script to filter the message. For each message that meets the basic selection criteria (if any), adTempus will run your script. Your script has access to the Parameters.Message object, which exposes the message and its attachments through a MailMessage object.

Your script must return True if adTempus should select the message or False if it should not.

Message Saving

The options on the Message Saving page allow you to save selected messages and/or their attachments to disk.

Save format

Select the format to save the message in:

Save messages to folder

Specify the base folder where messages should be saved. adTempus will create a uniquely-named folder under this folder for each message. The folder will contain a file for the message body (named as specified above based on the Save format) and/or the attachments for the message.

adTempus will store a list of the folders that it creates in the EMailProcessing.MessageLocation Job Variable.

For example, you set the save location to c:\messagedownload. adTempus processes 2 messages and saves them in format HTML with attachments. The variable will be set to:

c:\messagedownload\{C7C9286D-607F-4192-9960-EDED8624A4BE};c:\messagedownload\{837FC8D4-314D-41E3-B95E-412CB84694E5}

The messages can be found in files c:\messagedownload\{C7C9286D-607F-4192-9960-EDED8624A4BE}\message.htm and c:\messagedownload\{837FC8D4-314D-41E3-B95E-412CB84694E5}.htm.

The attachments for each message can be found in the corresponding folders.

Job Variables

This task creates the following Job Variables, which are available for the remainder of the job:

Name Description
EmailProcessing.MessageLocation A semicolon-delimited list of the files or directories created if messages or attachments were saved. See the Message Saving section for more information.
EmailProcessing.SelectedMessageCount The number of messages selected by the task (the number of messages that meet the selection criteria).

Related Concepts

E-Mail Processing Task