ts-mailcow-api
    Preparing search index...

    Interface TimeLimitedAliasPostRequest

    Request payload to create a time-limited (burner) alias. Mailcow always generates the address itself; there is no way to request a specific one.

    interface TimeLimitedAliasPostRequest {
        description?: string;
        domain: string;
        permanent?: boolean;
        username?: string;
        validity?: number;
    }
    Index
    description? domain permanent? username? validity?
    description?: string

    Optional free-text description.

    domain: string

    The domain to generate the alias under. Must be the mailbox's own domain or one of its alias domains.

    permanent?: boolean

    If true, the alias never expires and validity is ignored.

    username?: string

    The mailbox the alias should forward to. Defaults to the API-authenticated mailbox when omitted.

    validity?: number

    How many hours the alias stays valid, from 1 to 87600 (10 years). Defaults to 8760 (1 year). Ignored when permanent is true.

    Settings
    Member Visibility

    On This Page
    Properties