ts-mailcow-api 0.8.5 → 0.10.0

package/README.md

@@ -1,147 +1,186 @@
-# TypeScript wrapper for the mailcow API.
-
-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.
-```ts
-import MailCowClient from "./index";
-
-// Create MailCowClient based on BASE_URL and API_KEY
-const mcc = new MailCowClient("https://demo.mailcow.email/", "390448-22B69F-FA37D9-19701B-6F033F");
-```
-Then you can use the created wrapper for promised-based API calls according to the Mailcow API specification.
-```ts
-// Get all the mailboxes available.
-mcc.mailbox.get().then((e) => {
-    // Print all mailboxes.
-    console.log(JSON.stringify(e, null, 4));
-}).catch(e => {
-    // Error handling.
-    console.log(e)
-})
-```
-
-## 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
-
-### 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
-
-### Address Rewriting
-- [ ] Create BCC Map
-- [ ] Create Recipient Map
-- [ ] Delete BCC Map
-- [ ] Delete Recipient Map
-- [ ] Get BCC Map
-- [ ] Get Recipient Map
-
-### 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
+# TypeScript wrapper for the mailcow API
+
+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.
+
+```ts
+import MailCowClient from "./index";
+
+// Create MailCowClient based on BASE_URL and API_KEY
+const mcc = new MailCowClient(
+  "https://demo.mailcow.email/",
+  "390448-22B69F-FA37D9-19701B-6F033F",
+);
+```
+
+Then you can use the created wrapper for promised-based API calls according to the Mailcow API specification.
+
+```ts
+// Get all the mailboxes available.
+mcc.mailbox
+  .get()
+  .then((e) => {
+    // Print all mailboxes.
+    console.log(JSON.stringify(e, null, 4));
+  })
+  .catch((e) => {
+    // Error handling.
+    console.log(e);
+  });
+```
+
+## Why it's not auto-generated
+
+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

package/dist/Endpoints/address-rewriting-endpoint.d.ts

@@ -0,0 +1,35 @@
+import MailcowClient from '..';
+import { BccMapDeletionRequest, GetBccMapResponse, GetRecipientMapResponse, RecipientMapDeletionRequest, AddBccMapRequest as AddBccMapRequest, AddRecipientMapRequest as AddRecipientMapRequest, MailcowResponse } from '../types';
+export interface AdressRewritingEndpoints {
+    /**
+     * Endpoint for creating a bcc map.
+     * @param payload - The creation payload.
+     */
+    addBccMap(payload: AddBccMapRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for creating a recipient map.
+     * @param payload - The creation payload.
+     */
+    addRecipientMap(payload: AddRecipientMapRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for deleting a bcc map.
+     * @param payload - The deletion payload.
+     */
+    deleteBccMap(payload: BccMapDeletionRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for deleting a recipient map.
+     * @param payload - The deletion payload.
+     */
+    deleteRecipientMap(payload: RecipientMapDeletionRequest): Promise<MailcowResponse>;
+    /**
+     * Endpoint for getting a bcc map.
+     * @param id - Id of the bcc map to get
+     */
+    getBccMap(id: number | 'all'): Promise<GetBccMapResponse>;
+    /**
+     * Endpoint for getting a recipient map.
+     * @param id - Id of the recipient map to get
+     */
+    getRecipientMap(id: number | 'all'): Promise<GetRecipientMapResponse>;
+}
+export declare function addressRewritingEndpoints(bind: MailcowClient): AdressRewritingEndpoints;

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

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addressRewritingEndpoints = addressRewritingEndpoints;
+function addressRewritingEndpoints(bind) {
+    return {
+        addBccMap(payload) {
+            return bind.requestFactory.post('/api/v1/add/bcc', payload);
+        },
+        addRecipientMap(payload) {
+            return bind.requestFactory.post('/api/v1/add/recipient_map', payload);
+        },
+        deleteBccMap(payload) {
+            return bind.requestFactory.post('/api/v1/delete/bcc', payload);
+        },
+        deleteRecipientMap(payload) {
+            return bind.requestFactory.post('/api/v1/delete/recipient_map', payload);
+        },
+        getBccMap(id) {
+            return bind.requestFactory.get(`/api/v1/get/bcc/${id}`);
+        },
+        getRecipientMap(id) {
+            return bind.requestFactory.get(`/api/v1/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":";;AA4CA,8DA6BC;AA7BD,SAAgB,yBAAyB,CAAC,IAAmB;IAC3D,OAAO;QACL,SAAS,CAAC,OAAyB;YACjC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAoC,iBAAiB,EAAE,OAAO,CAAC,CAAC;QACjG,CAAC;QAED,eAAe,CAAC,OAA+B;YAC7C,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAA0C,2BAA2B,EAAE,OAAO,CAAC,CAAC;QACjH,CAAC;QAED,YAAY,CAAC,OAA8B;YACzC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAyC,oBAAoB,EAAE,OAAO,CAAC,CAAC;QACzG,CAAC;QAED,kBAAkB,CAAC,OAAoC;YACrD,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,8BAA8B,EAC9B,OAAO,CACR,CAAC;QACJ,CAAC;QAED,SAAS,CAAC,EAAkB;YAC1B,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAoB,mBAAmB,EAAE,EAAE,CAAC,CAAC;QAC7E,CAAC;QAED,eAAe,CAAC,EAAkB;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAA0B,6BAA6B,EAAE,EAAE,CAAC,CAAC;QAC7F,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/Endpoints/alias-endpoints.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.aliasEndpoints = void 0;
+exports.aliasEndpoints = aliasEndpoints;
 const request_factory_1 = require("../request-factory");
 /**
  * Binder function between the MailcowClient class and the AliasEndpoints.
@@ -20,8 +20,7 @@ function aliasEndpoints(bind) {
         },
         delete: (payload) => {
             return bind.requestFactory.post('/api/v1/delete/alias', payload.items);
-        }
+        },
     };
 }
-exports.aliasEndpoints = aliasEndpoints;
 //# sourceMappingURL=alias-endpoints.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"alias-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/alias-endpoints.ts"],"names":[],"mappings":";;;AAQA,wDAAwD;AA+BxD;;;;GAIG;AACH,SAAgB,cAAc,CAAC,IAAmB;IAChD,OAAO;QACL,GAAG,CAAC,EAAE,GAAG,KAAK;YACZ,OAAO,IAAA,oCAAkB,EACvB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAkB,qBAAqB,EAAE,EAAE,CAAC,CACpE,CAAC;QACJ,CAAC;QACD,MAAM,EAAE,CAAC,OAAyB,EAA4B,EAAE;YAC9D,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,mBAAmB,EACnB,OAAO,CACR,CAAC;QACJ,CAAC;QACD,IAAI,EAAE,CAAC,OAAyB,EAA4B,EAAE;YAC5D,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,oBAAoB,EACpB,OAAO,CACR,CAAC;QACJ,CAAC;QACD,MAAM,EAAE,CAAC,OAA2B,EAA4B,EAAE;YAChE,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,sBAAsB,EACtB,OAAO,CAAC,KAAK,CACd,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AA1BD,wCA0BC"}
+{"version":3,"file":"alias-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/alias-endpoints.ts"],"names":[],"mappings":";;AAsCA,wCAeC;AAnDD,wDAAwD;AA+BxD;;;;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,qBAAqB,EAAE,EAAE,CAAC,CAAC,CAAC;QACxG,CAAC;QACD,MAAM,EAAE,CAAC,OAAyB,EAA4B,EAAE;YAC9D,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAoC,mBAAmB,EAAE,OAAO,CAAC,CAAC;QACnG,CAAC;QACD,IAAI,EAAE,CAAC,OAAyB,EAA4B,EAAE;YAC5D,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAoC,oBAAoB,EAAE,OAAO,CAAC,CAAC;QACpG,CAAC;QACD,MAAM,EAAE,CAAC,OAA2B,EAA4B,EAAE;YAChE,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAA4B,sBAAsB,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QACpG,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/Endpoints/antispam-endpoints.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.antiSpamEndpoints = void 0;
+exports.antiSpamEndpoints = antiSpamEndpoints;
 /**
  * Binder function between the MailcowClient class and the AntiSpamEndpoints
  * @param bind - The MailcowClient to bind.
@@ -16,8 +16,7 @@ function antiSpamEndpoints(bind) {
         },
         get(payload) {
             return bind.requestFactory.get(`/api/v1/get/policy_${payload.type}_domain/${payload.domain}`);
-        }
+        },
     };
 }
-exports.antiSpamEndpoints = antiSpamEndpoints;
 //# sourceMappingURL=antispam-endpoints.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"antispam-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/antispam-endpoints.ts"],"names":[],"mappings":";;;AAiCA;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,IAAmB;IACnD,OAAO;QACL,MAAM,CAAC,OAA8B;YACnC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,2BAA2B,EAC3B,OAAO,CACR,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,OAAgC;YACrC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,8BAA8B,EAC9B,OAAO,CAAC,MAAM,CACf,CAAC;QACJ,CAAC;QACD,GAAG,CAAC,OAA6B;YAC/B,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,sBAAuB,OAAO,CAAC,IAAK,WAAY,OAAO,CAAC,MAAO,EAAE,CAClE,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AApBD,8CAoBC"}
+{"version":3,"file":"antispam-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/antispam-endpoints.ts"],"names":[],"mappings":";;AAqCA,8CAYC;AAjBD;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,IAAmB;IACnD,OAAO;QACL,MAAM,CAAC,OAA8B;YACnC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAyC,2BAA2B,EAAE,OAAO,CAAC,CAAC;QAChH,CAAC;QACD,MAAM,CAAC,OAAgC;YACrC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAA4B,8BAA8B,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC7G,CAAC;QACD,GAAG,CAAC,OAA6B;YAC/B,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAe,sBAAsB,OAAO,CAAC,IAAI,WAAW,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QAC9G,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/Endpoints/domain-endpoints.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.domainEndpoints = void 0;
+exports.domainEndpoints = domainEndpoints;
 const request_factory_1 = require("../request-factory");
 /**
  * Binder function between the MailcowClient class and the DomainEndpoints.
@@ -20,8 +20,7 @@ function domainEndpoints(bind) {
         },
         edit(payload) {
             return bind.requestFactory.post('/api/v1/edit/domain', payload);
-        }
+        },
     };
 }
-exports.domainEndpoints = domainEndpoints;
 //# sourceMappingURL=domain-endpoints.js.map

package/dist/Endpoints/domain-endpoints.js.map

@@ -1 +1 @@
-{"version":3,"file":"domain-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/domain-endpoints.ts"],"names":[],"mappings":";;;AAQA,wDAAwD;AA+BxD;;;;GAIG;AACH,SAAgB,eAAe,CAAC,IAAmB;IACjD,OAAO;QACL,GAAG,CAAC,SAAiB,KAAK;YACxB,OAAO,IAAA,oCAAkB,EACvB,IAAI,CAAC,cAAc,CAAC,GAAG,CACrB,sBAAuB,MAAO,EAAE,CACjC,CACF,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,OAA0B;YAC/B,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,oBAAoB,EACpB,OAAO,CACR,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,OAA4B;YACjC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,uBAAuB,EACvB,OAAO,CAAC,OAAO,CAChB,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,OAA0B;YAC7B,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,qBAAqB,EACrB,OAAO,CACR,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AA5BD,0CA4BC"}
+{"version":3,"file":"domain-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/domain-endpoints.ts"],"names":[],"mappings":";;AAsCA,0CAeC;AAnDD,wDAAwD;AA+BxD;;;;GAIG;AACH,SAAgB,eAAe,CAAC,IAAmB;IACjD,OAAO;QACL,GAAG,CAAC,SAAiB,KAAK;YACxB,OAAO,IAAA,oCAAkB,EAAS,IAAI,CAAC,cAAc,CAAC,GAAG,CAAoB,sBAAsB,MAAM,EAAE,CAAC,CAAC,CAAC;QAChH,CAAC;QACD,MAAM,CAAC,OAA0B;YAC/B,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAqC,oBAAoB,EAAE,OAAO,CAAC,CAAC;QACrG,CAAC;QACD,MAAM,CAAC,OAA4B;YACjC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAA4B,uBAAuB,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACvG,CAAC;QACD,IAAI,CAAC,OAA0B;YAC7B,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAqC,qBAAqB,EAAE,OAAO,CAAC,CAAC;QACtG,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/Endpoints/forwarding-endpoints.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.forwardingEndpoints = void 0;
+exports.forwardingEndpoints = forwardingEndpoints;
 /**
  * Binder function between the MailcowClient class and the ForwardingEndpoints.
  * @param bind - The MailcowClient to bind.
@@ -16,8 +16,7 @@ function forwardingEndpoints(bind) {
         },
         getAll() {
             return bind.requestFactory.get('/api/v1/get/fwdhost/all');
-        }
+        },
     };
 }
-exports.forwardingEndpoints = forwardingEndpoints;
 //# sourceMappingURL=forwarding-endpoints.js.map

package/dist/Endpoints/forwarding-endpoints.js.map

@@ -1 +1 @@
-{"version":3,"file":"forwarding-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/forwarding-endpoints.ts"],"names":[],"mappings":";;;AAyBA;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,IAAmB;IACrD,OAAO;QACL,MAAM,CAAC,OAAgC;YACrC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,wBAAwB,EACxB,OAAO,CAAC,KAAK,CACd,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,OAAgC;YACrC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,qBAAqB,EACrB,OAAO,CACR,CAAC;QACJ,CAAC;QACD,MAAM;YACJ,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,yBAAyB,CAC1B,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AApBD,kDAoBC"}
+{"version":3,"file":"forwarding-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/forwarding-endpoints.ts"],"names":[],"mappings":";;AA8BA,kDAYC;AAjBD;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,IAAmB;IACrD,OAAO;QACL,MAAM,CAAC,OAAgC;YACrC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAA4B,wBAAwB,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QACtG,CAAC;QACD,MAAM,CAAC,OAAgC;YACrC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAA2C,qBAAqB,EAAE,OAAO,CAAC,CAAC;QAC5G,CAAC;QACD,MAAM;YACJ,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAmB,yBAAyB,CAAC,CAAC;QAC9E,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/Endpoints/log-endpoints.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logEndpoints = void 0;
+exports.logEndpoints = logEndpoints;
 function logEndpoints(bind) {
     return {
         acme(count) {
@@ -32,8 +32,7 @@ function logEndpoints(bind) {
         },
         watchdog(count) {
             return bind.requestFactory.get(`/api/v1/get/logs/watchdog/${count}`);
-        }
+        },
     };
 }
-exports.logEndpoints = logEndpoints;
 //# sourceMappingURL=log-endpoints.js.map

package/dist/Endpoints/log-endpoints.js.map

@@ -1 +1 @@
-{"version":3,"file":"log-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/log-endpoints.ts"],"names":[],"mappings":";;;AA4EA,SAAgB,YAAY,CAAC,IAAmB;IAC9C,OAAO;QACL,IAAI,CAAC,KAAa;YAChB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,yBAAyB,KAAK,EAAE,CACjC,CAAC;QACJ,CAAC;QACD,GAAG,CAAC,KAAa;YACf,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,wBAAwB,KAAK,EAAE,CAChC,CAAC;QACJ,CAAC;QACD,YAAY,CAAC,KAAa;YACxB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,iCAAiC,KAAK,EAAE,CACzC,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,KAAa;YACnB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,4BAA4B,KAAK,EAAE,CACpC,CAAC;QACJ,CAAC;QACD,SAAS,CAAC,KAAa;YACrB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,8BAA8B,KAAK,EAAE,CACtC,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,KAAa;YACnB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,4BAA4B,KAAK,EAAE,CACpC,CAAC;QACJ,CAAC;QACD,WAAW,CAAC,KAAa;YACvB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,gCAAgC,KAAK,EAAE,CACxC,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,KAAa;YAClB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,mCAAmC,KAAK,EAAE,CAC3C,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,KAAa;YAChB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,yBAAyB,KAAK,EAAE,CACjC,CAAC;QACJ,CAAC;QACD,QAAQ,CAAC,KAAa;YACpB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,6BAA6B,KAAK,EAAE,CACrC,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AArDD,oCAqDC"}
+{"version":3,"file":"log-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/log-endpoints.ts"],"names":[],"mappings":";;AAiEA,oCAiCC;AAjCD,SAAgB,YAAY,CAAC,IAAmB;IAC9C,OAAO;QACL,IAAI,CAAC,KAAa;YAChB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAY,yBAAyB,KAAK,EAAE,CAAC,CAAC;QAC9E,CAAC;QACD,GAAG,CAAC,KAAa;YACf,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAW,wBAAwB,KAAK,EAAE,CAAC,CAAC;QAC5E,CAAC;QACD,YAAY,CAAC,KAAa;YACxB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAU,iCAAiC,KAAK,EAAE,CAAC,CAAC;QACpF,CAAC;QACD,OAAO,CAAC,KAAa;YACnB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAU,4BAA4B,KAAK,EAAE,CAAC,CAAC;QAC/E,CAAC;QACD,SAAS,CAAC,KAAa;YACrB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAU,8BAA8B,KAAK,EAAE,CAAC,CAAC;QACjF,CAAC;QACD,OAAO,CAAC,KAAa;YACnB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAU,4BAA4B,KAAK,EAAE,CAAC,CAAC;QAC/E,CAAC;QACD,WAAW,CAAC,KAAa;YACvB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAU,gCAAgC,KAAK,EAAE,CAAC,CAAC;QACnF,CAAC;QACD,MAAM,CAAC,KAAa;YAClB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAU,mCAAmC,KAAK,EAAE,CAAC,CAAC;QACtF,CAAC;QACD,IAAI,CAAC,KAAa;YAChB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAU,yBAAyB,KAAK,EAAE,CAAC,CAAC;QAC5E,CAAC;QACD,QAAQ,CAAC,KAAa;YACpB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAU,6BAA6B,KAAK,EAAE,CAAC,CAAC;QAChF,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/Endpoints/mailbox-endpoint.d.ts

@@ -23,7 +23,8 @@ export interface MailboxEndpoints {
      * Endpoint for getting a mailbox.
      * @param mailbox - The mailbox to get
      */
-    get(mailbox: string | 'all'): Promise<Mailbox[]>;
+    get(mailbox: 'all'): Promise<Mailbox[]>;
+    get(mailbox: string): Promise<Mailbox[]>;
     /**
      * Endpoint for editing a mailbox's pushover settings.
      * @param payload - The edit payload.

package/dist/Endpoints/mailbox-endpoint.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mailboxEndpoints = void 0;
+exports.mailboxEndpoints = mailboxEndpoints;
 const request_factory_1 = require("../request-factory");
 /**
  * Binder function between the MailcowClient class and the MailboxEndpoints
@@ -35,8 +35,7 @@ function mailboxEndpoints(bind) {
         },
         getActiveUserSieve(mailbox) {
             return bind.requestFactory.get(`/api/v1/get/active-user-sieve/${mailbox}`);
-        }
+        },
     };
 }
-exports.mailboxEndpoints = mailboxEndpoints;
 //# sourceMappingURL=mailbox-endpoint.js.map

package/dist/Endpoints/mailbox-endpoint.js.map

@@ -1 +1 @@
-{"version":3,"file":"mailbox-endpoint.js","sourceRoot":"","sources":["../../src/Endpoints/mailbox-endpoint.ts"],"names":[],"mappings":";;;AAYA,wDAAwD;AA6DxD;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,IAAmB;IAClD,OAAO;QACL,MAAM,CAAC,OAA2B;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,qBAAqB,EACrB,OAAO,CACR,CAAC;QACJ,CAAC;QAED,MAAM,CAAC,OAA6B;YAClC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,wBAAwB,EACxB,OAAO,CAAC,SAAS,CAClB,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,OAA2B;YAC9B,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,sBAAsB,EACtB,OAAO,CACR,CAAC;QACJ,CAAC;QAED,GAAG,CAAC,UAAkB,KAAK;YACzB,OAAO,IAAA,oCAAkB,EACvB,IAAI,CAAC,cAAc,CAAC,GAAG,CACrB,uBAAwB,OAAQ,EAAE,CAAC,CACtC,CAAC;QACJ,CAAC;QAED,YAAY,CAAC,OAA4B;YACvC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,uBAAuB,EACvB,OAAO,CACR,CAAC;QACJ,CAAC;QAED,cAAc,CAAC,OAA+B;YAC5C,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,sCAAsC,EACtC,OAAO,CACR,CAAC;QACJ,CAAC;QAED,aAAa,CAAC,OAA6B;YACzC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,yBAAyB,EACzB,OAAO,CACR,CAAC;QACJ,CAAC;QAED,WAAW,CAAC,OAAuB;YACjC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,uBAAuB,EACvB,OAAO,CACR,CAAC;QACJ,CAAC;QAED,kBAAkB,CAAC,OAAe;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,iCAAkC,OAAQ,EAAE,CAC7C,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAhED,4CAgEC"}
+{"version":3,"file":"mailbox-endpoint.js","sourceRoot":"","sources":["../../src/Endpoints/mailbox-endpoint.ts"],"names":[],"mappings":";;AA+EA,4CA2CC;AA9GD,wDAAwD;AA8DxD;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,IAAmB;IAClD,OAAO;QACL,MAAM,CAAC,OAA2B;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAsC,qBAAqB,EAAE,OAAO,CAAC,CAAC;QACvG,CAAC;QAED,MAAM,CAAC,OAA6B;YAClC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAA4B,wBAAwB,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;QAC1G,CAAC;QAED,IAAI,CAAC,OAA2B;YAC9B,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAsC,sBAAsB,EAAE,OAAO,CAAC,CAAC;QACxG,CAAC;QAED,GAAG,CAAC,UAAkB,KAAK;YACzB,OAAO,IAAA,oCAAkB,EACvB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAsB,uBAAuB,OAAO,EAAE,CAAC,CAC/E,CAAC;QACJ,CAAC;QAED,YAAY,CAAC,OAA4B;YACvC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAuC,uBAAuB,EAAE,OAAO,CAAC,CAAC;QAC1G,CAAC;QAED,cAAc,CAAC,OAA+B;YAC5C,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,sCAAsC,EACtC,OAAO,CACR,CAAC;QACJ,CAAC;QAED,aAAa,CAAC,OAA6B;YACzC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAwC,yBAAyB,EAAE,OAAO,CAAC,CAAC;QAC7G,CAAC;QAED,WAAW,CAAC,OAAuB;YACjC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAkC,uBAAuB,EAAE,OAAO,CAAC,CAAC;QACrG,CAAC;QAED,kBAAkB,CAAC,OAAe;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAW,iCAAiC,OAAO,EAAE,CAAC,CAAC;QACvF,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/Endpoints/syncjob-endpoints.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.syncjobEndpoints = void 0;
+exports.syncjobEndpoints = syncjobEndpoints;
 function syncjobEndpoints(bind) {
     return {
         getAll() {
@@ -14,8 +14,7 @@ function syncjobEndpoints(bind) {
         },
         delete(payload) {
             return bind.requestFactory.post('/api/v1/delete/syncjob', payload.items);
-        }
+        },
     };
 }
-exports.syncjobEndpoints = syncjobEndpoints;
 //# sourceMappingURL=syncjob-endpoints.js.map

package/dist/Endpoints/syncjob-endpoints.js.map

@@ -1 +1 @@
-{"version":3,"file":"syncjob-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/syncjob-endpoints.ts"],"names":[],"mappings":";;;AA4BA,SAAgB,gBAAgB,CAAC,IAAmB;IAClD,OAAO;QACL,MAAM;YACJ,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAC5B,iCAAiC,CAClC,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,OAA2B;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,qBAAqB,EACrB,OAAO,CACR,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,OAA6B;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,sBAAsB,EACtB,OAAO,CACR,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,OAA6B;YAClC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAC7B,wBAAwB,EACxB,OAAO,CAAC,KAAK,CACd,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AA1BD,4CA0BC"}
+{"version":3,"file":"syncjob-endpoints.js","sourceRoot":"","sources":["../../src/Endpoints/syncjob-endpoints.ts"],"names":[],"mappings":";;AA4BA,4CAeC;AAfD,SAAgB,gBAAgB,CAAC,IAAmB;IAClD,OAAO;QACL,MAAM;YACJ,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAY,iCAAiC,CAAC,CAAC;QAC/E,CAAC;QACD,MAAM,CAAC,OAA2B;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAsC,qBAAqB,EAAE,OAAO,CAAC,CAAC;QACvG,CAAC;QACD,IAAI,CAAC,OAA6B;YAChC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAwC,sBAAsB,EAAE,OAAO,CAAC,CAAC;QAC1G,CAAC;QACD,MAAM,CAAC,OAA6B;YAClC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAA4B,wBAAwB,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QACtG,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -10,6 +10,7 @@ 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';
 /**
  * Class containing all the logic to interface with the Mailcow API in TypeScript.
  * @external
@@ -24,10 +25,10 @@ declare class MailcowClient {
      */
     readonly API_KEY: string;
     /**
-     * The headers used for every request.
+     * The request config used for every request.
      * @internal
      */
-    HEADERS: AxiosRequestConfig;
+    AXIOS_CONFIG: AxiosRequestConfig;
     /**
      * Creates a MailcowClient using the given URL and API key.
      * @param BASE_URL - The base URL of the Mailcow API.
@@ -76,6 +77,12 @@ declare class MailcowClient {
      * @external
      */
     forwardingHosts: ForwardingEndpoints;
+    /**
+     * All endpoints related to address rewriting.
+     * See {@link AdressRewritingEndpoints}
+     * @external
+     */
+    addressRewriting: AdressRewritingEndpoints;
     /**
      * All endpoints related to logs.
      * See {@link LogEndpoints}