ts-mailcow-api 1.5.0 → 1.6.0

package/dist/endpoints/quarantine-endpoints.d.ts

@@ -1,4 +1,4 @@
-import { DeleteQuarantineRequest, MailcowResponse, QuarantineItem } from '../types';
+import { DeleteQuarantineRequest, EditQuarantineItemRequest, MailcowResponse, QuarantineItem } from '../types';
 import MailcowClient from '../index';
 /**
  * Interface for all Quarantine endpoints related to email handling in Mailcow.
@@ -10,6 +10,13 @@ export interface QuarantineEndpoints {
      * @returns A promise that resolves to the Mailcow API response indicating success or failure.
      */
     delete(payload: DeleteQuarantineRequest): Promise<MailcowResponse>;
+    /**
+     * Acts on quarantined emails: release them to the recipient's inbox
+     * or learn them as ham to improve future Rspamd filtering.
+     * @param payload - The IDs to act on and the action to take.
+     * @returns A promise that resolves to the Mailcow API response indicating success or failure.
+     */
+    edit(payload: EditQuarantineItemRequest): Promise<MailcowResponse>;
     /**
      * Retrieves all emails currently held in quarantine.
      * @returns A promise that resolves to an array of `QuarantineItem` representing each quarantined email.

package/dist/endpoints/quarantine-endpoints.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.quarantineEndpoints = quarantineEndpoints;
 const QUARANTINE_ENDPOINTS = {
     DELETE: 'delete/qitem',
+    EDIT: 'edit/qitem',
     GET: 'get/quarantine/all',
 };
 /**
@@ -15,6 +16,9 @@ function quarantineEndpoints(bind) {
         delete(payload) {
             return bind.requestFactory.post(QUARANTINE_ENDPOINTS.DELETE, payload.items);
         },
+        edit(payload) {
+            return bind.requestFactory.post(QUARANTINE_ENDPOINTS.EDIT, payload);
+        },
         get() {
             return bind.requestFactory.get(QUARANTINE_ENDPOINTS.GET);
         },

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

@@ -1 +1 @@
-{"version":3,"file":"quarantine-endpoints.js","sourceRoot":"","sources":["../../src/endpoints/quarantine-endpoints.ts"],"names":[],"mappings":";;AA+BA,kDASC;AAnBD,MAAM,oBAAoB,GAAG;IAC3B,MAAM,EAAE,cAAc;IACtB,GAAG,EAAE,oBAAoB;CAC1B,CAAC;AAEF;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,IAAmB;IACrD,OAAO;QACL,MAAM,CAAC,OAAgC;YACrC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAA4B,oBAAoB,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QACzG,CAAC;QACD,GAAG;YACD,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAmB,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC7E,CAAC;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"quarantine-endpoints.js","sourceRoot":"","sources":["../../src/endpoints/quarantine-endpoints.ts"],"names":[],"mappings":";;AAwCA,kDAYC;AAvBD,MAAM,oBAAoB,GAAG;IAC3B,MAAM,EAAE,cAAc;IACtB,IAAI,EAAE,YAAY;IAClB,GAAG,EAAE,oBAAoB;CAC1B,CAAC;AAEF;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,IAAmB;IACrD,OAAO;QACL,MAAM,CAAC,OAAgC;YACrC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAA4B,oBAAoB,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QACzG,CAAC;QACD,IAAI,CAAC,OAAkC;YACrC,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAA6C,oBAAoB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAClH,CAAC;QACD,GAAG;YACD,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAmB,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC7E,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/types.d.ts

@@ -1687,6 +1687,33 @@ export interface DeleteQuarantineRequest {
      */
     items: number[];
 }
+/**
+ * Action to take on a quarantined email via `edit/qitem`.
+ *
+ * - `release` -- deliver the email to the original recipient's inbox.
+ * - `learnham` -- mark the email as ham and feed it back to Rspamd as
+ *   a training sample. Useful for false positives.
+ *
+ * The quarantine queue is already presumed-spam by definition, so there
+ * is no `learnspam` counterpart -- Mailcow does not document one.
+ */
+export type QuarantineItemAction = 'release' | 'learnham';
+/**
+ * Request payload for `edit/qitem`.
+ *
+ * The `items` array holds the IDs of the quarantined messages to act
+ * on; the same `attr.action` is applied to every entry.
+ */
+export interface EditQuarantineItemRequest {
+    /**
+     * IDs of the quarantined messages to act on. Get them from
+     * `mcc.quarantine.get()`.
+     */
+    items: number[];
+    attr: {
+        action: QuarantineItemAction;
+    };
+}
 /**
  * Request payload to edit rate limits for specified domains.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-mailcow-api",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "TypeScript wrapper for the mailcow API.",
   "scripts": {
     "test": "ts-mocha \"test/**/*.test.ts\"",