ts-mailcow-api
    Preparing search index...

    Interface DomainPostRequest

    Domain creation payload.

    interface DomainPostRequest {
        active: boolean;
        aliases: number;
        backupmx: number;
        defquota: number;
        description: string;
        domain: string;
        lang:
            | "it"
            | "sk"
            | "cs"
            | "de"
            | "en"
            | "es"
            | "fr"
            | "lv"
            | "nl"
            | "pl"
            | "pt"
            | "ru"
            | "ca";
        mailboxes: number;
        maxquota: number;
        quota: number;
        relay_all_recipients: boolean;
        restart_sogo: boolean;
        rl_frame: RelayFrame;
        rl_value: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    active aliases backupmx defquota description domain lang mailboxes maxquota quota relay_all_recipients restart_sogo rl_frame rl_value

    Properties

    active: boolean

    Boolean if the domain is active.

    aliases: number

    Amount of aliases in the domain.

    backupmx: number

    Boolean to relay domain or not.

    defquota: number

    The predefined mailbox quota in add mailbox form

    description: string

    The description of the domain.

    domain: string

    The domain to create.

    lang:
        | "it"
        | "sk"
        | "cs"
        | "de"
        | "en"
        | "es"
        | "fr"
        | "lv"
        | "nl"
        | "pl"
        | "pt"
        | "ru"
        | "ca"

    The language code associated with this domain.

    mailboxes: number

    The limit count of mailboxes associated with this domain.

    maxquota: number

    The maximum quota per mailbox.

    quota: number

    The maximum quota for this domain (sum of all mailboxes).

    relay_all_recipients: boolean

    If not, then you have to create "dummy" mailbox for each address to relay

    restart_sogo: boolean

    If true: sogo will restart after domain creation.

    rl_frame: RelayFrame

    The frame of the relay setting.

    rl_value: number

    The value of the relay setting.

    Settings

    Member Visibility

    On This Page

    Properties