ts-mailcow-api
    Preparing search index...

    Class MailcowClient

    Class containing all the logic to interface with the Mailcow API in TypeScript.

    Index

    Constructors

    constructor

    Properties

    addressRewriting aliases appPasswords dkim domainAdmins domains fail2Ban forwardingHosts logs mailbox oauth2 quarantine queueManager ratelimits resources routing spamPolicy status syncjobs tlsPolicyMaps

    Constructors

    • Creates a MailcowClient using the given URL and API key.

      Parameters

      • BASE_URL: string

        The base URL of the Mailcow API.

      • API_KEY: string

        The API key of the Mailcow API.

      • OptionalEXTRA_AXIOS_CONFIG: AxiosRequestConfig

        Allows for setting extra Axios request config such as keep alive.

      Returns MailcowClient

    Properties

    addressRewriting: AdressRewritingEndpoints = ...

    All endpoints related to address rewriting. See AdressRewritingEndpoints

    aliases: AliasEndpoints = ...

    All endpoints related to Aliases. See AliasEndpoints

    appPasswords: AppPasswordEndpoints = ...

    All endpoints related to app passwords. See AppPasswordEndpoints

    dkim: DkimEndpoints = ...

    All endpoints related to DKIM. See DkimEndpoints

    domainAdmins: DomainAdminEndpoints = ...

    All endpoints related to Domain Admins. See DomainAdminEndpoints

    domains: DomainEndpoints = ...

    All endpoints related to Domains. See DomainEndpoints

    fail2Ban: Fail2BanEndpoints = ...

    All endpoints related to fail2ban. See Fail2BanEndpoints

    forwardingHosts: ForwardingEndpoints = ...

    All endpoints related to forwarding hosts. See ForwardingEndpoints

    logs: LogEndpoints = ...

    All endpoints related to logs. See LogEndpoints

    mailbox: MailboxEndpoints = ...

    All endpoints related to mailboxes. See MailboxEndpoints

    oauth2: OAuth2Endpoints = ...

    All endpoints related to OAuth2 clients. See OAuth2Endpoints

    quarantine: QuarantineEndpoints = ...

    All endpoints related to quarantine. See QuarantineEndpoints

    queueManager: QueueManagerEndpoints = ...

    All endpoints related to the mail queue. See QueueManagerEndpoints

    ratelimits: RatelimitsEndpoints = ...

    All endpoints related to rate limits. See RatelimitsEndpoints

    resources: ResourceEndpoints = ...

    All endpoints related to resources. See ResourceEndpoints

    routing: RoutingEndpoints = ...

    All endpoints related to Routing. See RoutingEndpoints

    spamPolicy: AntiSpamEndpoints = ...

    All endpoints related to spam policies. See AntiSpamEndpoints

    status: StatusEndpoints = ...

    All endpoints related to status. See StatusEndpoints

    syncjobs: SyncjobEndpoints = ...

    All endpoints related to sync jobs. See SyncjobEndpoints

    tlsPolicyMaps: TlsPolicyMapEndpoints = ...

    All endpoints related to TLS Policy Maps. See TlsPolicyMapEndpoints

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties