E-Mail Trigger Properties
The E-Mail Trigger Properties window contains the settings for an E-Mail Trigger.
Property Pages
Property pages common to all Triggers
General
Name for this trigger (optional)
Optionally, specify a descriptive name for the trigger.
Enabled
Uncheck this box to disable the trigger. If the trigger is not enabled, adTempus will ignore it (it will not cause the job to trigger).
Minimum Interval
Specify the minimum interval (in seconds) for this trigger. Once the triggers conditions are satisfied and the job is triggered, adTempus will ignore this trigger for the specified interval.
For example, suppose you are using a File Trigger to trigger the job whenever a new file is added to a folder. If you set the interval to 60 seconds, then once adTempus triggers the job, it will ignore any new files that arrive in the next 60 seconds.
Description/Notes
Enter any extended descriptive information or notes for this trigger.
Job Variables
The Job Variables page allows you to define Job Variables that will be set for this job only when it is started by this trigger.
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.
Check for new messages every
Specify the interval (in minutes) at which adTempus should connect to the mail server to check for new messages.
Selection Criteria
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.
Trigger separately for each message
If this option is checked adTempus will start a new instance of the job for each message that matches the selection criteria.
If this option is not checked, adTempus will start a single instance of the job even if it found more than on message that matches the selection criteria.
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:
- RFC 822. The message is saved in standard RFC 822 format with file name message.eml. Any attachments are included in the file as embedded MIME sections.
- RFC 822 with attachments. The message is saved in standard RFC 822 format with file name message.eml, and attachments are also saved in separate files.
- HTML with attachments. The body of the message is saved to an HTML file named message.htm. Attachments are saved in separate files.
- Text with attachments. The body of the message is saved to a text file named message.txt. Attachments are saved in separate files.
- Attachments only. The body of the message is not saved, but all attachments are saved in separate files.
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 trigger creates the following Job Variables, which are available for the remainder of the job:
| Name | Description |
| EmailProcessing.MessageId | The message ID (assigned by the e-mail server) for the selected message. This variable is set only if the Trigger separately for each message option is checked. |
| EmailProcessing.MessageSubject | The subject of the selected e-mail message. This variable is set only if the Trigger separately for each message option is checked. |
| 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 trigger (the number of messages that meet the selection criteria). |