mailpit-api 1.0.1 → 1.0.2-beta.2

package/dist/MailpitClient.d.ts

@@ -0,0 +1,251 @@
+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 declare class MailpitClient {
+    private axiosInstance;
+    constructor(baseURL: string);
+    private handleRequest;
+    getInfo(): Promise<MailpitInfo>;
+    getConfiguration(): Promise<MailpitConfiguration>;
+    getMessageSummary(id: string): Promise<MailpitMessageSummary>;
+    getMessageHeaders(id: string): Promise<MailpitMessageHeaders>;
+    getMessageAttachment(id: string, partID: string): Promise<string>;
+    getMessageSource(id: string): Promise<string>;
+    getAttachmentThumbnail(id: string, partID: string): Promise<string>;
+    releaseMessage(id: string, releaseRequest: {
+        To: string[];
+    }): Promise<string>;
+    sendMessage(sendReqest: MailpitSendRequest): Promise<MailpitSendMessageConfirmation>;
+    htmlCheck(id: string): Promise<MailpitHTMLCheckResponse>;
+    linkCheck(id: string): Promise<MailpitLinkCheckResponse>;
+    spamAssassinCheck(id: string): Promise<MailpitSpamAssassinResponse>;
+    listMessages(): Promise<MailpitMessagesSummary>;
+    setReadStatus(readStatus: MailpitReadStatusRequest): Promise<string>;
+    deleteMessages(deleteRequest: MailpitDeleteRequest): Promise<string>;
+    searchMessages(search: MailpitSearch): Promise<MailpitMessagesSummary>;
+    deleteMessagesBySearch(search: MailpitSearchDelete): Promise<string>;
+    getTags(): Promise<[string]>;
+    setTags(request: MailpitSetTagsRequest): Promise<string>;
+    renameTag(tag: string, newTagName: string): Promise<string>;
+    deleteTag(tag: string): Promise<string>;
+    renderMessageHTML(id: string): Promise<string>;
+    renderMessageText(id: string): Promise<string>;
+}
+export default MailpitClient;

package/dist/MailpitClient.js

@@ -0,0 +1,121 @@
+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`));
+    }
+}
+export default MailpitClient;
+//# sourceMappingURL=MailpitClient.js.map

package/dist/MailpitClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MailpitClient.js","sourceRoot":"","sources":["../src/MailpitClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAwB,MAAM,OAAO,CAAC;AA6O7C,MAAM,OAAO,aAAa;IAChB,aAAa,CAAgB;IAErC,YAAY,OAAe;QACzB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC;YAChC,OAAO,EAAE,OAAO;YAChB,cAAc,EAAE,UAAU,MAAM;gBAC9B,OAAO,MAAM,KAAK,GAAG,CAAC;YACxB,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,aAAa,CACzB,OAAmC;QAEnC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,OAAO,EAAE,CAAC;YACjC,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC9B,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;oBACnB,gDAAgD;oBAChD,MAAM,IAAI,KAAK,CACb,sBAAsB,KAAK,CAAC,QAAQ,CAAC,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,UAAU,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CACnH,CAAC;gBACJ,CAAC;qBAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;oBACzB,gDAAgD;oBAChD,MAAM,IAAI,KAAK,CACb,sDAAsD,CACvD,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,+CAA+C;oBAC/C,MAAM,IAAI,KAAK,CAAC,sBAAsB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;gBACzD,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,oBAAoB,GAAG,KAAK,CAAC,CAAC;YAChD,CAAC;QACH,CAAC;IACH,CAAC;IAED,UAAU;IACH,KAAK,CAAC,OAAO;QAClB,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAc,cAAc,CAAC,CACpD,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,gBAAgB;QAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAuB,eAAe,CAAC,CAC9D,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,EAAU;QACvC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAwB,mBAAmB,EAAE,EAAE,CAAC,CACvE,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,EAAU;QACvC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CACpB,mBAAmB,EAAE,UAAU,CAChC,CACF,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAC/B,EAAU,EACV,MAAc;QAEd,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAS,mBAAmB,EAAE,SAAS,MAAM,EAAE,CAAC,CACvE,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,EAAU;QACtC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAS,mBAAmB,EAAE,MAAM,CAAC,CAC5D,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,sBAAsB,CACjC,EAAU,EACV,MAAc;QAEd,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CACpB,mBAAmB,EAAE,SAAS,MAAM,QAAQ,CAC7C,CACF,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,cAAc,CACzB,EAAU,EACV,cAAgC;QAEhC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,IAAI,CACrB,mBAAmB,EAAE,UAAU,EAC/B,cAAc,CACf,CACF,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,WAAW,CACtB,UAA8B;QAE9B,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,IAAI,CACrB,cAAc,EACd,UAAU,CACX,CACF,CAAC;IACJ,CAAC;IAED,QAAQ;IACD,KAAK,CAAC,SAAS,CAAC,EAAU;QAC/B,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CACpB,mBAAmB,EAAE,aAAa,CACnC,CACF,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,EAAU;QAC/B,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CACpB,mBAAmB,EAAE,aAAa,CACnC,CACF,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAC5B,EAAU;QAEV,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CACpB,mBAAmB,EAAE,WAAW,CACjC,CACF,CAAC;IACJ,CAAC;IAED,WAAW;IACJ,KAAK,CAAC,YAAY;QACvB,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAyB,kBAAkB,CAAC,CACnE,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,aAAa,CACxB,UAAoC;QAEpC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAS,kBAAkB,EAAE,UAAU,CAAC,CAC/D,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,cAAc,CACzB,aAAmC;QAEnC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,MAAM,CAAS,kBAAkB,EAAE;YACpD,IAAI,EAAE,aAAa;SACpB,CAAC,CACH,CAAC;IACJ,CAAC;IAED,6DAA6D;IACtD,KAAK,CAAC,cAAc,CACzB,MAAqB;QAErB,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAyB,gBAAgB,EAAE,MAAM,CAAC,CACzE,CAAC;IACJ,CAAC;IAED,6DAA6D;IACtD,KAAK,CAAC,sBAAsB,CACjC,MAA2B;QAE3B,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,MAAM,CAAS,gBAAgB,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CACtE,CAAC;IACJ,CAAC;IAED,OAAO;IACA,KAAK,CAAC,OAAO;QAClB,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAW,cAAc,CAAC,CACjD,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,OAA8B;QACjD,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAS,cAAc,EAAE,OAAO,CAAC,CACxD,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,GAAW,EAAE,UAAkB;QACpD,MAAM,UAAU,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAS,gBAAgB,UAAU,EAAE,EAAE;YAC3D,IAAI,EAAE,UAAU;SACjB,CAAC,CACH,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,GAAW;QAChC,MAAM,UAAU,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,MAAM,CAAS,gBAAgB,UAAU,EAAE,CAAC,CAChE,CAAC;IACJ,CAAC;IAED,UAAU;IACH,KAAK,CAAC,iBAAiB,CAAC,EAAU;QACvC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAS,SAAS,EAAE,OAAO,CAAC,CACnD,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,EAAU;QACvC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAS,SAAS,EAAE,MAAM,CAAC,CAClD,CAAC;IACJ,CAAC;CACF;AAED,eAAe,aAAa,CAAC"}

package/dist/index.d.ts

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

package/dist/index.js

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

package/dist/index.js.map

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

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "mailpit-api",
-  "version": "1.0.1",
+  "version": "1.0.2-beta.2",
   "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": "src/index.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
     "test": "echo \"TODO: Add tests\" && exit 0",
     "build": "tsc"

package/src/MailpitClient.ts

@@ -0,0 +1,467 @@
+import axios, { AxiosInstance } from "axios";
+
+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`),
+    );
+  }
+}
+
+export default MailpitClient;

package/src/index.ts

@@ -1,467 +1,3 @@
-import axios, { AxiosInstance } from "axios";
+import MailpitClient from "./MailpitClient";
 
-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;
-}
-
-interface MailpitConfiguration {
-  DuplicatesIgnored: boolean;
-  Label: string;
-  SpamAssassin: boolean;
-  MessageRelay: {
-    AllowedRecipients: string;
-    Enabled: boolean;
-    ReturnPath: string;
-    SMTPServer: string;
-  };
-}
-
-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;
-    },
-  ];
-}
-
-interface MailpitMessagesSummary {
-  messages: [MailpitMessageSummary];
-}
-
-interface MailpitMessageHeaders {
-  [key: string]: string;
-}
-
-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;
-    },
-  ];
-}
-
-interface MailpitSendMessageConfirmation {
-  ID: string;
-}
-
-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;
-    },
-  ];
-}
-
-interface MailpitLinkCheckResponse {
-  Errors: number;
-  Links: [
-    {
-      Status: string;
-      StatusCode: number;
-      URL: string;
-    },
-  ];
-}
-
-interface MailpitSpamAssassinResponse {
-  Errors: number;
-  IsSpam: boolean;
-  Rules: [
-    {
-      Description: string;
-      Name: string;
-      Score: number;
-    },
-  ];
-  Score: number;
-}
-
-interface MailpitReadStatusRequest {
-  IDs: [string];
-  Read: boolean;
-}
-
-interface MailpitDeleteRequest {
-  IDs: [string];
-}
-
-interface MailpitSearch {
-  query: string;
-  start: number;
-  limit: number;
-  tz: string;
-}
-
-interface MailpitSearchDelete {
-  query: string;
-  tz: string;
-}
-
-interface MailpitSetTagsRequest {
-  IDs: [string];
-  Tags: [string];
-}
-
-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`),
-    );
-  }
-}
-
-export default MailpitClient;
+export { MailpitClient };

package/tsconfig.json

@@ -1,14 +1,17 @@
 {
   "compilerOptions": {
-    "target": "ES6",
-    "module": "commonjs",
-    "declaration": true,
+    "module": "ESNext",
+    "target": "ESNext",
+    "moduleResolution": "node",
     "outDir": "./dist",
+    "rootDir": "./src",
     "strict": true,
     "esModuleInterop": true,
     "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "sourceMap": true
   },
-  "include": ["src/**/*", "info.ts"],
+  "include": ["src/**/*"],
   "exclude": ["node_modules", "dist"]
 }