mailpit-api 1.0.6 → 1.1.1

package/dist/mjs/index.d.ts

@@ -1,3 +1,22 @@
+interface Address {
+    Address: string;
+    Name: string;
+}
+interface Email {
+    Email: string;
+    Name: string;
+}
+interface Attachment {
+    ContentID: string;
+    ContentType: string;
+    FileName: string;
+    PartID: string;
+    Size: number;
+}
+interface ChaosTrigger {
+    ErrorCode: number;
+    Probability: number;
+}
 export interface MailpitInfoResponse {
     Database: string;
     DatabaseSize: number;
@@ -30,49 +49,22 @@ export interface MailpitConfigurationResponse {
     };
 }
 export interface MailpitMessageSummaryResponse {
-    Attachments: {
-        ContentID: string;
-        ContentType: string;
-        FileName: string;
-        PartID: string;
-        Size: number;
-    }[];
-    Bcc: {
-        Address: string;
-        Name: string;
-    }[];
-    Cc: {
-        Address: string;
-        Name: string;
-    }[];
+    Attachments: Attachment[];
+    Bcc: Address[];
+    Cc: Address[];
     Date: string;
-    From: {
-        Address: string;
-        Name: string;
-    };
+    From: Address;
     HTML: string;
     ID: string;
-    Inline: {
-        ContentID: string;
-        ContentType: string;
-        FileName: string;
-        PartID: string;
-        Size: number;
-    }[];
+    Inline: Attachment[];
     MessageID: string;
-    ReplyTo: {
-        Address: string;
-        Name: string;
-    }[];
+    ReplyTo: Address[];
     ReturnPath: string;
     Size: number;
     Subject: string;
     Tags: string[];
     Text: string;
-    To: {
-        Address: string;
-        Name: string;
-    }[];
+    To: Address[];
 }
 export interface MailpitMessagesSummaryResponse {
     messages: {
@@ -84,26 +76,11 @@ export interface MailpitMessagesSummaryResponse {
         ID: string;
         MessageID: string;
         Read: boolean;
-        Bcc: {
-            Address: string;
-            Name: string;
-        }[];
-        Cc: {
-            Address: string;
-            Name: string;
-        }[];
-        From: {
-            Address: string;
-            Name: string;
-        };
-        ReplyTo: {
-            Address: string;
-            Name: string;
-        }[];
-        To: {
-            Address: string;
-            Name: string;
-        }[];
+        Bcc: Address[];
+        Cc: Address[];
+        From: Address;
+        ReplyTo: Address[];
+        To: Address[];
     }[];
     messages_count: number;
     start: number;
@@ -120,29 +97,17 @@ export interface MailpitSendRequest {
         Filename: string;
     }[];
     Bcc: string[];
-    Cc: {
-        Email: string;
-        Name: string;
-    }[];
-    From: {
-        Email: string;
-        Name: string;
-    };
+    Cc: Email[];
+    From: Email;
     HTML: string;
     Headers: {
         [key: string]: string;
     };
-    ReplyTo: {
-        Email: string;
-        Name: string;
-    }[];
+    ReplyTo: Email[];
     Subject: string;
     Tags: string[];
     Text: string;
-    To: {
-        Email: string;
-        Name: string;
-    }[];
+    To: Email[];
 }
 export interface MailpitSendMessageConfirmationResponse {
     ID: string;
@@ -225,44 +190,33 @@ export interface MailpitSetTagsRequest {
     Tags: string[];
 }
 export interface ChaosTriggersRequest {
-    Authentication?: {
-        ErrorCode: number;
-        Probability: number;
-    };
-    Recipient?: {
-        ErrorCode: number;
-        Probability: number;
-    };
-    Sender?: {
-        ErrorCode: number;
-        Probability: number;
-    };
+    Authentication?: ChaosTrigger;
+    Recipient?: ChaosTrigger;
+    Sender?: ChaosTrigger;
 }
 export interface ChaosTriggersResponse {
-    Authentication: {
-        ErrorCode: number;
-        Probability: number;
-    };
-    Recipient?: {
-        ErrorCode: number;
-        Probability: number;
-    };
-    Sender?: {
-        ErrorCode: number;
-        Probability: number;
-    };
+    Authentication: ChaosTrigger;
+    Recipient?: ChaosTrigger;
+    Sender?: ChaosTrigger;
+}
+interface AttachmentResponse {
+    data: ArrayBuffer;
+    contentType: string;
 }
 export declare class MailpitClient {
     private axiosInstance;
-    constructor(baseURL: string);
+    constructor(baseURL: string, auth?: {
+        username: string;
+        password: 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>;
+    getMessageAttachment(id: string, partID: string): Promise<AttachmentResponse>;
     getMessageSource(id?: string): Promise<string>;
-    getAttachmentThumbnail(id: string, partID: string): Promise<string>;
+    getAttachmentThumbnail(id: string, partID: string): Promise<AttachmentResponse>;
     releaseMessage(id: string, releaseRequest: {
         To: string[];
     }): Promise<string>;
@@ -279,8 +233,9 @@ export declare class MailpitClient {
     setTags(request: MailpitSetTagsRequest): Promise<string>;
     renameTag(tag: string, newTagName: string): Promise<string>;
     deleteTag(tag: string): Promise<string>;
-    renderMessageHTML(id?: string): Promise<string>;
+    renderMessageHTML(id?: string, embed?: 1): Promise<string>;
     renderMessageText(id?: string): Promise<string>;
     getChaosTriggers(): Promise<ChaosTriggersResponse>;
     setChaosTriggers(triggers?: ChaosTriggersRequest): Promise<ChaosTriggersResponse>;
 }
+export {};

package/dist/mjs/index.js

@@ -1,128 +1,141 @@
-import axios from "axios";
+import axios, { isAxiosError, } from "axios";
 export class MailpitClient {
     axiosInstance;
-    constructor(baseURL) {
+    constructor(baseURL, auth) {
         this.axiosInstance = axios.create({
-            baseURL: baseURL,
+            baseURL,
+            auth,
             validateStatus: function (status) {
                 return status === 200;
             },
         });
     }
-    async handleRequest(request) {
+    async handleRequest(request, options = { fullResponse: false }) {
         try {
             const response = await request();
-            return response.data;
+            return options.fullResponse ? response : response.data;
         }
         catch (error) {
-            if (axios.isAxiosError(error)) {
+            if (isAxiosError(error)) {
+                const url = error.config?.url || "UNKNOWN URL";
+                const method = error.config?.method?.toUpperCase() || "UNKNOWN METHOD";
                 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)}`);
+                    throw new Error(`Mailpit API Error: ${error.response.status.toString()} ${error.response.statusText} at ${method} ${url}: ${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.");
+                    throw new Error(`Mailpit API Error: No response received from server at ${method} ${url}`);
                 }
                 else {
                     // Something happened in setting up the request
-                    throw new Error(`Mailpit API Error: ${error.message}`);
+                    throw new Error(`Mailpit API Error: ${error.toString()} at ${method} ${url}`);
                 }
             }
             else {
-                throw new Error("Unexpected Error: " + error);
+                throw new Error(`Unexpected Error: ${error}`);
             }
         }
     }
     // Application
     async getInfo() {
-        return this.handleRequest(() => this.axiosInstance.get("/api/v1/info"));
+        return await this.handleRequest(() => this.axiosInstance.get("/api/v1/info"));
     }
     async getConfiguration() {
-        return this.handleRequest(() => this.axiosInstance.get("/api/v1/webui"));
+        return await this.handleRequest(() => this.axiosInstance.get("/api/v1/webui"));
     }
     // Message
     async getMessageSummary(id = "latest") {
-        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}`));
+        return await this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}`));
     }
     async getMessageHeaders(id = "latest") {
-        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/headers`));
+        return await 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}`));
+        const response = await this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/part/${partID}`, { responseType: "arraybuffer" }), { fullResponse: true });
+        return {
+            data: response.data,
+            contentType: response.headers["content-type"],
+        };
     }
     async getMessageSource(id = "latest") {
-        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/raw`));
+        return await 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`));
+        const response = await this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/part/${partID}/thumb`, {
+            responseType: "arraybuffer",
+        }), { fullResponse: true });
+        return {
+            data: response.data,
+            contentType: response.headers["content-type"],
+        };
     }
     async releaseMessage(id, releaseRequest) {
-        return this.handleRequest(() => this.axiosInstance.post(`/api/v1/message/${id}/release`, releaseRequest));
+        return await this.handleRequest(() => this.axiosInstance.post(`/api/v1/message/${id}/release`, releaseRequest));
     }
     async sendMessage(sendReqest) {
-        return this.handleRequest(() => this.axiosInstance.post(`/api/v1/send`, sendReqest));
+        return await this.handleRequest(() => this.axiosInstance.post(`/api/v1/send`, sendReqest));
     }
     // Other
     async htmlCheck(id = "latest") {
-        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/html-check`));
+        return await this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/html-check`));
     }
     async linkCheck(id = "latest", follow = "false") {
-        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/link-check`, { params: { follow } }));
+        return await this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/link-check`, { params: { follow } }));
     }
     async spamAssassinCheck(id = "latest") {
-        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/sa-check`));
+        return await this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/sa-check`));
     }
     // Messages
     async listMessages(start = 0, limit = 50) {
-        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/messages`, { params: { start, limit } }));
+        return await this.handleRequest(() => this.axiosInstance.get(`/api/v1/messages`, { params: { start, limit } }));
     }
     async setReadStatus(readStatus) {
-        return this.handleRequest(() => this.axiosInstance.put(`/api/v1/messages`, readStatus));
+        return await this.handleRequest(() => this.axiosInstance.put(`/api/v1/messages`, readStatus));
     }
     async deleteMessages(deleteRequest) {
-        return this.handleRequest(() => this.axiosInstance.delete(`/api/v1/messages`, {
+        return await 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.get(`/api/v1/search`, {
+        return await this.handleRequest(() => this.axiosInstance.get(`/api/v1/search`, {
             params: search,
         }));
     }
     // See https://mailpit.axllent.org/docs/usage/search-filters/
     async deleteMessagesBySearch(search) {
-        return this.handleRequest(() => this.axiosInstance.delete(`/api/v1/search`, { params: search }));
+        return await this.handleRequest(() => this.axiosInstance.delete(`/api/v1/search`, { params: search }));
     }
     // Tags
     async getTags() {
-        return this.handleRequest(() => this.axiosInstance.get(`/api/v1/tags`));
+        return await this.handleRequest(() => this.axiosInstance.get(`/api/v1/tags`));
     }
     async setTags(request) {
-        return this.handleRequest(() => this.axiosInstance.put(`/api/v1/tags`, request));
+        return await 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}`, {
+        return await 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}`));
+        return await this.handleRequest(() => this.axiosInstance.delete(`/api/v1/tags/${encodedTag}`));
     }
     // Testing
-    async renderMessageHTML(id = "latest") {
-        return this.handleRequest(() => this.axiosInstance.get(`/view/${id}.html`));
+    async renderMessageHTML(id = "latest", embed) {
+        return await this.handleRequest(() => this.axiosInstance.get(`/view/${id}.html`, { params: { embed } }));
     }
     async renderMessageText(id = "latest") {
-        return this.handleRequest(() => this.axiosInstance.get(`/view/${id}.txt`));
+        return await this.handleRequest(() => this.axiosInstance.get(`/view/${id}.txt`));
     }
     async getChaosTriggers() {
-        return this.handleRequest(() => this.axiosInstance.get("/api/v1/chaos"));
+        return await this.handleRequest(() => this.axiosInstance.get("/api/v1/chaos"));
     }
     async setChaosTriggers(triggers = {}) {
-        return this.handleRequest(() => this.axiosInstance.put("/api/v1/chaos", triggers));
+        return await this.handleRequest(() => this.axiosInstance.put("/api/v1/chaos", triggers));
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailpit-api",
-  "version": "1.0.6",
+  "version": "1.1.1",
   "description": "A NodeJS client library, written in TypeScript, to interact with the Mailpit API.",
   "repository": {
     "type": "git",
@@ -17,7 +17,8 @@
   "scripts": {
     "test": "echo \"TODO: Add tests\" && exit 0",
     "build": "rm -fr dist/* && tsc -p tsconfig.json && tsc -p tsconfig-cjs.json && ./fixup_type",
-    "pretty": "npx prettier . --write"
+    "pretty": "npx prettier . --write",
+    "lint": "npx eslint --fix src"
   },
   "keywords": [
     "mailpit-api",
@@ -36,16 +37,14 @@
     "axios": "^1.7.9"
   },
   "devDependencies": {
-    "@eslint/js": "^8.57.0",
+    "@eslint/js": "^8.57.1",
+    "@types/eslint__js": "^8.42.3",
     "@types/node": "^20.14.15",
-    "@typescript-eslint/eslint-plugin": "^7.18.0",
-    "@typescript-eslint/parser": "^7.18.0",
-    "eslint": "^8.57.0",
-    "globals": "^15.14.0",
+    "eslint": "^9.20.1",
     "jest": "^29.7.0",
     "prettier": "3.4.2",
-    "tsx": "^4.19.2",
+    "tsx": "^4.19.3",
     "typescript": "^5.7.3",
-    "typescript-eslint": "^7.18.0"
+    "typescript-eslint": "^8.24.0"
   }
 }