ts-mailcow-api 0.7.0 → 0.8.2

package/dist/types.d.ts

@@ -9,7 +9,7 @@ export interface BaseDomainAttributes {
     /**
      * The language code associated with this domain.
      */
-    lang: "sk" | "cs" | "de" | "en" | "es" | "fr" | "lv" | "nl" | "pl" | "pt" | "ru" | "it" | "ca";
+    lang: 'sk' | 'cs' | 'de' | 'en' | 'es' | 'fr' | 'lv' | 'nl' | 'pl' | 'pt' | 'ru' | 'it' | 'ca';
     /**
      * Boolean if the domain is active.
      */
@@ -296,9 +296,9 @@ export interface SpamPolicy {
  */
 export interface BaseMailboxAttributes {
     /**
-     * Boolean if the mailbox is active.
+     * Integer representing if the mailbox is active (allows for custom states).
      */
-    active: boolean;
+    active: number;
     /**
      * Boolean if the user is forced to update their password on login.
      */
@@ -504,7 +504,7 @@ export interface Mailbox {
     /**
      * Class representation of quota usage.
      */
-    percent_class: "success" | "warning" | "danger";
+    percent_class: 'success' | 'warning' | 'danger';
     /**
      * Maximum possible quota.
      */
@@ -767,7 +767,7 @@ export interface SyncjobAttributes {
     /**
      * The encryption method used to connect to the mailserver.
      */
-    enc1: "TLS" | "SSL" | "PLAIN";
+    enc1: 'TLS' | 'SSL' | 'PLAIN';
     /**
      * The interval in which messages should be synced.
      */
@@ -860,37 +860,427 @@ export interface SyncjobUpdateRequest {
  * Sync job as returned by the Mailcow API.
  */
 export interface Syncjob {
+    /**
+     * Enables or disables the sync job.
+     */
     active: boolean;
+    /**
+     * MD5 hash of the authentication.
+     */
     authmd51: boolean;
-    authmech1: "TLS" | "SSL" | "PLAIN";
+    /**
+     * Authentication mechanism.
+     */
+    authmech1: 'TLS' | 'SSL' | 'PLAIN';
+    /**
+     * Try to automap folders ("sent items", "sent" => "sent" etc.) (--automap).
+     */
     automap: boolean;
+    /**
+     * Creation date in epoch.
+     */
     created: string;
+    /**
+     * Custom parameters.
+     */
     custom_params: string;
+    /**
+     * Delete from source when completed (--delete1).
+     */
     delete1: boolean;
+    /**
+     * Delete messages on destination that are not on source (--delete2).
+     */
     delete2: boolean;
+    /**
+     * Delete duplicates on destination (--delete2duplicates).
+     */
     delete2duplicates: boolean;
+    /**
+     * Target domain.
+     */
     domain2: string;
-    enc1: "TLS" | "SSL" | "PLAIN";
+    /**
+     * The encryption method used to connect to the mailserver.
+     */
+    enc1: 'TLS' | 'SSL' | 'PLAIN';
+    /**
+     * Exclude objects (regex).
+     */
     exclude: string;
+    /**
+     * The smtp server where mails should be synced from.
+     */
     host1: string;
+    /**
+     * ID of the sync job.
+     */
     id: number;
+    /**
+     * If the sync job is currently running.
+     */
     is_running: boolean;
+    /**
+     * Date of the last run.
+     */
     last_run: string;
+    /**
+     * Logfile
+     */
     log: string;
+    /**
+     * Only sync messages up to this age in days.
+     */
     maxage: number;
+    /**
+     * Max speed transfer limit for the sync.
+     */
     maxbytespersecond: number;
+    /**
+     * The interval in which messages should be synced.
+     */
     mins_interval: number;
-    modified: string;
+    /**
+     * Last modified date of the sync job..
+     */
+    modified: string | null;
+    /**
+     * Port of the source server.
+     */
     port1: number;
+    /**
+     * Regex.
+     */
     regextrans2: string;
+    /**
+     * If cross duplicates should be skipped.
+     */
     skipcrossduplicates: boolean;
+    /**
+     * Subfolder on target server.
+     */
     subfolder2: string;
+    /**
+     * If the sync job is subscribed to all mailboxes.
+     */
     subscribeall: boolean;
+    /**
+     * Timeout for connection to remote host.
+     */
     timeout1: number;
+    /**
+     * Timeout for connection to local host.
+     */
     timeout2: number;
+    /**
+     * User on the remote host.
+     */
     user1: string;
+    /**
+     * User on the local host.
+     */
     user2: string;
 }
+/**
+ * Forwarding host creation payload.
+ */
+export interface ForwardingCreateRequest {
+    /**
+     * True to enable spam filter, false to disable spam filter.
+     */
+    filter_spam: boolean;
+    /**
+     * Contains the hostname you want to add.
+     */
+    hostname: string;
+}
+/**
+ * Forwarding host deletion payload.
+ */
+export interface ForwardingDeleteRequest {
+    /**
+     * IPs of the forwarding hosts to delete.
+     */
+    items: string[];
+}
+/**
+ * Forwarding host as returned by the Mailcow API.
+ */
+export interface ForwardingHost {
+    /**
+     * IP of the forwarding host.
+     */
+    host: string;
+    /**
+     * If the host keeps or discards spam.
+     */
+    keep_spam: 'yes' | 'no';
+    /**
+     * Hostname.
+     */
+    source: string;
+}
+/**
+ * Base Log interface
+ */
+export interface Log {
+    /**
+     * Timestamp in Epoch format.
+     */
+    time: number;
+}
+export interface ACMELog extends Log {
+    /**
+     * Log message.
+     */
+    message: string;
+}
+/**
+ * API Log item.
+ */
+export interface APILog extends Log {
+    /**
+     * Payload used in the API call.
+     */
+    data: string;
+    /**
+     * Request method.
+     */
+    method: 'GET' | 'POST';
+    /**
+     * IP that did the call.
+     */
+    remote: string;
+    /**
+     * API Route used.
+     */
+    uri: string;
+}
+/**
+ * Autodiscover log item.
+ */
+export interface ADLog extends Log {
+    /**
+     * Service used.
+     */
+    service: string;
+    /**
+     * User agent.
+     */
+    ua: string;
+    /**
+     * The user.
+     */
+    user: string;
+}
+/**
+ * Dovecot log item.
+ */
+export interface DCLog extends Log {
+    /**
+     * The dovecot log message.
+     */
+    message: string;
+    /**
+     * The dovecot priority level.
+     */
+    priority: string;
+    /**
+     * Program used.
+     */
+    program: string;
+}
+/**
+ * Netfilter log item.
+ */
+export interface NFLog extends Log {
+    /**
+     * The netfilter message.
+     */
+    message: string;
+    /**
+     * The netfilter priority level.
+     */
+    priority: string;
+}
+/**
+ * Postfix log item.
+ */
+export interface PFLog extends Log {
+    /**
+     * The Postfix log message.
+     */
+    message: string;
+    /**
+     * The Postfix priority level.
+     */
+    priority: string;
+    /**
+     * Program used.
+     */
+    program: string;
+}
+/**
+ * Ratelimited log item.
+ */
+export interface RLLog extends Log {
+    /**
+     * From email adress.
+     */
+    from: string;
+    /**
+     * Header of the from field.
+     */
+    header_from: string;
+    /**
+     * Header of the subject field.
+     */
+    header_subject: string;
+    /**
+     * IP of the sender.
+     */
+    ip: string;
+    /**
+     * ID of the message.
+     */
+    message_id: string;
+    /**
+     * QID of the message.
+     */
+    qid: string;
+    /**
+     * Recipient of the message.
+     */
+    rcpt: string;
+    /**
+     * Ratelimit hash.
+     */
+    rl_hash: string;
+    /**
+     * Ratelimit info
+     */
+    rl_info: string;
+    /**
+     * Ratelimit name
+     */
+    rl_name: string;
+    /**
+     * Sender of the message.
+     */
+    user: string;
+}
+/**
+ * Rspamd log item.
+ */
+export interface RSLog extends Log {
+    /**
+     * What happend to the message.
+     */
+    action: string;
+    /**
+     * Size of the message.
+     */
+    size: string;
+    /**
+     * Array of recipients SMTPs.
+     */
+    rcpt_smtp: string[];
+    /**
+     * Array of recipients MIME.
+     */
+    rcpt_mime: string[];
+    /**
+     * Object containing all the Rspamd scoring info.
+     */
+    symbols: object;
+    /**
+     * Score needed to pass.
+     */
+    required_score: string;
+    /**
+     * Message ID
+     */
+    'message-id': string;
+    /**
+     * IP of the sender
+     */
+    ip: string;
+    /**
+     * Name of the user
+     */
+    user: string;
+    /**
+     * Time used.
+     */
+    time_real: string;
+    /**
+     * SMTP of the receiver.
+     */
+    sender_smtp: string;
+    /**
+     * If the message was skipped.
+     */
+    is_skipped: boolean;
+    /**
+     * Score of the message
+     */
+    score: number;
+    /**
+     * MIME of the sender.
+     */
+    sender_mime: string;
+    /**
+     * EPOCH time stamp.
+     */
+    unix_time: number;
+    /**
+     * Subject of the e-mail.
+     */
+    subject: string;
+}
+/**
+ * SOGo log item.
+ */
+export interface SGLog extends Log {
+    /**
+     * The log message.
+     */
+    message: string;
+    /**
+     * The priority level.
+     */
+    priority: string;
+    program: 'sogod';
+}
+/**
+ * Watchdog log item.
+ */
+export interface WDLog extends Log {
+    /**
+     * Difference with previous health.
+     */
+    hpdiff: number;
+    /**
+     * Current health
+     */
+    hpnow: number;
+    /**
+     * Total health.
+     */
+    hptotal: number;
+    /**
+     * Level of the service
+     */
+    lvl: number;
+    /**
+     * Service being watched
+     */
+    service: string;
+    /**
+     * Time of report in Epoch.
+     */
+    time: number;
+}
 /**
  * Error class used for exception handling.
  */

package/dist/types.js

@@ -1,10 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MailcowException = void 0;
-;
-;
-;
-;
 /**
  * Error class used for exception handling.
  */

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAkDC,CAAC;AAyRD,CAAC;AA8CD,CAAC;AAgUD,CAAC;AAqPF;;GAEG;AACH,MAAa,gBAAiB,SAAQ,KAAK;CAK1C;AALD,4CAKC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAi1CA;;GAEG;AACH,MAAa,gBAAiB,SAAQ,KAAK;CAK1C;AALD,4CAKC"}

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "ts-mailcow-api",
-  "version": "0.7.0",
+  "version": "0.8.2",
   "description": "TypeScript wrapper for the mailcow API.",
   "scripts": {
     "test": "ts-mocha ./test/**/*.test.ts",
     "lint": "eslint --fix ./src/**/*.ts",
+    "quick": "ts-node ./src/custom.ts",
     "docs": "typedoc",
     "build": "tsc",
     "prepare": "tsc",

package/src/Endpoints/forwarding-endpoints.ts

@@ -0,0 +1,51 @@
+import MailcowClient from '../index';
+import { ForwardingCreateRequest, ForwardingDeleteRequest, ForwardingHost, MailcowResponse } from '../types';
+
+/**
+ * Interface for all Forwarding Hosts endpoints.
+ */
+export interface ForwardingEndpoints {
+  /**
+   * Endpoint for deleting forwarding host.
+   * @param payload - The deletion payload
+   */
+  delete(payload: ForwardingDeleteRequest): Promise<MailcowResponse>
+
+  /**
+   * Endpoint for creating forwarding host.
+   * @param payload - The creation payload
+   */
+  create(payload: ForwardingCreateRequest): Promise<MailcowResponse>
+
+  /**
+   * Endpoint for getting all forwarding host.
+   */
+  getAll(): Promise<ForwardingHost[]>
+}
+
+/**
+ * Binder function between the MailcowClient class and the ForwardingEndpoints.
+ * @param bind - The MailcowClient to bind.
+ * @internal
+ */
+export function forwardingEndpoints(bind: MailcowClient): ForwardingEndpoints {
+  return {
+    delete(payload: ForwardingDeleteRequest): Promise<MailcowResponse> {
+      return bind.requestFactory.post<MailcowResponse>(
+        '/api/v1/delete/fwdhost',
+        payload.items
+      );
+    },
+    create(payload: ForwardingCreateRequest): Promise<MailcowResponse> {
+      return bind.requestFactory.post<MailcowResponse>(
+        '/api/v1/add/fwdhost',
+        payload
+      );
+    },
+    getAll(): Promise<ForwardingHost[]> {
+      return bind.requestFactory.get<ForwardingHost[]>(
+        '/api/v1/get/fwdhost/all'
+      );
+    }
+  };
+}

package/src/Endpoints/log-endpoints.ts

@@ -0,0 +1,130 @@
+import MailcowClient from '../index';
+import {
+  ACMELog,
+  ADLog,
+  APILog,
+  DCLog,
+  NFLog,
+  PFLog,
+  RLLog,
+  RSLog,
+  SGLog,
+  WDLog
+} from '../types';
+
+export interface LogEndpoints {
+  /**
+   * Endpoint for returning ACME Logs.
+   * @param count - The number of logs to return.
+   */
+  acme(count: number): Promise<ACMELog[]>;
+
+  /**
+   * Endpoint for returning API Logs.
+   * @param count - The number of logs to return.
+   */
+  api(count: number): Promise<APILog[]>;
+
+  /**
+   * Endpoint for returning Autodiscover Logs.
+   * @param count - The number of logs to return.
+   */
+  autodiscover(count: number): Promise<ADLog[]>;
+
+  /**
+   * Endpoint for returning dovecot Logs.
+   * @param count - The number of logs to return.
+   */
+  dovecot(count: number): Promise<DCLog[]>;
+
+  /**
+   * Endpoint for returning Netfilter Logs.
+   * @param count - The number of logs to return.
+   */
+  netfilter(count: number): Promise<NFLog[]>;
+
+  /**
+   * Endpoint for returning Postfix Logs.
+   * @param count - The number of logs to return.
+   */
+  postfix(count: number): Promise<PFLog[]>;
+
+  /**
+   * Endpoint for returning Rate limited Logs.
+   * @param count - The number of logs to return.
+   */
+  ratelimited(count: number): Promise<RLLog[]>;
+
+  /**
+   * Endpoint for returning Rspamd Logs.
+   * @param count - The number of logs to return.
+   */
+  rspamd(count: number): Promise<RSLog[]>;
+
+  /**
+   * Endpoint for returning SOGo Logs.
+   * @param count - The number of logs to return.
+   */
+  sogo(count: number): Promise<SGLog[]>;
+
+  /**
+   * Endpoint for returning Watchdog Logs.
+   * @param count - The number of logs to return.
+   */
+  watchdog(count: number): Promise<WDLog[]>;
+}
+
+export function logEndpoints(bind: MailcowClient): LogEndpoints {
+  return {
+    acme(count: number): Promise<ACMELog[]> {
+      return bind.requestFactory.get<ACMELog[]>(
+        `/api/v1/get/logs/acme/${count}`
+      );
+    },
+    api(count: number): Promise<APILog[]> {
+      return bind.requestFactory.get<APILog[]>(
+        `/api/v1/get/logs/api/${count}`
+      );
+    },
+    autodiscover(count: number): Promise<ADLog[]> {
+      return bind.requestFactory.get<ADLog[]>(
+        `/api/v1/get/logs/autodiscover/${count}`
+      );
+    },
+    dovecot(count: number): Promise<DCLog[]> {
+      return bind.requestFactory.get<DCLog[]>(
+        `/api/v1/get/logs/dovecot/${count}`
+      );
+    },
+    netfilter(count: number): Promise<NFLog[]> {
+      return bind.requestFactory.get<NFLog[]>(
+        `/api/v1/get/logs/netfilter/${count}`
+      );
+    },
+    postfix(count: number): Promise<PFLog[]> {
+      return bind.requestFactory.get<PFLog[]>(
+        `/api/v1/get/logs/postfix/${count}`
+      );
+    },
+    ratelimited(count: number): Promise<RLLog[]> {
+      return bind.requestFactory.get<RLLog[]>(
+        `/api/v1/get/logs/ratelimited/${count}`
+      );
+    },
+    rspamd(count: number): Promise<RSLog[]> {
+      return bind.requestFactory.get<RSLog[]>(
+        `/api/v1/get/logs/rspamd-history/${count}`
+      );
+    },
+    sogo(count: number): Promise<SGLog[]> {
+      return bind.requestFactory.get<SGLog[]>(
+        `/api/v1/get/logs/sogo/${count}`
+      );
+    },
+    watchdog(count: number): Promise<WDLog[]> {
+      return bind.requestFactory.get<WDLog[]>(
+        `/api/v1/get/logs/watchdog/${count}`
+      );
+    }
+  };
+}

package/src/Endpoints/mailbox-endpoint.ts

@@ -10,7 +10,7 @@ import {
   SpamScoreEditRequest
 } from '../types';
 import MailcowClient from '../index';
-import { wrapPromiseToArray } from "../request-factory";
+import { wrapPromiseToArray } from '../request-factory';
 
 /**
  * Interface for all Mailbox endpoints.