Interface ExtractOptions

Options for extracting PIN from email message.

interface ExtractOptions {
    checkTo?: boolean;
    regex?: RegExp;
    useHtml?: boolean;
    useSubject?: boolean;
    useText?: boolean;
}

Properties

checkTo? regex? useHtml? useSubject? useText?

Properties

OptionalcheckTo

checkTo?: boolean

Whether to check To header contains requesting email address.

Default Value

true

Optionalregex

regex?: RegExp

Regular Expression to extract PIN into capture group 1.

Default Value

Accepting any 6-digit token.

OptionaluseHtml

useHtml?: boolean

Whether to extract PIN from email HTML.

Default Value

false

OptionaluseSubject

useSubject?: boolean

Whether to extract PIN from email subject.

Default Value

true

OptionaluseText

useText?: boolean

Whether to extract PIN from email text.

Default Value

true

Settings

Member Visibility

On This Page

Properties