ts-mailcow-api
    Preparing search index...

    Interface Alias

    Interface of the Alias as returned by Mailcow.

    interface Alias {
        active: boolean;
        active_int: number;
        address: string;
        created: string;
        domain: string;
        goto: string;
        goto_ham?: boolean;
        goto_null?: boolean;
        goto_spam?: boolean;
        id: number;
        in_primary_domain: string;
        is_catch_all: boolean;
        modified: string;
        private_comment: string;
        public_comment: string;
        sogo_visible: boolean;
        sogo_visible_int: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    active active_int address created domain goto goto_ham? goto_null? goto_spam? id in_primary_domain is_catch_all modified private_comment public_comment sogo_visible sogo_visible_int

    Properties

    active: boolean

    If alias is active or not.

    active_int: number

    Int representation of the boolean.

    address: string

    The alias address, for catchall use "@domain.tld".

    created: string

    Creation date of the alias.

    domain: string

    The domain of the alias.

    goto: string

    The destination address, comma separated.

    goto_ham?: boolean

    If true: learn as ham.

    goto_null?: boolean

    If true: silently ignore.

    goto_spam?: boolean

    If true: learn as spam.

    id: number

    The ID of the alias.

    in_primary_domain: string
    is_catch_all: boolean

    Boolean if the Alias is a catch-all.

    modified: string

    Last modified date of the alias.

    private_comment: string

    The private comment of the alias.

    public_comment: string

    The public comment of the alias.

    sogo_visible: boolean

    If alias is visible in sogo.

    sogo_visible_int: number

    Int representation of the boolean.

    Settings

    Member Visibility

    On This Page

    Properties