ts-mailcow-api 0.11.0 → 1.0.0

package/README.md

@@ -4,19 +4,22 @@
 [![Build Status](https://github.com/JustSamuel/ts-mailcow-api/actions/workflows/lint-and-build.yml/badge.svg)](https://github.com/JustSamuel/ts-mailcow-api/actions/workflows/lint-and-build.yml)
 [![License](https://img.shields.io/npm/l/ts-mailcow-api)](https://github.com/JustSamuel/ts-mailcow-api/blob/main/LICENSE)
 [![Downloads](https://img.shields.io/npm/dt/ts-mailcow-api)](https://www.npmjs.com/package/ts-mailcow-api)
+[![GitHub Pages](https://img.shields.io/badge/view-GitHub%20Pages-blue?logo=github)](https://justsamuel.github.io/ts-mailcow-api/classes/MailcowClient.html)
 
 Provides typing and a easy to use interface for the [Mailcow API](https://mailcow.docs.apiary.io/#).
 
 ## Usage
 
-Create a new wrapper using the base url and API_KEY.
+The interface is exposed via the `MailcowClient` class. It's typedoc reference can be found [here](https://justsamuel.github.io/ts-mailcow-api/classes/MailcowClient.html).
+
+To use the client, create a new wrapper using the base url and API_KEY.
 
 ```ts
 import MailCowClient from "./index";
 
 // Create MailCowClient based on BASE_URL and API_KEY
 const mcc = new MailCowClient(
-  "https://demo.mailcow.email/",
+  "https://demo.mailcow.email/api/v1",
   "390448-22B69F-FA37D9-19701B-6F033F",
 );
 ```
@@ -41,151 +44,4 @@ mcc.mailbox
 
 The [Mailcow OpenAPI spec](https://github.com/mailcow/mailcow-dockerized/blob/master/data/web/api/openapi.yaml) doesn’t pass validation and isn’t RESTful (e.g. `POST /api/v1/add/domain`).
 If Mailcow ever fixes the naming or structure, a generated client would break.
-This wrapper acts as a middleman, so those changes can be patched internally without ruining the client interface.
-
-
-## API implementation progress
-
-### Domains
-
-- [x] Create domain
-- [x] Delete domain
-- [x] Update domain
-- [x] Get domain
-
-### Domain antispam policies
-
-- [x] Create domain policy
-- [x] Delete domain policy
-- [x] List blacklist/whitelist domain policy
-
-### Mailboxes
-
-- [x] Create mailbox
-- [x] Delete mailbox
-- [x] Update mailbox
-- [x] Update Pushover settings
-- [x] Quarantine Notifications
-- [x] Update mailbox ACL
-- [x] Get mailboxes
-- [x] Edit mailbox spam filter score
-- [x] Get Active User Sieve
-
-### Aliases
-
-- [x] Create alias
-- [x] Delete alias
-- [x] Update alias
-- [x] Get aliases
-
-### Sync Jobs
-
-- [x] Create sync job
-- [x] Delete sync job
-- [x] Update sync job
-- [x] Get sync jobs
-
-### Forwarding Hosts
-
-- [x] Add Forward Host
-- [x] Delete Forward Host
-- [x] Get Forwarding Hosts
-
-### Logs
-
-- [x] Get ACME logs
-- [x] Get Api logs
-- [x] Get Autodiscover logs
-- [x] Get Dovecot logs
-- [x] Get Netfilter logs
-- [x] Get Postfix logs
-- [x] Get Ratelimit logs
-- [x] Get Rspamd logs
-- [x] Get SOGo logs
-- [x] Get Watchdog logs
-
-### Address Rewriting
-
-- [x] Create BCC Map
-- [x] Create Recipient Map
-- [x] Delete BCC Map
-- [x] Delete Recipient Map
-- [x] Get BCC Map
-- [x] Get Recipient Map
-
-### Queue Manager
-
-- [ ] Delete Queue
-- [ ] Flush Queue
-- [ ] Get Queue
-
-### Quarantine
-
-- [ ] Delete mails in Quarantaine
-- [ ] Get mails in Quarantaine
-
-### Fail2Ban
-
-- [ ] Edit Fail2Ban
-- [ ] Get Fail2Ban Config
-
-### DKIM
-
-- [ ] Generate DKIM key
-- [ ] Duplicate DKIM key
-- [ ] Delete DKIM key
-- [ ] Get DKIM key
-
-### Domain Admin
-
-- [ ] Create Domain Admin user
-- [ ] Edit Domain Admin ACL
-- [ ] Edit Domain Admin user
-- [ ] Delete Domain Admin
-- [ ] Get Domain Admins
-
-### Outgoing TLS Policy Map Overrides
-
-- [ ] Create TLS Policy Map
-- [ ] Delete TLS Policy Map
-- [ ] Get TLS Policy Map
-
-### oAuth Clients
-
-- [ ] Create oAuth client
-- [ ] Delete oAuth client
-- [ ] Get oAuth Clients
-
-### Routing
-
-- [ ] Create Sender-Dependent Transports
-- [ ] Create Transport Maps
-- [ ] Delete Sender-Dependent Transports
-- [ ] Delete Transport Maps
-- [ ] Get Sender-Dependent Transports
-- [ ] Get Transport Maps
-
-### Resources
-
-- [ ] Create Resources
-- [ ] Delete Resources
-- [ ] Get Resources
-
-### App Passwords
-
-- [ ] Create App Passwords
-- [ ] Delete App Passwords
-- [ ] Get App Passwords
-
-### Status
-
-- [ ] Get container status
-- [ ] Get solr status
-- [ ] Get vmail status
-
-### Ratelimits
-
-- [ ] Get mailbox ratelimits
-- [ ] Get domain ratelimits
-- [ ] Edit domain ratelimits
-- [ ] Edit mailbox ratelimits
+This wrapper acts as a middleman, so those changes can be patched internally without ruining the client interface.

package/dist/client.d.ts

@@ -0,0 +1,178 @@
+/**
+ * @module MailcowClient
+ */
+import { AxiosRequestConfig } from 'axios';
+import { DomainEndpoints } from './endpoints/domain-endpoints';
+import { AntiSpamEndpoints } from './endpoints/antispam-endpoints';
+import { MailboxEndpoints } from './endpoints/mailbox-endpoint';
+import RequestFactory from './request-factory';
+import { AliasEndpoints } from './endpoints/alias-endpoints';
+import { SyncjobEndpoints } from './endpoints/syncjob-endpoints';
+import { ForwardingEndpoints } from './endpoints/forwarding-endpoints';
+import { LogEndpoints } from './endpoints/log-endpoints';
+import { AdressRewritingEndpoints } from './endpoints/address-rewriting-endpoint';
+import { Fail2BanEndpoints } from './endpoints/fail2ban-endpoints';
+import { StatusEndpoints } from './endpoints/status-endpoints';
+import { ResourceEndpoints } from './endpoints/resource-endpoints';
+import { QueueManagerEndpoints } from './endpoints/queue-manager-endpoints';
+import { QuarantineEndpoints } from './endpoints/quarantine-endpoints';
+import { RatelimitsEndpoints } from './endpoints/ratelimit-endpoints';
+import { OAuth2Endpoints } from './endpoints/oauth2-endpoints';
+import { AppPasswordEndpoints } from './endpoints/app-password-endpoints';
+import { TlsPolicyMapEndpoints } from './endpoints/tls-policy-map-endpoints';
+import { DkimEndpoints } from './endpoints/dkim-endpoints';
+import { DomainAdminEndpoints } from './endpoints/domain-admin-endpoints';
+import { RoutingEndpoints } from './endpoints/routing-endpoints';
+/**
+ * Class containing all the logic to interface with the Mailcow API in TypeScript.
+ * @external
+ */
+declare class MailcowClient {
+    /**
+     * The base URL of the Mailcow API.
+     * @internal
+     */
+    readonly BASE_URL: string;
+    /**
+     * The API key of the Mailcow API.
+     * @internal
+     */
+    readonly API_KEY: string;
+    /**
+     * The request config used for every request.
+     * @internal
+     */
+    AXIOS_CONFIG: AxiosRequestConfig;
+    /**
+     * Creates a MailcowClient using the given URL and API key.
+     * @param BASE_URL - The base URL of the Mailcow API.
+     * @param API_KEY  - The API key of the Mailcow API.
+     * @param EXTRA_AXIOS_CONFIG - Allows for setting extra Axios request config such as keep alive.
+     */
+    constructor(BASE_URL: string, API_KEY: string, EXTRA_AXIOS_CONFIG?: AxiosRequestConfig);
+    /**
+     * Factory method pattern for creating HTTP requests.
+     * @internal
+     */
+    requestFactory: RequestFactory;
+    /**
+     * All endpoints related to Aliases.
+     * See {@link AliasEndpoints}
+     */
+    aliases: AliasEndpoints;
+    /**
+     * All endpoints related to Domains.
+     * See {@link DomainEndpoints}
+     * @external
+     */
+    domains: DomainEndpoints;
+    /**
+     * All endpoints related to spam policies.
+     * See {@link AntiSpamEndpoints}
+     * @external
+     */
+    spamPolicy: AntiSpamEndpoints;
+    /**
+     * All endpoints related to mailboxes.
+     * See {@link MailboxEndpoints}
+     * @external
+     */
+    mailbox: MailboxEndpoints;
+    /**
+     * All endpoints related to sync jobs.
+     * See {@link SyncjobEndpoints}
+     * @external
+     */
+    syncjobs: SyncjobEndpoints;
+    /**
+     * All endpoints related to forwarding hosts.
+     * See {@link ForwardingEndpoints}
+     * @external
+     */
+    forwardingHosts: ForwardingEndpoints;
+    /**
+     * All endpoints related to address rewriting.
+     * See {@link AdressRewritingEndpoints}
+     * @external
+     */
+    addressRewriting: AdressRewritingEndpoints;
+    /**
+     * All endpoints related to logs.
+     * See {@link LogEndpoints}
+     * @external
+     */
+    logs: LogEndpoints;
+    /**
+     * All endpoints related to fail2ban.
+     * See {@link Fail2BanEndpoints}
+     * @external
+     */
+    fail2Ban: Fail2BanEndpoints;
+    /**
+     * All endpoints related to status.
+     * See {@link StatusEndpoints}
+     * @external
+     */
+    status: StatusEndpoints;
+    /**
+     * All endpoints related to resources.
+     * See {@link ResourceEndpoints}
+     * @external
+     */
+    resources: ResourceEndpoints;
+    /**
+     * All endpoints related to the mail queue.
+     * See {@link QueueManagerEndpoints}
+     * @external
+     */
+    queueManager: QueueManagerEndpoints;
+    /**
+     * All endpoints related to quarantine.
+     * See {@link QuarantineEndpoints}
+     * @external
+     */
+    quarantine: QuarantineEndpoints;
+    /**
+     * All endpoints related to rate limits.
+     * See {@link RatelimitsEndpoints}
+     * @external
+     */
+    ratelimits: RatelimitsEndpoints;
+    /**
+     * All endpoints related to OAuth2 clients.
+     * See {@link OAuth2Endpoints}
+     * @external
+     */
+    oauth2: OAuth2Endpoints;
+    /**
+     * All endpoints related to app passwords.
+     * See {@link AppPasswordEndpoints}
+     * @external
+     */
+    appPasswords: AppPasswordEndpoints;
+    /**
+     * All endpoints related to TLS Policy Maps.
+     * See {@link TlsPolicyMapEndpoints}
+     * @external
+     */
+    tlsPolicyMaps: TlsPolicyMapEndpoints;
+    /**
+     * All endpoints related to DKIM.
+     * See {@link DkimEndpoints}
+     * @external
+     */
+    dkim: DkimEndpoints;
+    /**
+     * All endpoints related to Domain Admins.
+     * See {@link DomainAdminEndpoints}
+     * @external
+     */
+    domainAdmins: DomainAdminEndpoints;
+    /**
+     * All endpoints related to Routing.
+     * See {@link RoutingEndpoints}
+     * @external
+     */
+    routing: RoutingEndpoints;
+}
+export default MailcowClient;

package/dist/client.js

@@ -0,0 +1,173 @@
+"use strict";
+/**
+ * @module MailcowClient
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const domain_endpoints_1 = require("./endpoints/domain-endpoints");
+const antispam_endpoints_1 = require("./endpoints/antispam-endpoints");
+const mailbox_endpoint_1 = require("./endpoints/mailbox-endpoint");
+const request_factory_1 = require("./request-factory");
+const alias_endpoints_1 = require("./endpoints/alias-endpoints");
+const syncjob_endpoints_1 = require("./endpoints/syncjob-endpoints");
+const forwarding_endpoints_1 = require("./endpoints/forwarding-endpoints");
+const log_endpoints_1 = require("./endpoints/log-endpoints");
+const address_rewriting_endpoint_1 = require("./endpoints/address-rewriting-endpoint");
+const fail2ban_endpoints_1 = require("./endpoints/fail2ban-endpoints");
+const status_endpoints_1 = require("./endpoints/status-endpoints");
+const resource_endpoints_1 = require("./endpoints/resource-endpoints");
+const queue_manager_endpoints_1 = require("./endpoints/queue-manager-endpoints");
+const quarantine_endpoints_1 = require("./endpoints/quarantine-endpoints");
+const ratelimit_endpoints_1 = require("./endpoints/ratelimit-endpoints");
+const oauth2_endpoints_1 = require("./endpoints/oauth2-endpoints");
+const app_password_endpoints_1 = require("./endpoints/app-password-endpoints");
+const tls_policy_map_endpoints_1 = require("./endpoints/tls-policy-map-endpoints");
+const dkim_endpoints_1 = require("./endpoints/dkim-endpoints");
+const domain_admin_endpoints_1 = require("./endpoints/domain-admin-endpoints");
+const routing_endpoints_1 = require("./endpoints/routing-endpoints");
+/**
+ * Class containing all the logic to interface with the Mailcow API in TypeScript.
+ * @external
+ */
+class MailcowClient {
+    /**
+     * Creates a MailcowClient using the given URL and API key.
+     * @param BASE_URL - The base URL of the Mailcow API.
+     * @param API_KEY  - The API key of the Mailcow API.
+     * @param EXTRA_AXIOS_CONFIG - Allows for setting extra Axios request config such as keep alive.
+     */
+    constructor(BASE_URL, API_KEY, EXTRA_AXIOS_CONFIG) {
+        /**
+         * Factory method pattern for creating HTTP requests.
+         * @internal
+         */
+        this.requestFactory = new request_factory_1.default(this);
+        /**
+         * All endpoints related to Aliases.
+         * See {@link AliasEndpoints}
+         */
+        this.aliases = (0, alias_endpoints_1.aliasEndpoints)(this);
+        /**
+         * All endpoints related to Domains.
+         * See {@link DomainEndpoints}
+         * @external
+         */
+        this.domains = (0, domain_endpoints_1.domainEndpoints)(this);
+        /**
+         * All endpoints related to spam policies.
+         * See {@link AntiSpamEndpoints}
+         * @external
+         */
+        this.spamPolicy = (0, antispam_endpoints_1.antiSpamEndpoints)(this);
+        /**
+         * All endpoints related to mailboxes.
+         * See {@link MailboxEndpoints}
+         * @external
+         */
+        this.mailbox = (0, mailbox_endpoint_1.mailboxEndpoints)(this);
+        /**
+         * All endpoints related to sync jobs.
+         * See {@link SyncjobEndpoints}
+         * @external
+         */
+        this.syncjobs = (0, syncjob_endpoints_1.syncjobEndpoints)(this);
+        /**
+         * All endpoints related to forwarding hosts.
+         * See {@link ForwardingEndpoints}
+         * @external
+         */
+        this.forwardingHosts = (0, forwarding_endpoints_1.forwardingEndpoints)(this);
+        /**
+         * All endpoints related to address rewriting.
+         * See {@link AdressRewritingEndpoints}
+         * @external
+         */
+        this.addressRewriting = (0, address_rewriting_endpoint_1.addressRewritingEndpoints)(this);
+        /**
+         * All endpoints related to logs.
+         * See {@link LogEndpoints}
+         * @external
+         */
+        this.logs = (0, log_endpoints_1.logEndpoints)(this);
+        /**
+         * All endpoints related to fail2ban.
+         * See {@link Fail2BanEndpoints}
+         * @external
+         */
+        this.fail2Ban = (0, fail2ban_endpoints_1.fail2BanEndpoints)(this);
+        /**
+         * All endpoints related to status.
+         * See {@link StatusEndpoints}
+         * @external
+         */
+        this.status = (0, status_endpoints_1.statusEndpoints)(this);
+        /**
+         * All endpoints related to resources.
+         * See {@link ResourceEndpoints}
+         * @external
+         */
+        this.resources = (0, resource_endpoints_1.resourceEndpoints)(this);
+        /**
+         * All endpoints related to the mail queue.
+         * See {@link QueueManagerEndpoints}
+         * @external
+         */
+        this.queueManager = (0, queue_manager_endpoints_1.queueManagerEndpoints)(this);
+        /**
+         * All endpoints related to quarantine.
+         * See {@link QuarantineEndpoints}
+         * @external
+         */
+        this.quarantine = (0, quarantine_endpoints_1.quarantineEndpoints)(this);
+        /**
+         * All endpoints related to rate limits.
+         * See {@link RatelimitsEndpoints}
+         * @external
+         */
+        this.ratelimits = (0, ratelimit_endpoints_1.ratelimitsEndpoints)(this);
+        /**
+         * All endpoints related to OAuth2 clients.
+         * See {@link OAuth2Endpoints}
+         * @external
+         */
+        this.oauth2 = (0, oauth2_endpoints_1.oauth2Endpoints)(this);
+        /**
+         * All endpoints related to app passwords.
+         * See {@link AppPasswordEndpoints}
+         * @external
+         */
+        this.appPasswords = (0, app_password_endpoints_1.appPasswordEndpoints)(this);
+        /**
+         * All endpoints related to TLS Policy Maps.
+         * See {@link TlsPolicyMapEndpoints}
+         * @external
+         */
+        this.tlsPolicyMaps = (0, tls_policy_map_endpoints_1.tlsPolicyMapEndpoints)(this);
+        /**
+         * All endpoints related to DKIM.
+         * See {@link DkimEndpoints}
+         * @external
+         */
+        this.dkim = (0, dkim_endpoints_1.dkimEndpoints)(this);
+        /**
+         * All endpoints related to Domain Admins.
+         * See {@link DomainAdminEndpoints}
+         * @external
+         */
+        this.domainAdmins = (0, domain_admin_endpoints_1.domainAdminEndpoints)(this);
+        /**
+         * All endpoints related to Routing.
+         * See {@link RoutingEndpoints}
+         * @external
+         */
+        this.routing = (0, routing_endpoints_1.routingEndpoints)(this);
+        this.BASE_URL = BASE_URL.charAt(BASE_URL.length - 1) === '/' ? BASE_URL : BASE_URL.concat('/');
+        this.API_KEY = API_KEY;
+        // Set the correct Axios request config.
+        this.AXIOS_CONFIG = Object.assign(Object.assign({}, EXTRA_AXIOS_CONFIG), { headers: {
+                'Content-Type': 'application/json',
+                'X-API-Key': this.API_KEY,
+            } });
+    }
+}
+exports.default = MailcowClient;
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAGH,mEAAgF;AAChF,uEAAsF;AACtF,mEAAkF;AAClF,uDAA+C;AAC/C,iEAA6E;AAC7E,qEAAmF;AACnF,2EAA4F;AAC5F,6DAAuE;AACvE,uFAA6G;AAC7G,uEAAsF;AACtF,mEAAgF;AAChF,uEAAsF;AACtF,iFAAmG;AACnG,2EAA4F;AAC5F,yEAA2F;AAC3F,mEAAgF;AAChF,+EAAgG;AAChG,mFAAoG;AACpG,+DAA0E;AAC1E,+EAAgG;AAChG,qEAAmF;AAEnF;;;GAGG;AACH,MAAM,aAAa;IAmBjB;;;;;OAKG;IACH,YAAY,QAAgB,EAAE,OAAe,EAAE,kBAAuC;QActF;;;WAGG;QACI,mBAAc,GAAG,IAAI,yBAAc,CAAC,IAAI,CAAC,CAAC;QAEjD;;;WAGG;QACI,YAAO,GAAmB,IAAA,gCAAc,EAAC,IAAI,CAAC,CAAC;QAEtD;;;;WAIG;QACI,YAAO,GAAoB,IAAA,kCAAe,EAAC,IAAI,CAAC,CAAC;QAExD;;;;WAIG;QACI,eAAU,GAAsB,IAAA,sCAAiB,EAAC,IAAI,CAAC,CAAC;QAE/D;;;;WAIG;QACI,YAAO,GAAqB,IAAA,mCAAgB,EAAC,IAAI,CAAC,CAAC;QAE1D;;;;WAIG;QACI,aAAQ,GAAqB,IAAA,oCAAgB,EAAC,IAAI,CAAC,CAAC;QAE3D;;;;WAIG;QACI,oBAAe,GAAwB,IAAA,0CAAmB,EAAC,IAAI,CAAC,CAAC;QAExE;;;;WAIG;QACI,qBAAgB,GAA6B,IAAA,sDAAyB,EAAC,IAAI,CAAC,CAAC;QAEpF;;;;WAIG;QACI,SAAI,GAAiB,IAAA,4BAAY,EAAC,IAAI,CAAC,CAAC;QAE/C;;;;WAIG;QACI,aAAQ,GAAsB,IAAA,sCAAiB,EAAC,IAAI,CAAC,CAAC;QAE7D;;;;WAIG;QACI,WAAM,GAAoB,IAAA,kCAAe,EAAC,IAAI,CAAC,CAAC;QAEvD;;;;WAIG;QACI,cAAS,GAAsB,IAAA,sCAAiB,EAAC,IAAI,CAAC,CAAC;QAE9D;;;;WAIG;QACI,iBAAY,GAA0B,IAAA,+CAAqB,EAAC,IAAI,CAAC,CAAC;QAEzE;;;;WAIG;QACI,eAAU,GAAwB,IAAA,0CAAmB,EAAC,IAAI,CAAC,CAAC;QAEnE;;;;WAIG;QACI,eAAU,GAAwB,IAAA,yCAAmB,EAAC,IAAI,CAAC,CAAC;QAEnE;;;;WAIG;QACI,WAAM,GAAoB,IAAA,kCAAe,EAAC,IAAI,CAAC,CAAC;QAEvD;;;;WAIG;QACI,iBAAY,GAAyB,IAAA,6CAAoB,EAAC,IAAI,CAAC,CAAC;QAEvE;;;;WAIG;QACI,kBAAa,GAA0B,IAAA,gDAAqB,EAAC,IAAI,CAAC,CAAC;QAE1E;;;;WAIG;QACI,SAAI,GAAkB,IAAA,8BAAa,EAAC,IAAI,CAAC,CAAC;QAEjD;;;;WAIG;QACI,iBAAY,GAAyB,IAAA,6CAAoB,EAAC,IAAI,CAAC,CAAC;QAEvE;;;;WAIG;QACI,YAAO,GAAqB,IAAA,oCAAgB,EAAC,IAAI,CAAC,CAAC;QA5JxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC/F,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,wCAAwC;QACxC,IAAI,CAAC,YAAY,mCACZ,kBAAkB,KACrB,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,WAAW,EAAE,IAAI,CAAC,OAAO;aAC1B,GACF,CAAC;IACJ,CAAC;CAkJF;AAED,kBAAe,aAAa,CAAC"}

package/dist/endpoints/address-rewriting-endpoint.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addressRewritingEndpoints = addressRewritingEndpoints;
+const ADDRESS_REWRITING_ENDPOINTS = {
+    ADD_BCC_MAP: 'add/bcc',
+    ADD_RECIPIENT_MAP: 'add/recipient_map',
+    DELETE_BCC_MAP: 'delete/bcc',
+    DELETE_RECIPIENT_MAP: 'delete/recipient_map',
+    GET_BCC_MAP: 'get/bcc',
+    GET_RECIPIENT_MAP: 'get/recipient_map',
+};
+function addressRewritingEndpoints(bind) {
+    return {
+        addBccMap(payload) {
+            return bind.requestFactory.post(ADDRESS_REWRITING_ENDPOINTS.ADD_BCC_MAP, payload);
+        },
+        addRecipientMap(payload) {
+            return bind.requestFactory.post(ADDRESS_REWRITING_ENDPOINTS.ADD_RECIPIENT_MAP, payload);
+        },
+        deleteBccMap(payload) {
+            return bind.requestFactory.post(ADDRESS_REWRITING_ENDPOINTS.DELETE_BCC_MAP, payload);
+        },
+        deleteRecipientMap(payload) {
+            return bind.requestFactory.post(ADDRESS_REWRITING_ENDPOINTS.DELETE_RECIPIENT_MAP, payload);
+        },
+        getBccMap(id) {
+            return bind.requestFactory.get(ADDRESS_REWRITING_ENDPOINTS.GET_BCC_MAP + `/${id}`);
+        },
+        getRecipientMap(id) {
+            return bind.requestFactory.get(ADDRESS_REWRITING_ENDPOINTS.GET_RECIPIENT_MAP + `/${id}`);
+        },
+    };
+}
+//# sourceMappingURL=address-rewriting-endpoint.js.map

package/dist/endpoints/address-rewriting-endpoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"address-rewriting-endpoint.js","sourceRoot":"","sources":["../../src/endpoints/address-rewriting-endpoint.ts"],"names":[],"mappings":";;AAqDA,8DAsCC;AA/CD,MAAM,2BAA2B,GAAG;IAClC,WAAW,EAAE,SAAS;IACtB,iBAAiB,EAAE,mBAAmB;IACtC,cAAc,EAAE,YAAY;IAC5B,oBAAoB,EAAE,sBAAsB;IAC5C,WAAW,EAAE,SAAS;IACtB,iBAAiB,EAAE,mBAAmB;CACvC,CAAC;AAEF,SAAgB,yBAAyB,CAAC,IAAmB;IAC3D,OAAO;QACL,SAAS,CAAC,OAAyB;YACjC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,2BAA2B,CAAC,WAAW,EACvC,OAAO,CACR,CAAC;QACJ,CAAC;QAED,eAAe,CAAC,OAA+B;YAC7C,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,2BAA2B,CAAC,iBAAiB,EAC7C,OAAO,CACR,CAAC;QACJ,CAAC;QAED,YAAY,CAAC,OAA8B;YACzC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,2BAA2B,CAAC,cAAc,EAC1C,OAAO,CACR,CAAC;QACJ,CAAC;QAED,kBAAkB,CAAC,OAAoC;YACrD,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,2BAA2B,CAAC,oBAAoB,EAChD,OAAO,CACR,CAAC;QACJ,CAAC;QAED,SAAS,CAAC,EAAkB;YAC1B,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAoB,2BAA2B,CAAC,WAAW,GAAG,IAAI,EAAE,EAAE,CAAC,CAAC;QACxG,CAAC;QAED,eAAe,CAAC,EAAkB;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAA0B,2BAA2B,CAAC,iBAAiB,GAAG,IAAI,EAAE,EAAE,CAAC,CAAC;QACpH,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/{Endpoints → endpoints}/alias-endpoints.js

@@ -2,6 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.aliasEndpoints = aliasEndpoints;
 const request_factory_1 = require("../request-factory");
+const ALIAS_ENDPOINTS = {
+    GET: 'get/alias',
+    ADD: 'add/alias',
+    EDIT: 'edit/alias',
+    DELETE: 'delete/alias',
+};
 /**
  * Binder function between the MailcowClient class and the AliasEndpoints.
  * @param bind - The MailcowClient to bind.
@@ -10,16 +16,16 @@ const request_factory_1 = require("../request-factory");
 function aliasEndpoints(bind) {
     return {
         get(id = 'all') {
-            return (0, request_factory_1.wrapPromiseToArray)(bind.requestFactory.get(`/api/v1/get/alias/${id}`));
+            return (0, request_factory_1.wrapPromiseToArray)(bind.requestFactory.get(ALIAS_ENDPOINTS.GET + `/${id}`));
         },
         create: (payload) => {
-            return bind.requestFactory.post('/api/v1/add/alias', payload);
+            return bind.requestFactory.post(ALIAS_ENDPOINTS.ADD, payload);
         },
         edit: (payload) => {
-            return bind.requestFactory.post('/api/v1/edit/alias', payload);
+            return bind.requestFactory.post(ALIAS_ENDPOINTS.EDIT, payload);
         },
         delete: (payload) => {
-            return bind.requestFactory.post('/api/v1/delete/alias', payload.items);
+            return bind.requestFactory.post(ALIAS_ENDPOINTS.DELETE, payload.items);
         },
     };
 }

package/dist/endpoints/alias-endpoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alias-endpoints.js","sourceRoot":"","sources":["../../src/endpoints/alias-endpoints.ts"],"names":[],"mappings":";;AA6CA,wCAeC;AA1DD,wDAAwD;AA+BxD,MAAM,eAAe,GAAG;IACtB,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,WAAW;IAChB,IAAI,EAAE,YAAY;IAClB,MAAM,EAAE,cAAc;CACvB,CAAC;AAEF;;;;GAIG;AACH,SAAgB,cAAc,CAAC,IAAmB;IAChD,OAAO;QACL,GAAG,CAAC,EAAE,GAAG,KAAK;YACZ,OAAO,IAAA,oCAAkB,EAAQ,IAAI,CAAC,cAAc,CAAC,GAAG,CAAkB,eAAe,CAAC,GAAG,GAAG,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;QAC7G,CAAC;QACD,MAAM,EAAE,CAAC,OAAyB,EAA4B,EAAE;YAC9D,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAoC,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACnG,CAAC;QACD,IAAI,EAAE,CAAC,OAAyB,EAA4B,EAAE;YAC5D,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAoC,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACpG,CAAC;QACD,MAAM,EAAE,CAAC,OAA2B,EAA4B,EAAE;YAChE,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAA4B,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QACpG,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/{Endpoints → endpoints}/antispam-endpoints.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.antiSpamEndpoints = antiSpamEndpoints;
+const ANTI_SPAM_ENDPOINTS = {
+    CREATE: 'add/domain-policy',
+    DELETE: 'delete/domain-policy',
+};
 /**
  * Binder function between the MailcowClient class and the AntiSpamEndpoints
  * @param bind - The MailcowClient to bind.
@@ -9,13 +13,13 @@ exports.antiSpamEndpoints = antiSpamEndpoints;
 function antiSpamEndpoints(bind) {
     return {
         create(payload) {
-            return bind.requestFactory.post('/api/v1/add/domain-policy', payload);
+            return bind.requestFactory.post(ANTI_SPAM_ENDPOINTS.CREATE, payload);
         },
         delete(payload) {
-            return bind.requestFactory.post('/api/v1/delete/domain-policy', payload.prefid);
+            return bind.requestFactory.post(ANTI_SPAM_ENDPOINTS.DELETE, payload.prefid);
         },
         get(payload) {
-            return bind.requestFactory.get(`/api/v1/get/policy_${payload.type}_domain/${payload.domain}`);
+            return bind.requestFactory.get(`get/policy_${payload.type}_domain/${payload.domain}`);
         },
     };
 }

package/dist/endpoints/antispam-endpoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"antispam-endpoints.js","sourceRoot":"","sources":["../../src/endpoints/antispam-endpoints.ts"],"names":[],"mappings":";;AA0CA,8CAYC;AAtBD,MAAM,mBAAmB,GAAG;IAC1B,MAAM,EAAE,mBAAmB;IAC3B,MAAM,EAAE,sBAAsB;CAC/B,CAAC;AAEF;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,IAAmB;IACnD,OAAO;QACL,MAAM,CAAC,OAA8B;YACnC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAyC,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC/G,CAAC;QACD,MAAM,CAAC,OAAgC;YACrC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAA4B,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QACzG,CAAC;QACD,GAAG,CAAC,OAA6B;YAC/B,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAe,cAAc,OAAO,CAAC,IAAI,WAAW,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QACtG,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/endpoints/app-password-endpoints.d.ts

@@ -0,0 +1,29 @@
+import { AddAppPasswordRequest, AppPassword, DeleteAppPasswordRequest, MailcowResponse } from '../types';
+import MailcowClient from '../index';
+/**
+ * Interface for all App Password endpoints related to email handling in Mailcow.
+ */
+export interface AppPasswordEndpoints {
+    /**
+     * Adds a new app password.
+     * @param payload - Object containing the app password details.
+     */
+    add(payload: AddAppPasswordRequest): Promise<MailcowResponse>;
+    /**
+     * Deletes specified app passwords.
+     * @param payload - Object containing a list of app password IDs to delete.
+     */
+    delete(payload: DeleteAppPasswordRequest): Promise<MailcowResponse>;
+    /**
+     * Retrieves app passwords for a specific mailbox.
+     * @param mailbox - The mailbox for which to retrieve app passwords.
+     * @returns A promise that resolves to an array of `AppPassword` objects.
+     */
+    get(mailbox: string): Promise<AppPassword[]>;
+}
+/**
+ * Binder function between the MailcowClient class and the AppPasswordEndpoints.
+ * @param bind - The MailcowClient instance to bind.
+ * @internal
+ */
+export declare function appPasswordEndpoints(bind: MailcowClient): AppPasswordEndpoints;