ts-mailcow-api
    Preparing search index...

    Interface BaseMailboxAttributes

    Base attributes of a mailbox.

    interface BaseMailboxAttributes {
        active: number;
        authsource: "mailcow" | "ldap" | "keycloak" | "generic-oidc";
        force_pw_update: boolean;
        force_tfa?: boolean;
        name: string;
        password: string;
        password2: string;
        quota: number;
    }

    Hierarchy (View Summary)

    Index
    active authsource force_pw_update force_tfa? name password password2 quota
    active: number

    Integer representing if the mailbox is active (allows for custom states).

    authsource: "mailcow" | "ldap" | "keycloak" | "generic-oidc"

    The authentication source for this mailbox.

    force_pw_update: boolean

    Boolean if the user is forced to update their password on login.

    force_tfa?: boolean

    Boolean if the user is forced to enroll in two-factor authentication on login. Optional -- Mailcow falls back to its configured default (false out of the box) when omitted.

    name: string

    The ull name of the mailbox user.

    password: string

    The mailbox password.

    password2: string

    The mailbox password for confirmation.

    quota: number

    The mailbox quota.

    Settings
    Member Visibility

    On This Page
    Properties