im_max_docs

Specifies maximum number of emails to include in a single batch.

Member of namespace

Imail

Syntax

bool im_max_docs(int nDocs)

Parameters

nDocs: Type: int

Parameters

nDocs: The maximum number of emails in a batch.

Returns

Always True.

Level

Batch level.

Details

The import of emails into the batch stops when this email limit is reached or when the maximum wait time is reached. While it is waiting for new mail to arrive, the configured mailbox is polled every 2 seconds to check for waiting mail.

If this action is not called, the default value of 100 is used. The actual amount included in the batch might be less than this maximum.

Example:

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

This example causes the scan operation to limit the number of emails in a batch to a maximum of 50.