mailpit-api 1.0.2-beta.2 → 1.0.2

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

@@ -1,4 +1,4 @@
-export interface MailpitInfo {
+export interface MailpitInfoResponse {
     Database: string;
     DatabaseSize: number;
     LatestVersion: string;
@@ -18,7 +18,7 @@ export interface MailpitInfo {
     Unread: number;
     Version: string;
 }
-export interface MailpitConfiguration {
+export interface MailpitConfigurationResponse {
     DuplicatesIgnored: boolean;
     Label: string;
     SpamAssassin: boolean;
@@ -29,7 +29,7 @@ export interface MailpitConfiguration {
         SMTPServer: string;
     };
 }
-export interface MailpitMessageSummary {
+export interface MailpitMessageSummaryResponse {
     Attachments: [
         {
             ContentID: string;
@@ -86,10 +86,10 @@ export interface MailpitMessageSummary {
         }
     ];
 }
-export interface MailpitMessagesSummary {
-    messages: [MailpitMessageSummary];
+export interface MailpitMessagesSummaryResponse {
+    messages: [MailpitMessageSummaryResponse];
 }
-export interface MailpitMessageHeaders {
+export interface MailpitMessageHeadersResponse {
     [key: string]: string;
 }
 export interface MailpitSendRequest {
@@ -130,7 +130,7 @@ export interface MailpitSendRequest {
         }
     ];
 }
-export interface MailpitSendMessageConfirmation {
+export interface MailpitSendMessageConfirmationResponse {
     ID: string;
 }
 export interface MailpitHTMLCheckResponse {
@@ -204,15 +204,15 @@ export interface MailpitReadStatusRequest {
 export interface MailpitDeleteRequest {
     IDs: [string];
 }
-export interface MailpitSearch {
+export interface MailpitSearchRequest {
     query: string;
-    start: number;
-    limit: number;
-    tz: string;
+    start?: number;
+    limit?: number;
+    tz?: string;
 }
-export interface MailpitSearchDelete {
+export interface MailpitSearchDeleteRequest {
     query: string;
-    tz: string;
+    tz?: string;
 }
 export interface MailpitSetTagsRequest {
     IDs: [string];
@@ -222,30 +222,29 @@ 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>;
+    getInfo(): Promise<MailpitInfoResponse>;
+    getConfiguration(): Promise<MailpitConfigurationResponse>;
+    getMessageSummary(id?: string): Promise<MailpitMessageSummaryResponse>;
+    getMessageHeaders(id?: string): Promise<MailpitMessageHeadersResponse>;
     getMessageAttachment(id: string, partID: string): Promise<string>;
-    getMessageSource(id: 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>;
+    sendMessage(sendReqest: MailpitSendRequest): Promise<MailpitSendMessageConfirmationResponse>;
+    htmlCheck(id?: string): Promise<MailpitHTMLCheckResponse>;
+    linkCheck(id?: string, follow?: "true" | "false"): Promise<MailpitLinkCheckResponse>;
+    spamAssassinCheck(id?: string): Promise<MailpitSpamAssassinResponse>;
+    listMessages(start?: number, limit?: number): Promise<MailpitMessagesSummaryResponse>;
     setReadStatus(readStatus: MailpitReadStatusRequest): Promise<string>;
     deleteMessages(deleteRequest: MailpitDeleteRequest): Promise<string>;
-    searchMessages(search: MailpitSearch): Promise<MailpitMessagesSummary>;
-    deleteMessagesBySearch(search: MailpitSearchDelete): Promise<string>;
+    searchMessages(search: MailpitSearchRequest): Promise<MailpitMessagesSummaryResponse>;
+    deleteMessagesBySearch(search: MailpitSearchDeleteRequest): 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>;
+    renderMessageHTML(id?: string): Promise<string>;
+    renderMessageText(id?: string): Promise<string>;
 }
-export default MailpitClient;

package/dist/cjs/index.js

@@ -0,0 +1,184 @@
+"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() {
+        return __awaiter(this, arguments, void 0, function* (id = "latest") {
+            return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}`));
+        });
+    }
+    getMessageHeaders() {
+        return __awaiter(this, arguments, void 0, function* (id = "latest") {
+            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() {
+        return __awaiter(this, arguments, void 0, function* (id = "latest") {
+            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() {
+        return __awaiter(this, arguments, void 0, function* (id = "latest") {
+            return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/html-check`));
+        });
+    }
+    linkCheck() {
+        return __awaiter(this, arguments, void 0, function* (id = "latest", follow = "false") {
+            return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/link-check`, { params: { follow } }));
+        });
+    }
+    spamAssassinCheck() {
+        return __awaiter(this, arguments, void 0, function* (id = "latest") {
+            return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/sa-check`));
+        });
+    }
+    // Messages
+    listMessages() {
+        return __awaiter(this, arguments, void 0, function* (start = 0, limit = 50) {
+            return this.handleRequest(() => this.axiosInstance.get(`/api/v1/messages`, { params: { start, limit } }));
+        });
+    }
+    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.get(`/api/v1/search`, {
+                params: 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() {
+        return __awaiter(this, arguments, void 0, function* (id = "latest") {
+            return this.handleRequest(() => this.axiosInstance.get(`/view/${id}.html`));
+        });
+    }
+    renderMessageText() {
+        return __awaiter(this, arguments, void 0, function* (id = "latest") {
+            return this.handleRequest(() => this.axiosInstance.get(`/view/${id}.txt`));
+        });
+    }
+}
+exports.MailpitClient = MailpitClient;

package/dist/cjs/package.json

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

package/dist/mjs/index.d.ts

@@ -0,0 +1,250 @@
+export interface MailpitInfoResponse {
+    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 MailpitConfigurationResponse {
+    DuplicatesIgnored: boolean;
+    Label: string;
+    SpamAssassin: boolean;
+    MessageRelay: {
+        AllowedRecipients: string;
+        Enabled: boolean;
+        ReturnPath: string;
+        SMTPServer: string;
+    };
+}
+export interface MailpitMessageSummaryResponse {
+    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 MailpitMessagesSummaryResponse {
+    messages: [MailpitMessageSummaryResponse];
+}
+export interface MailpitMessageHeadersResponse {
+    [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 MailpitSendMessageConfirmationResponse {
+    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 MailpitSearchRequest {
+    query: string;
+    start?: number;
+    limit?: number;
+    tz?: string;
+}
+export interface MailpitSearchDeleteRequest {
+    query: string;
+    tz?: string;
+}
+export interface MailpitSetTagsRequest {
+    IDs: [string];
+    Tags: [string];
+}
+export declare class MailpitClient {
+    private axiosInstance;
+    constructor(baseURL: string);
+    private handleRequest;
+    getInfo(): Promise<MailpitInfoResponse>;
+    getConfiguration(): Promise<MailpitConfigurationResponse>;
+    getMessageSummary(id?: string): Promise<MailpitMessageSummaryResponse>;
+    getMessageHeaders(id?: string): Promise<MailpitMessageHeadersResponse>;
+    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<MailpitSendMessageConfirmationResponse>;
+    htmlCheck(id?: string): Promise<MailpitHTMLCheckResponse>;
+    linkCheck(id?: string, follow?: "true" | "false"): Promise<MailpitLinkCheckResponse>;
+    spamAssassinCheck(id?: string): Promise<MailpitSpamAssassinResponse>;
+    listMessages(start?: number, limit?: number): Promise<MailpitMessagesSummaryResponse>;
+    setReadStatus(readStatus: MailpitReadStatusRequest): Promise<string>;
+    deleteMessages(deleteRequest: MailpitDeleteRequest): Promise<string>;
+    searchMessages(search: MailpitSearchRequest): Promise<MailpitMessagesSummaryResponse>;
+    deleteMessagesBySearch(search: MailpitSearchDeleteRequest): 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>;
+}

package/dist/{MailpitClient.js → mjs/index.js}

@@ -41,16 +41,16 @@ export class MailpitClient {
     async getConfiguration() {
         return this.handleRequest(() => this.axiosInstance.get("/api/v1/webui"));
     }
-    async getMessageSummary(id) {
+    async getMessageSummary(id = "latest") {
         return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}`));
     }
-    async getMessageHeaders(id) {
+    async getMessageHeaders(id = "latest") {
         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) {
+    async getMessageSource(id = "latest") {
         return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/raw`));
     }
     async getAttachmentThumbnail(id, partID) {
@@ -63,18 +63,18 @@ export class MailpitClient {
         return this.handleRequest(() => this.axiosInstance.post(`/api/v1/send`, sendReqest));
     }
     // Other
-    async htmlCheck(id) {
+    async htmlCheck(id = "latest") {
         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 linkCheck(id = "latest", follow = "false") {
+        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/link-check`, { params: { follow } }));
     }
-    async spamAssassinCheck(id) {
+    async spamAssassinCheck(id = "latest") {
         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 listMessages(start = 0, limit = 50) {
+        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/messages`, { params: { start, limit } }));
     }
     async setReadStatus(readStatus) {
         return this.handleRequest(() => this.axiosInstance.put(`/api/v1/messages`, readStatus));
@@ -86,7 +86,9 @@ export class MailpitClient {
     }
     // See https://mailpit.axllent.org/docs/usage/search-filters/
     async searchMessages(search) {
-        return this.handleRequest(() => this.axiosInstance.put(`/api/v1/search`, search));
+        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/search`, {
+            params: search,
+        }));
     }
     // See https://mailpit.axllent.org/docs/usage/search-filters/
     async deleteMessagesBySearch(search) {
@@ -110,12 +112,10 @@ export class MailpitClient {
         return this.handleRequest(() => this.axiosInstance.delete(`/api/v1/tags/${encodedTag}`));
     }
     // Testing
-    async renderMessageHTML(id) {
+    async renderMessageHTML(id = "latest") {
         return this.handleRequest(() => this.axiosInstance.get(`/view/${id}.html`));
     }
-    async renderMessageText(id) {
+    async renderMessageText(id = "latest") {
         return this.handleRequest(() => this.axiosInstance.get(`/view/${id}.txt`));
     }
 }
-export default MailpitClient;
-//# sourceMappingURL=MailpitClient.js.map

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.2",
+  "version": "1.0.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": "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"
   }
 }