ts-mailcow-api
    Preparing search index...

    Interface DomainFooterEditRequest

    Domain wide footer edit payload.

    Note: the upstream OpenAPI spec documents the exclude list as mbox_exclude, but the PHP handler (functions.mailbox.inc.php, case domain_wide_footer) actually reads a single exclude field -- a mix of mailbox addresses and/or alias-domain names -- and sorts each entry into the internal mbox_exclude/alias_domain_exclude buckets itself.

    interface DomainFooterEditRequest {
        attr: {
            exclude?: string[];
            html: string;
            plain: string;
            skip_replies?: boolean;
        };
        items: string
        | string[];
    }
    Index
    attr items
    attr: {
        exclude?: string[];
        html: string;
        plain: string;
        skip_replies?: boolean;
    }

    The footer attributes to set.

    Type Declaration

    • Optionalexclude?: string[]

      Mailbox addresses and/or alias-domain names to exclude from the footer.

    • html: string

      Footer text in HTML format.

    • plain: string

      Footer text in plain text format.

    • Optionalskip_replies?: boolean

      If true: do not append the footer when replying to a message that already carries it.

    items: string | string[]

    Domains to apply the footer to.

    Settings
    Member Visibility

    On This Page
    Properties