ex_wait_time

Member of namespace

Ewsmail

Syntax

bool ex_wait_time (int nSecs)

Parameters

nSecs

Type: int

Parameters

nSecs : The maximum number of seconds to wait.

Returns

Always True.

Level

Batch level Open event only.

Details:

The maximum time to wait for input files for a single batch. Used by the ex_scan action after the first email has been processed to determine how long to wait for the batch to fill up.

The import of emails into the batch will stop when the wait limit is reached or when the maximum emails per batch has been reached. While waiting for new mail to arrive, the mailbox will be polled every two seconds to check for waiting mail. The action will continue to include new emails into the batch until this wait time is reached or the maximum number of emails per batch is reached.

If this action is not called, the default wait time of 5 seconds will be used.

Example:

ex_wait_time("20")
ex_scan()      

This example causes the scan operation to wait for 20 seconds for additional email, after processing the first email, before finishing the scan operation.