ts-mailcow-api
    Preparing search index...

    Interface SyncjobAttributes

    All the attributes of a sync job.

    interface SyncjobAttributes {
        active: boolean;
        automap: boolean;
        custom_params: string;
        delete1: boolean;
        delete2: boolean;
        delete2duplicates: boolean;
        enc1: "TLS" | "SSL" | "PLAIN";
        exclude: string;
        host1: string;
        maxage: number;
        maxbytespersecond: number;
        mins_interval: number;
        password1: string;
        port1: number;
        skipcrossduplicates: boolean;
        subfolder2: string;
        subscribeall: boolean;
        timeout1: number;
        timeout2: number;
        user1: string;
        username: string;
    }
    Index

    Properties

    active: boolean

    Enables or disables the sync job.

    automap: boolean

    Try to automap folders ("sent items", "sent" => "sent" etc.) (--automap).

    custom_params: string

    Custom parameters.

    delete1: boolean

    Delete from source when completed (--delete1).

    delete2: boolean

    Delete messages on destination that are not on source (--delete2).

    delete2duplicates: boolean

    Delete duplicates on destination (--delete2duplicates).

    enc1: "TLS" | "SSL" | "PLAIN"

    The encryption method used to connect to the mailserver.

    exclude: string

    Exclude objects (regex).

    host1: string

    The smtp server where mails should be synced from.

    maxage: number

    Only sync messages up to this age in days.

    maxbytespersecond: number

    Max speed transfer limit for the sync.

    mins_interval: number

    The interval in which messages should be synced.

    password1: string

    The password of the mailbox.

    port1: number

    The smtp port of the target mail server.

    skipcrossduplicates: boolean

    Skip duplicate messages across folders (first come, first serve) (--skipcrossduplicates).

    subfolder2: string

    Sync into subfolder on destination (empty = do not use subfolder).

    subscribeall: boolean

    Subscribe all folders (--subscribeall).

    timeout1: number

    Timeout for connection to remote host.

    timeout2: number

    Timeout for connection to local host.

    user1: string

    The target email account.

    username: string

    Your local mailcow mailbox.