mailpit-api 1.0.2-beta → 1.0.2-beta.3

package/dist/{MailpitClient.d.ts → cjs/index.d.ts}

@@ -1,4 +1,4 @@
-interface MailpitInfo {
+export interface MailpitInfo {
     Database: string;
     DatabaseSize: number;
     LatestVersion: string;
@@ -18,7 +18,7 @@ interface MailpitInfo {
     Unread: number;
     Version: string;
 }
-interface MailpitConfiguration {
+export interface MailpitConfiguration {
     DuplicatesIgnored: boolean;
     Label: string;
     SpamAssassin: boolean;
@@ -29,7 +29,7 @@ interface MailpitConfiguration {
         SMTPServer: string;
     };
 }
-interface MailpitMessageSummary {
+export interface MailpitMessageSummary {
     Attachments: [
         {
             ContentID: string;
@@ -86,13 +86,13 @@ interface MailpitMessageSummary {
         }
     ];
 }
-interface MailpitMessagesSummary {
+export interface MailpitMessagesSummary {
     messages: [MailpitMessageSummary];
 }
-interface MailpitMessageHeaders {
+export interface MailpitMessageHeaders {
     [key: string]: string;
 }
-interface MailpitSendRequest {
+export interface MailpitSendRequest {
     Attachments: [
         {
             Content: string;
@@ -130,10 +130,10 @@ interface MailpitSendRequest {
         }
     ];
 }
-interface MailpitSendMessageConfirmation {
+export interface MailpitSendMessageConfirmation {
     ID: string;
 }
-interface MailpitHTMLCheckResponse {
+export interface MailpitHTMLCheckResponse {
     Platforms: {
         [key: string]: [string];
     };
@@ -175,7 +175,7 @@ interface MailpitHTMLCheckResponse {
         }
     ];
 }
-interface MailpitLinkCheckResponse {
+export interface MailpitLinkCheckResponse {
     Errors: number;
     Links: [
         {
@@ -185,7 +185,7 @@ interface MailpitLinkCheckResponse {
         }
     ];
 }
-interface MailpitSpamAssassinResponse {
+export interface MailpitSpamAssassinResponse {
     Errors: number;
     IsSpam: boolean;
     Rules: [
@@ -197,32 +197,28 @@ interface MailpitSpamAssassinResponse {
     ];
     Score: number;
 }
-interface MailpitReadStatusRequest {
+export interface MailpitReadStatusRequest {
     IDs: [string];
     Read: boolean;
 }
-interface MailpitDeleteRequest {
+export interface MailpitDeleteRequest {
     IDs: [string];
 }
-interface MailpitSearch {
-    query: {
-        [key: string]: string;
-    };
-    start?: number;
-    limit?: number;
-    tz?: string;
+export interface MailpitSearch {
+    query: string;
+    start: number;
+    limit: number;
+    tz: string;
 }
-interface MailpitSearchDelete {
-    query: {
-        [key: string]: string;
-    };
-    tz?: string;
+export interface MailpitSearchDelete {
+    query: string;
+    tz: string;
 }
-interface MailpitSetTagsRequest {
+export interface MailpitSetTagsRequest {
     IDs: [string];
     Tags: [string];
 }
-declare class MailpitClient {
+export declare class MailpitClient {
     private axiosInstance;
     constructor(baseURL: string);
     private handleRequest;
@@ -252,4 +248,3 @@ declare class MailpitClient {
     renderMessageHTML(id: string): Promise<string>;
     renderMessageText(id: string): Promise<string>;
 }
-export default MailpitClient;

package/dist/cjs/index.js

@@ -0,0 +1,182 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MailpitClient = void 0;
+const axios_1 = __importDefault(require("axios"));
+class MailpitClient {
+    constructor(baseURL) {
+        this.axiosInstance = axios_1.default.create({
+            baseURL: baseURL,
+            validateStatus: function (status) {
+                return status === 200;
+            },
+        });
+    }
+    handleRequest(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield request();
+                return response.data;
+            }
+            catch (error) {
+                if (axios_1.default.isAxiosError(error)) {
+                    if (error.response) {
+                        // Server responded with a status other than 2xx
+                        throw new Error(`Mailpit API Error: ${error.response.status} ${error.response.statusText}: ${JSON.stringify(error.response.data)}`);
+                    }
+                    else if (error.request) {
+                        // Request was made but no response was received
+                        throw new Error("Mailpit API Error: No response received from server.");
+                    }
+                    else {
+                        // Something happened in setting up the request
+                        throw new Error(`Mailpit API Error: ${error.message}`);
+                    }
+                }
+                else {
+                    throw new Error("Unexpected Error: " + error);
+                }
+            }
+        });
+    }
+    // Message
+    getInfo() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.get("/api/v1/info"));
+        });
+    }
+    getConfiguration() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.get("/api/v1/webui"));
+        });
+    }
+    getMessageSummary(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}`));
+        });
+    }
+    getMessageHeaders(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/headers`));
+        });
+    }
+    getMessageAttachment(id, partID) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/part/${partID}`));
+        });
+    }
+    getMessageSource(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/raw`));
+        });
+    }
+    getAttachmentThumbnail(id, partID) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/part/${partID}/thumb`));
+        });
+    }
+    releaseMessage(id, releaseRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.post(`/api/v1/message/${id}/release`, releaseRequest));
+        });
+    }
+    sendMessage(sendReqest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.post(`/api/v1/send`, sendReqest));
+        });
+    }
+    // Other
+    htmlCheck(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/html-check`));
+        });
+    }
+    linkCheck(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/link-check`));
+        });
+    }
+    spamAssassinCheck(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/sa-check`));
+        });
+    }
+    // Messages
+    listMessages() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.get(`/api/v1/messages`));
+        });
+    }
+    setReadStatus(readStatus) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.put(`/api/v1/messages`, readStatus));
+        });
+    }
+    deleteMessages(deleteRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.delete(`/api/v1/messages`, {
+                data: deleteRequest,
+            }));
+        });
+    }
+    // See https://mailpit.axllent.org/docs/usage/search-filters/
+    searchMessages(search) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.put(`/api/v1/search`, search));
+        });
+    }
+    // See https://mailpit.axllent.org/docs/usage/search-filters/
+    deleteMessagesBySearch(search) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.delete(`/api/v1/search`, { data: search }));
+        });
+    }
+    // Tags
+    getTags() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.get(`/api/v1/tags`));
+        });
+    }
+    setTags(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.put(`/api/v1/tags`, request));
+        });
+    }
+    renameTag(tag, newTagName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const encodedTag = encodeURI(tag);
+            return this.handleRequest(() => this.axiosInstance.put(`/api/v1/tags/${encodedTag}`, {
+                Name: newTagName,
+            }));
+        });
+    }
+    deleteTag(tag) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const encodedTag = encodeURI(tag);
+            return this.handleRequest(() => this.axiosInstance.delete(`/api/v1/tags/${encodedTag}`));
+        });
+    }
+    // Testing
+    renderMessageHTML(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.get(`/view/${id}.html`));
+        });
+    }
+    renderMessageText(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.handleRequest(() => this.axiosInstance.get(`/view/${id}.txt`));
+        });
+    }
+}
+exports.MailpitClient = MailpitClient;

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "commonjs"
+}

package/{src/MailpitClient.ts → dist/mjs/index.d.ts}

@@ -1,4 +1,4 @@
-interface MailpitInfo {
+export interface MailpitInfo {
     Database: string;
     DatabaseSize: number;
     LatestVersion: string;
@@ -18,7 +18,7 @@ interface MailpitInfo {
     Unread: number;
     Version: string;
 }
-interface MailpitConfiguration {
+export interface MailpitConfiguration {
     DuplicatesIgnored: boolean;
     Label: string;
     SpamAssassin: boolean;
@@ -29,7 +29,7 @@ interface MailpitConfiguration {
         SMTPServer: string;
     };
 }
-interface MailpitMessageSummary {
+export interface MailpitMessageSummary {
     Attachments: [
         {
             ContentID: string;
@@ -86,13 +86,13 @@ interface MailpitMessageSummary {
         }
     ];
 }
-interface MailpitMessagesSummary {
+export interface MailpitMessagesSummary {
     messages: [MailpitMessageSummary];
 }
-interface MailpitMessageHeaders {
+export interface MailpitMessageHeaders {
     [key: string]: string;
 }
-interface MailpitSendRequest {
+export interface MailpitSendRequest {
     Attachments: [
         {
             Content: string;
@@ -130,10 +130,10 @@ interface MailpitSendRequest {
         }
     ];
 }
-interface MailpitSendMessageConfirmation {
+export interface MailpitSendMessageConfirmation {
     ID: string;
 }
-interface MailpitHTMLCheckResponse {
+export interface MailpitHTMLCheckResponse {
     Platforms: {
         [key: string]: [string];
     };
@@ -175,7 +175,7 @@ interface MailpitHTMLCheckResponse {
         }
     ];
 }
-interface MailpitLinkCheckResponse {
+export interface MailpitLinkCheckResponse {
     Errors: number;
     Links: [
         {
@@ -185,7 +185,7 @@ interface MailpitLinkCheckResponse {
         }
     ];
 }
-interface MailpitSpamAssassinResponse {
+export interface MailpitSpamAssassinResponse {
     Errors: number;
     IsSpam: boolean;
     Rules: [
@@ -197,32 +197,28 @@ interface MailpitSpamAssassinResponse {
     ];
     Score: number;
 }
-interface MailpitReadStatusRequest {
+export interface MailpitReadStatusRequest {
     IDs: [string];
     Read: boolean;
 }
-interface MailpitDeleteRequest {
+export interface MailpitDeleteRequest {
     IDs: [string];
 }
-interface MailpitSearch {
-    query: {
-        [key: string]: string;
-    };
-    start?: number;
-    limit?: number;
-    tz?: string;
+export interface MailpitSearch {
+    query: string;
+    start: number;
+    limit: number;
+    tz: string;
 }
-interface MailpitSearchDelete {
-    query: {
-        [key: string]: string;
-    };
-    tz?: string;
+export interface MailpitSearchDelete {
+    query: string;
+    tz: string;
 }
-interface MailpitSetTagsRequest {
+export interface MailpitSetTagsRequest {
     IDs: [string];
     Tags: [string];
 }
-declare class MailpitClient {
+export declare class MailpitClient {
     private axiosInstance;
     constructor(baseURL: string);
     private handleRequest;
@@ -252,4 +248,3 @@ declare class MailpitClient {
     renderMessageHTML(id: string): Promise<string>;
     renderMessageText(id: string): Promise<string>;
 }
-export default MailpitClient;

package/dist/mjs/index.js

@@ -0,0 +1,119 @@
+import axios from "axios";
+export class MailpitClient {
+    axiosInstance;
+    constructor(baseURL) {
+        this.axiosInstance = axios.create({
+            baseURL: baseURL,
+            validateStatus: function (status) {
+                return status === 200;
+            },
+        });
+    }
+    async handleRequest(request) {
+        try {
+            const response = await request();
+            return response.data;
+        }
+        catch (error) {
+            if (axios.isAxiosError(error)) {
+                if (error.response) {
+                    // Server responded with a status other than 2xx
+                    throw new Error(`Mailpit API Error: ${error.response.status} ${error.response.statusText}: ${JSON.stringify(error.response.data)}`);
+                }
+                else if (error.request) {
+                    // Request was made but no response was received
+                    throw new Error("Mailpit API Error: No response received from server.");
+                }
+                else {
+                    // Something happened in setting up the request
+                    throw new Error(`Mailpit API Error: ${error.message}`);
+                }
+            }
+            else {
+                throw new Error("Unexpected Error: " + error);
+            }
+        }
+    }
+    // Message
+    async getInfo() {
+        return this.handleRequest(() => this.axiosInstance.get("/api/v1/info"));
+    }
+    async getConfiguration() {
+        return this.handleRequest(() => this.axiosInstance.get("/api/v1/webui"));
+    }
+    async getMessageSummary(id) {
+        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}`));
+    }
+    async getMessageHeaders(id) {
+        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/headers`));
+    }
+    async getMessageAttachment(id, partID) {
+        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/part/${partID}`));
+    }
+    async getMessageSource(id) {
+        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/raw`));
+    }
+    async getAttachmentThumbnail(id, partID) {
+        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/part/${partID}/thumb`));
+    }
+    async releaseMessage(id, releaseRequest) {
+        return this.handleRequest(() => this.axiosInstance.post(`/api/v1/message/${id}/release`, releaseRequest));
+    }
+    async sendMessage(sendReqest) {
+        return this.handleRequest(() => this.axiosInstance.post(`/api/v1/send`, sendReqest));
+    }
+    // Other
+    async htmlCheck(id) {
+        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/html-check`));
+    }
+    async linkCheck(id) {
+        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/link-check`));
+    }
+    async spamAssassinCheck(id) {
+        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/sa-check`));
+    }
+    // Messages
+    async listMessages() {
+        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/messages`));
+    }
+    async setReadStatus(readStatus) {
+        return this.handleRequest(() => this.axiosInstance.put(`/api/v1/messages`, readStatus));
+    }
+    async deleteMessages(deleteRequest) {
+        return this.handleRequest(() => this.axiosInstance.delete(`/api/v1/messages`, {
+            data: deleteRequest,
+        }));
+    }
+    // See https://mailpit.axllent.org/docs/usage/search-filters/
+    async searchMessages(search) {
+        return this.handleRequest(() => this.axiosInstance.put(`/api/v1/search`, search));
+    }
+    // See https://mailpit.axllent.org/docs/usage/search-filters/
+    async deleteMessagesBySearch(search) {
+        return this.handleRequest(() => this.axiosInstance.delete(`/api/v1/search`, { data: search }));
+    }
+    // Tags
+    async getTags() {
+        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/tags`));
+    }
+    async setTags(request) {
+        return this.handleRequest(() => this.axiosInstance.put(`/api/v1/tags`, request));
+    }
+    async renameTag(tag, newTagName) {
+        const encodedTag = encodeURI(tag);
+        return this.handleRequest(() => this.axiosInstance.put(`/api/v1/tags/${encodedTag}`, {
+            Name: newTagName,
+        }));
+    }
+    async deleteTag(tag) {
+        const encodedTag = encodeURI(tag);
+        return this.handleRequest(() => this.axiosInstance.delete(`/api/v1/tags/${encodedTag}`));
+    }
+    // Testing
+    async renderMessageHTML(id) {
+        return this.handleRequest(() => this.axiosInstance.get(`/view/${id}.html`));
+    }
+    async renderMessageText(id) {
+        return this.handleRequest(() => this.axiosInstance.get(`/view/${id}.txt`));
+    }
+}

package/dist/mjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "module"
+}

package/package.json

@@ -1,16 +1,22 @@
 {
   "name": "mailpit-api",
-  "version": "1.0.2-beta",
+  "version": "1.0.2-beta.3",
   "description": "A NodeJS client library, written in TypeScript, to interact with the Mailpit API.",
   "repository": {
     "type": "git",
     "url": "https://github.com/mpspahr/mailpit-api.git"
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/mjs/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/mjs/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
   "scripts": {
     "test": "echo \"TODO: Add tests\" && exit 0",
-    "build": "tsc"
+    "build": "rm -fr dist/* && tsc -p tsconfig.json && tsc -p tsconfig-cjs.json && ./fixup_type"
   },
   "keywords": [
     "mailpit-api",
@@ -29,14 +35,16 @@
     "axios": "^1.7.2"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^7.18.0",
-    "@typescript-eslint/parser": "^7.18.0",
-    "typescript-eslint": "^7.18.0",
     "@eslint/js": "^8.57.0",
     "@types/node": "^20.14.10",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
     "eslint": "^8.57.0",
     "globals": "^15.8.0",
+    "jest": "^29.7.0",
     "prettier": "3.3.3",
-    "tsx": "^4.16.2"
+    "tsx": "^4.16.2",
+    "typescript": "^5.5.4",
+    "typescript-eslint": "^7.18.0"
   }
 }

package/src/index.ts

@@ -1,3 +1,465 @@
-import MailpitClient from "./MailpitClient";
+import axios, { AxiosInstance } from "axios";
 
-export { MailpitClient };
+export interface MailpitInfo {
+  Database: string;
+  DatabaseSize: number;
+  LatestVersion: string;
+  Messages: number;
+  RuntimeStats: {
+    Memory: number;
+    MessagesDeleted: number;
+    SMTPAccepted: number;
+    SMTPAcceptedSize: number;
+    SMTPIgnored: number;
+    SMTPRejected: number;
+    Uptime: number;
+  };
+  Tags: {
+    [key: string]: number;
+  };
+  Unread: number;
+  Version: string;
+}
+
+export interface MailpitConfiguration {
+  DuplicatesIgnored: boolean;
+  Label: string;
+  SpamAssassin: boolean;
+  MessageRelay: {
+    AllowedRecipients: string;
+    Enabled: boolean;
+    ReturnPath: string;
+    SMTPServer: string;
+  };
+}
+
+export interface MailpitMessageSummary {
+  Attachments: [
+    {
+      ContentID: string;
+      ContentType: string;
+      FileName: string;
+      PartID: string;
+      Size: number;
+    },
+  ];
+  Bcc: [
+    {
+      Address: string;
+      Name: string;
+    },
+  ];
+  Cc: [
+    {
+      Address: string;
+      Name: string;
+    },
+  ];
+  Date: string;
+  From: {
+    Address: string;
+    Name: string;
+  };
+  HTML: string;
+  ID: string;
+  Inline: [
+    {
+      ContentID: string;
+      ContentType: string;
+      FileName: string;
+      PartID: string;
+      Size: number;
+    },
+  ];
+  MessageID: string;
+  ReplyTo: [
+    {
+      Address: string;
+      Name: string;
+    },
+  ];
+  ReturnPath: string;
+  Size: number;
+  Subject: string;
+  Tags: [string];
+  Text: string;
+  To: [
+    {
+      Address: string;
+      Name: string;
+    },
+  ];
+}
+
+export interface MailpitMessagesSummary {
+  messages: [MailpitMessageSummary];
+}
+
+export interface MailpitMessageHeaders {
+  [key: string]: string;
+}
+
+export interface MailpitSendRequest {
+  Attachments: [
+    {
+      Content: string;
+      Filename: string;
+    },
+  ];
+  Bcc: [string];
+  Cc: [
+    {
+      Email: string;
+      Name: string;
+    },
+  ];
+  From: {
+    Email: string;
+    Name: string;
+  };
+  HTML: string;
+  Headers: {
+    [key: string]: string;
+  };
+  ReplyTo: [
+    {
+      Email: string;
+      Name: string;
+    },
+  ];
+  Subject: string;
+  Tags: [string];
+  Text: string;
+  To: [
+    {
+      Email: string;
+      Name: string;
+    },
+  ];
+}
+
+export interface MailpitSendMessageConfirmation {
+  ID: string;
+}
+
+export interface MailpitHTMLCheckResponse {
+  Platforms: {
+    [key: string]: [string];
+  };
+  Total: {
+    Nodes: number;
+    Partial: number;
+    Supported: number;
+    Tests: number;
+    Unsupported: number;
+  };
+  Warnings: [
+    {
+      Category: "css" | "html";
+      Description: string;
+      Keywords: string;
+      NotesByNumber: {
+        [key: string]: string;
+      };
+      Results: [
+        {
+          Family: string;
+          Name: string;
+          NoteNumber: string;
+          Platform: string;
+          Support: "yes" | "no" | "partial";
+          Version: string;
+        },
+      ];
+      Score: {
+        Found: number;
+        Partial: number;
+        Supported: number;
+        Unsupported: number;
+      };
+      Slug: string;
+      Tags: [string];
+      Title: string;
+      URL: string;
+    },
+  ];
+}
+
+export interface MailpitLinkCheckResponse {
+  Errors: number;
+  Links: [
+    {
+      Status: string;
+      StatusCode: number;
+      URL: string;
+    },
+  ];
+}
+
+export interface MailpitSpamAssassinResponse {
+  Errors: number;
+  IsSpam: boolean;
+  Rules: [
+    {
+      Description: string;
+      Name: string;
+      Score: number;
+    },
+  ];
+  Score: number;
+}
+
+export interface MailpitReadStatusRequest {
+  IDs: [string];
+  Read: boolean;
+}
+
+export interface MailpitDeleteRequest {
+  IDs: [string];
+}
+
+export interface MailpitSearch {
+  query: string;
+  start: number;
+  limit: number;
+  tz: string;
+}
+
+export interface MailpitSearchDelete {
+  query: string;
+  tz: string;
+}
+
+export interface MailpitSetTagsRequest {
+  IDs: [string];
+  Tags: [string];
+}
+
+export class MailpitClient {
+  private axiosInstance: AxiosInstance;
+
+  constructor(baseURL: string) {
+    this.axiosInstance = axios.create({
+      baseURL: baseURL,
+      validateStatus: function (status) {
+        return status === 200;
+      },
+    });
+  }
+
+  private async handleRequest<T>(
+    request: () => Promise<{ data: T }>,
+  ): Promise<T> {
+    try {
+      const response = await request();
+      return response.data;
+    } catch (error) {
+      if (axios.isAxiosError(error)) {
+        if (error.response) {
+          // Server responded with a status other than 2xx
+          throw new Error(
+            `Mailpit API Error: ${error.response.status} ${error.response.statusText}: ${JSON.stringify(error.response.data)}`,
+          );
+        } else if (error.request) {
+          // Request was made but no response was received
+          throw new Error(
+            "Mailpit API Error: No response received from server.",
+          );
+        } else {
+          // Something happened in setting up the request
+          throw new Error(`Mailpit API Error: ${error.message}`);
+        }
+      } else {
+        throw new Error("Unexpected Error: " + error);
+      }
+    }
+  }
+
+  // Message
+  public async getInfo(): Promise<MailpitInfo> {
+    return this.handleRequest(() =>
+      this.axiosInstance.get<MailpitInfo>("/api/v1/info"),
+    );
+  }
+
+  public async getConfiguration(): Promise<MailpitConfiguration> {
+    return this.handleRequest(() =>
+      this.axiosInstance.get<MailpitConfiguration>("/api/v1/webui"),
+    );
+  }
+
+  public async getMessageSummary(id: string): Promise<MailpitMessageSummary> {
+    return this.handleRequest(() =>
+      this.axiosInstance.get<MailpitMessageSummary>(`/api/v1/message/${id}`),
+    );
+  }
+
+  public async getMessageHeaders(id: string): Promise<MailpitMessageHeaders> {
+    return this.handleRequest(() =>
+      this.axiosInstance.get<MailpitMessageHeaders>(
+        `/api/v1/message/${id}/headers`,
+      ),
+    );
+  }
+
+  public async getMessageAttachment(
+    id: string,
+    partID: string,
+  ): Promise<string> {
+    return this.handleRequest(() =>
+      this.axiosInstance.get<string>(`/api/v1/message/${id}/part/${partID}`),
+    );
+  }
+
+  public async getMessageSource(id: string): Promise<string> {
+    return this.handleRequest(() =>
+      this.axiosInstance.get<string>(`/api/v1/message/${id}/raw`),
+    );
+  }
+
+  public async getAttachmentThumbnail(
+    id: string,
+    partID: string,
+  ): Promise<string> {
+    return this.handleRequest(() =>
+      this.axiosInstance.get<string>(
+        `/api/v1/message/${id}/part/${partID}/thumb`,
+      ),
+    );
+  }
+
+  public async releaseMessage(
+    id: string,
+    releaseRequest: { To: string[] },
+  ): Promise<string> {
+    return this.handleRequest(() =>
+      this.axiosInstance.post<string>(
+        `/api/v1/message/${id}/release`,
+        releaseRequest,
+      ),
+    );
+  }
+
+  public async sendMessage(
+    sendReqest: MailpitSendRequest,
+  ): Promise<MailpitSendMessageConfirmation> {
+    return this.handleRequest(() =>
+      this.axiosInstance.post<MailpitSendMessageConfirmation>(
+        `/api/v1/send`,
+        sendReqest,
+      ),
+    );
+  }
+
+  // Other
+  public async htmlCheck(id: string): Promise<MailpitHTMLCheckResponse> {
+    return this.handleRequest(() =>
+      this.axiosInstance.get<MailpitHTMLCheckResponse>(
+        `/api/v1/message/${id}/html-check`,
+      ),
+    );
+  }
+
+  public async linkCheck(id: string): Promise<MailpitLinkCheckResponse> {
+    return this.handleRequest(() =>
+      this.axiosInstance.get<MailpitLinkCheckResponse>(
+        `/api/v1/message/${id}/link-check`,
+      ),
+    );
+  }
+
+  public async spamAssassinCheck(
+    id: string,
+  ): Promise<MailpitSpamAssassinResponse> {
+    return this.handleRequest(() =>
+      this.axiosInstance.get<MailpitSpamAssassinResponse>(
+        `/api/v1/message/${id}/sa-check`,
+      ),
+    );
+  }
+
+  // Messages
+  public async listMessages(): Promise<MailpitMessagesSummary> {
+    return this.handleRequest(() =>
+      this.axiosInstance.get<MailpitMessagesSummary>(`/api/v1/messages`),
+    );
+  }
+
+  public async setReadStatus(
+    readStatus: MailpitReadStatusRequest,
+  ): Promise<string> {
+    return this.handleRequest(() =>
+      this.axiosInstance.put<string>(`/api/v1/messages`, readStatus),
+    );
+  }
+
+  public async deleteMessages(
+    deleteRequest: MailpitDeleteRequest,
+  ): Promise<string> {
+    return this.handleRequest(() =>
+      this.axiosInstance.delete<string>(`/api/v1/messages`, {
+        data: deleteRequest,
+      }),
+    );
+  }
+
+  // See https://mailpit.axllent.org/docs/usage/search-filters/
+  public async searchMessages(
+    search: MailpitSearch,
+  ): Promise<MailpitMessagesSummary> {
+    return this.handleRequest(() =>
+      this.axiosInstance.put<MailpitMessagesSummary>(`/api/v1/search`, search),
+    );
+  }
+
+  // See https://mailpit.axllent.org/docs/usage/search-filters/
+  public async deleteMessagesBySearch(
+    search: MailpitSearchDelete,
+  ): Promise<string> {
+    return this.handleRequest(() =>
+      this.axiosInstance.delete<string>(`/api/v1/search`, { data: search }),
+    );
+  }
+
+  // Tags
+  public async getTags(): Promise<[string]> {
+    return this.handleRequest(() =>
+      this.axiosInstance.get<[string]>(`/api/v1/tags`),
+    );
+  }
+
+  public async setTags(request: MailpitSetTagsRequest): Promise<string> {
+    return this.handleRequest(() =>
+      this.axiosInstance.put<string>(`/api/v1/tags`, request),
+    );
+  }
+
+  public async renameTag(tag: string, newTagName: string): Promise<string> {
+    const encodedTag = encodeURI(tag);
+    return this.handleRequest(() =>
+      this.axiosInstance.put<string>(`/api/v1/tags/${encodedTag}`, {
+        Name: newTagName,
+      }),
+    );
+  }
+
+  public async deleteTag(tag: string): Promise<string> {
+    const encodedTag = encodeURI(tag);
+    return this.handleRequest(() =>
+      this.axiosInstance.delete<string>(`/api/v1/tags/${encodedTag}`),
+    );
+  }
+
+  // Testing
+  public async renderMessageHTML(id: string): Promise<string> {
+    return this.handleRequest(() =>
+      this.axiosInstance.get<string>(`/view/${id}.html`),
+    );
+  }
+
+  public async renderMessageText(id: string): Promise<string> {
+    return this.handleRequest(() =>
+      this.axiosInstance.get<string>(`/view/${id}.txt`),
+    );
+  }
+}

package/tsconfig-base.json

@@ -0,0 +1,25 @@
+{
+    "compilerOptions": {
+        "allowJs": true,
+        "allowSyntheticDefaultImports": true,
+        "baseUrl": "src",
+        "declaration": true,
+        "esModuleInterop": true,
+        "inlineSourceMap": false,
+        "lib": ["esnext"],
+        "listEmittedFiles": false,
+        "listFiles": false,
+        "moduleResolution": "node",
+        "noFallthroughCasesInSwitch": true,
+        "pretty": true,
+        "resolveJsonModule": true,
+        "rootDir": "src",
+        "skipLibCheck": true,
+        "strict": true,
+        "traceResolution": false,
+        "types": ["node", "jest"]
+    },
+    "compileOnSave": false,
+    "exclude": ["node_modules", "dist"],
+    "include": ["src"]
+}

package/tsconfig-cjs.json

@@ -0,0 +1,8 @@
+{
+    "extends": "./tsconfig-base.json",
+    "compilerOptions": {
+        "module": "commonjs",
+        "outDir": "dist/cjs",
+        "target": "es2015"
+    }
+}

package/tsconfig.json

@@ -1,17 +1,8 @@
 {
+  "extends": "./tsconfig-base.json",
   "compilerOptions": {
-    "module": "ESNext",
-    "target": "ESNext",
-    "moduleResolution": "node",
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "declaration": true,
-    "sourceMap": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
+      "module": "esnext",
+      "outDir": "dist/mjs",
+      "target": "esnext"
+  }
 }

package/dist/MailpitClient.js

@@ -1,2 +0,0 @@
-export default MailpitClient;
-//# sourceMappingURL=MailpitClient.js.map

package/dist/MailpitClient.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"MailpitClient.js","sourceRoot":"","sources":["../src/MailpitClient.ts"],"names":[],"mappings":"AA8PA,eAAe,aAAa,CAAC"}

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-import MailpitClient from "./MailpitClient";
-export { MailpitClient };

package/dist/index.js

@@ -1,3 +0,0 @@
-import MailpitClient from "./MailpitClient";
-export { MailpitClient };
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAE5C,OAAO,EAAE,aAAa,EAAE,CAAC"}