ex_scan_graph

Polls the specified mail server for incoming email with image attachments

Parameters

None.

Returns

Returns False, if the operation fails, and the action also pauses before returning based on the configured abort time configured by ex_abort_time. Otherwise, True. If no selected emails were available, the action returns True and also pauses before returning based on the wait time configured using ex_wait_time.

Level

Batch level Open event only.

Details

Scans emails in the inbox for specified attachments, imports selected emails with attachments into the batch. Call once for each batch.

A connection to the email server must have previously been established using the ex_login_O365_OAuth_Graph action.

Each input email (document) contains the following variables set in the document hierarchy:

TYPE: Always set to "Document".

MessageID: The email message ID.

Subject: The email subject.

Body: The text within the email.

DateSent: The sent date stamp on the email.

From: The email sender.

To: The email recipients.

Priority: The state of the email importance flag.

DateReceived: The received date stamp on the email.

Each email attachment (page) has the following variables set:

TYPE: Always set to "Other".

IMAGEFILE: The name of the attachment as saved on disk.

ATTACHNAME: The name of the attachment.

The following batch level variable is created:

EmailCount: The number of emails scanned into the batch.

Note: If the configured Done or Problem folders do not exist, the email is moved to the Deleted Items folder.

Waiting emails are processed in blocks. The amount of emails processed in a block will be the number of waiting emails, or the number of emails remaining from the value set in ex_max_docs, up to a maximum of 50.

After a block of emails are processed, the wait time is checked. If the wait time has not been reached and the maximum number of emails has not been reached, then another block of emails are processed.

If the wait time has been reached, then no more emails are input to the batch.

It is recommended that the subject line be no longer than 78 characters as this is a common subject line length limitation. Some systems may support even shorter lengths, truncating the subject. Our testing has been successful with lengths up to 255 characters.

It is recommended to test your settings and use lengths appropriate for your systems.

Use ex_max_docs to configure the number of emails processed per batch. The number of items included in the batch can be different than this amount, see ex_max_docs for more details.

Important: If any concurrently running threads might be using the same account, your EWSMail-related tasks cannot be run in a multi-threaded configuration. Instead, use single-threaded tasks only.

Example

ex_wait_time("20")
ex_abort_time("40")
ex_max_docs("50")
ex_types("jpg, tif")
ex_scan_graph()