phasmid - v0.0.1
    Preparing search index...

    Interface ProviderRule

    A rule describing how a specific email provider's addresses should be canonicalized.

    interface ProviderRule {
        canonicalDomain?: string;
        domains: string[];
        id: string;
        lowercaseLocal?: boolean;
        removeDots?: boolean;
        subaddressSeparators?: string[];
    }

    Hierarchy (View Summary)

    Index
    canonicalDomain? domains id lowercaseLocal? removeDots? subaddressSeparators?
    canonicalDomain?: string

    Collapse every matched domain to this single canonical domain. Used for provider aliases that deliver to the same mailbox, e.g. googlemail.com -> gmail.com.

    domains: string[]

    The domains this rule applies to. Matched case-insensitively. The first provider registered for a domain wins, and user-supplied providers override the built-ins.

    id: string

    Stable identifier for the provider, e.g. "gmail".

    lowercaseLocal?: boolean

    Lowercase the local part. Most consumer providers treat the local part case-insensitively, so this is enabled for the built-in providers. The email spec (RFC 5321) technically allows case-sensitive local parts, so it is left disabled for unknown domains by default.

    removeDots?: boolean

    Remove all dots (.) from the local part. This is Gmail's behavior: john.doe@gmail.com and johndoe@gmail.com are the same mailbox.

    subaddressSeparators?: string[]

    Characters that begin a "sub-address" (also called plus-addressing or tagging). Everything from the first occurrence of any separator to the end of the local part is stripped. Gmail/Outlook/etc. use "+"; Yahoo historically uses "-".

    A separator at index 0 is ignored, because stripping it would leave an empty local part.

    Settings
    Member Visibility

    On This Page
    Properties