WaitForEmailOptions | WebHare Platform SDK
WebHare Platform SDK
    Preparing search index...

    Interface WaitForEmailOptions

    interface WaitForEmailOptions {
        count?: number;
        peekonly?: boolean;
        returnallmail?: boolean;
        scanaheaduntil?: string | Date;
        timeout?: number;
    }
    Index

    Properties

    count?: number

    options.count Number of mails expected within the timeout. Defaults to 1

    peekonly?: boolean

    If true, don't remove emails from queue

    returnallmail?: boolean

    options.returnallmail Return all mail, not up to 'count'.

    scanaheaduntil?: string | Date

    options.scanaheaduntil If set, also look at future tasks until this date

    timeout?: number

    options.timeout Timeout in milliseconds, max 60000