im_wait_time

Member of namespace

Imail

Syntax

bool im_wait_time(int nSecs)

Parameters

nSecs

Type: int

Parameters

nSecs: The maximum number of seconds to wait.

Returns

Always True.

Level

Batch level.

Details

The maximum time to wait for input emails for a single batch, when there is at least one pending email. Used by the im_scan action after the first email is processed to determine how long to wait for the batch to fill up. If no emails are pending, the im_scan action does not wait regardless of the wait time value.

The import of emails into the batch stops when the wait limit is reached or when the maximum email per batch is reached. While it is waiting for new mail to arrive, the configured mailbox is polled every 2 seconds to check for waiting mail. The action continues to include new files 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 is used.

Example:

im_wait_time("20")
im_abort_time("60")
im_max_docs("200")
im_types("jpg,tif")