mailpit-api 1.0.2-beta.3 → 1.0.3

package/dist/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,54 @@ export interface MailpitMessageSummary {
         }
     ];
 }
-export interface MailpitMessagesSummary {
-    messages: [MailpitMessageSummary];
+export interface MailpitMessagesSummaryResponse {
+    messages: [
+        {
+            Attachments: number;
+            Size: number;
+            Snippet: string;
+            Subject: string;
+            Tags: [string];
+            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;
+                }
+            ];
+        }
+    ];
+    messages_count: number;
+    start: number;
+    tags: [string];
+    total: number;
+    unread: number;
 }
-export interface MailpitMessageHeaders {
+export interface MailpitMessageHeadersResponse {
     [key: string]: string;
 }
 export interface MailpitSendRequest {
@@ -130,7 +174,7 @@ export interface MailpitSendRequest {
         }
     ];
 }
-export interface MailpitSendMessageConfirmation {
+export interface MailpitSendMessageConfirmationResponse {
     ID: string;
 }
 export interface MailpitHTMLCheckResponse {
@@ -204,15 +248,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,29 +266,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>;
 }

package/dist/cjs/index.js

@@ -61,13 +61,13 @@ class MailpitClient {
             return this.handleRequest(() => this.axiosInstance.get("/api/v1/webui"));
         });
     }
-    getMessageSummary(id) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getMessageSummary() {
+        return __awaiter(this, arguments, void 0, function* (id = "latest") {
             return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}`));
         });
     }
-    getMessageHeaders(id) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getMessageHeaders() {
+        return __awaiter(this, arguments, void 0, function* (id = "latest") {
             return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/headers`));
         });
     }
@@ -76,8 +76,8 @@ class MailpitClient {
             return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/part/${partID}`));
         });
     }
-    getMessageSource(id) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getMessageSource() {
+        return __awaiter(this, arguments, void 0, function* (id = "latest") {
             return this.handleRequest(() => this.axiosInstance.get(`/api/v1/message/${id}/raw`));
         });
     }
@@ -97,25 +97,25 @@ class MailpitClient {
         });
     }
     // Other
-    htmlCheck(id) {
-        return __awaiter(this, void 0, void 0, function* () {
+    htmlCheck() {
+        return __awaiter(this, arguments, void 0, function* (id = "latest") {
             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`));
+    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(id) {
-        return __awaiter(this, void 0, void 0, function* () {
+    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, void 0, void 0, function* () {
-            return this.handleRequest(() => this.axiosInstance.get(`/api/v1/messages`));
+        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) {
@@ -133,7 +133,9 @@ class MailpitClient {
     // 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));
+            return this.handleRequest(() => this.axiosInstance.get(`/api/v1/search`, {
+                params: search,
+            }));
         });
     }
     // See https://mailpit.axllent.org/docs/usage/search-filters/
@@ -168,13 +170,13 @@ class MailpitClient {
         });
     }
     // Testing
-    renderMessageHTML(id) {
-        return __awaiter(this, void 0, void 0, function* () {
+    renderMessageHTML() {
+        return __awaiter(this, arguments, void 0, function* (id = "latest") {
             return this.handleRequest(() => this.axiosInstance.get(`/view/${id}.html`));
         });
     }
-    renderMessageText(id) {
-        return __awaiter(this, void 0, void 0, function* () {
+    renderMessageText() {
+        return __awaiter(this, arguments, void 0, function* (id = "latest") {
             return this.handleRequest(() => this.axiosInstance.get(`/view/${id}.txt`));
         });
     }

package/dist/mjs/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,54 @@ export interface MailpitMessageSummary {
         }
     ];
 }
-export interface MailpitMessagesSummary {
-    messages: [MailpitMessageSummary];
+export interface MailpitMessagesSummaryResponse {
+    messages: [
+        {
+            Attachments: number;
+            Size: number;
+            Snippet: string;
+            Subject: string;
+            Tags: [string];
+            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;
+                }
+            ];
+        }
+    ];
+    messages_count: number;
+    start: number;
+    tags: [string];
+    total: number;
+    unread: number;
 }
-export interface MailpitMessageHeaders {
+export interface MailpitMessageHeadersResponse {
     [key: string]: string;
 }
 export interface MailpitSendRequest {
@@ -130,7 +174,7 @@ export interface MailpitSendRequest {
         }
     ];
 }
-export interface MailpitSendMessageConfirmation {
+export interface MailpitSendMessageConfirmationResponse {
     ID: string;
 }
 export interface MailpitHTMLCheckResponse {
@@ -204,15 +248,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,29 +266,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>;
 }

package/dist/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,10 +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`));
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailpit-api",
-  "version": "1.0.2-beta.3",
+  "version": "1.0.3",
   "description": "A NodeJS client library, written in TypeScript, to interact with the Mailpit API.",
   "repository": {
     "type": "git",
@@ -32,18 +32,18 @@
   "author": "Matthew Spahr",
   "license": "MIT",
   "dependencies": {
-    "axios": "^1.7.2"
+    "axios": "^1.7.4"
   },
   "devDependencies": {
     "@eslint/js": "^8.57.0",
-    "@types/node": "^20.14.10",
+    "@types/node": "^20.14.15",
     "@typescript-eslint/eslint-plugin": "^7.18.0",
     "@typescript-eslint/parser": "^7.18.0",
     "eslint": "^8.57.0",
-    "globals": "^15.8.0",
+    "globals": "^15.9.0",
     "jest": "^29.7.0",
     "prettier": "3.3.3",
-    "tsx": "^4.16.2",
+    "tsx": "^4.17.0",
     "typescript": "^5.5.4",
     "typescript-eslint": "^7.18.0"
   }

package/src/index.ts

@@ -1,6 +1,6 @@
 import axios, { AxiosInstance } from "axios";
 
-export interface MailpitInfo {
+export interface MailpitInfoResponse {
   Database: string;
   DatabaseSize: number;
   LatestVersion: string;
@@ -21,7 +21,7 @@ export interface MailpitInfo {
   Version: string;
 }
 
-export interface MailpitConfiguration {
+export interface MailpitConfigurationResponse {
   DuplicatesIgnored: boolean;
   Label: string;
   SpamAssassin: boolean;
@@ -33,7 +33,7 @@ export interface MailpitConfiguration {
   };
 }
 
-export interface MailpitMessageSummary {
+export interface MailpitMessageSummaryResponse {
   Attachments: [
     {
       ContentID: string;
@@ -91,11 +91,55 @@ export interface MailpitMessageSummary {
   ];
 }
 
-export interface MailpitMessagesSummary {
-  messages: [MailpitMessageSummary];
+export interface MailpitMessagesSummaryResponse {
+  messages: [
+    {
+      Attachments: number;
+      Size: number;
+      Snippet: string;
+      Subject: string;
+      Tags: [string];
+      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;
+        },
+      ];
+    },
+  ];
+  messages_count: number;
+  start: number;
+  tags: [string];
+  total: number;
+  unread: number;
 }
 
-export interface MailpitMessageHeaders {
+export interface MailpitMessageHeadersResponse {
   [key: string]: string;
 }
 
@@ -138,7 +182,7 @@ export interface MailpitSendRequest {
   ];
 }
 
-export interface MailpitSendMessageConfirmation {
+export interface MailpitSendMessageConfirmationResponse {
   ID: string;
 }
 
@@ -218,16 +262,16 @@ 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 {
@@ -276,27 +320,33 @@ export class MailpitClient {
   }
 
   // Message
-  public async getInfo(): Promise<MailpitInfo> {
+  public async getInfo(): Promise<MailpitInfoResponse> {
     return this.handleRequest(() =>
-      this.axiosInstance.get<MailpitInfo>("/api/v1/info"),
+      this.axiosInstance.get<MailpitInfoResponse>("/api/v1/info"),
     );
   }
 
-  public async getConfiguration(): Promise<MailpitConfiguration> {
+  public async getConfiguration(): Promise<MailpitConfigurationResponse> {
     return this.handleRequest(() =>
-      this.axiosInstance.get<MailpitConfiguration>("/api/v1/webui"),
+      this.axiosInstance.get<MailpitConfigurationResponse>("/api/v1/webui"),
     );
   }
 
-  public async getMessageSummary(id: string): Promise<MailpitMessageSummary> {
+  public async getMessageSummary(
+    id: string = "latest",
+  ): Promise<MailpitMessageSummaryResponse> {
     return this.handleRequest(() =>
-      this.axiosInstance.get<MailpitMessageSummary>(`/api/v1/message/${id}`),
+      this.axiosInstance.get<MailpitMessageSummaryResponse>(
+        `/api/v1/message/${id}`,
+      ),
     );
   }
 
-  public async getMessageHeaders(id: string): Promise<MailpitMessageHeaders> {
+  public async getMessageHeaders(
+    id: string = "latest",
+  ): Promise<MailpitMessageHeadersResponse> {
     return this.handleRequest(() =>
-      this.axiosInstance.get<MailpitMessageHeaders>(
+      this.axiosInstance.get<MailpitMessageHeadersResponse>(
         `/api/v1/message/${id}/headers`,
       ),
     );
@@ -311,7 +361,7 @@ export class MailpitClient {
     );
   }
 
-  public async getMessageSource(id: string): Promise<string> {
+  public async getMessageSource(id: string = "latest"): Promise<string> {
     return this.handleRequest(() =>
       this.axiosInstance.get<string>(`/api/v1/message/${id}/raw`),
     );
@@ -342,9 +392,9 @@ export class MailpitClient {
 
   public async sendMessage(
     sendReqest: MailpitSendRequest,
-  ): Promise<MailpitSendMessageConfirmation> {
+  ): Promise<MailpitSendMessageConfirmationResponse> {
     return this.handleRequest(() =>
-      this.axiosInstance.post<MailpitSendMessageConfirmation>(
+      this.axiosInstance.post<MailpitSendMessageConfirmationResponse>(
         `/api/v1/send`,
         sendReqest,
       ),
@@ -352,7 +402,9 @@ export class MailpitClient {
   }
 
   // Other
-  public async htmlCheck(id: string): Promise<MailpitHTMLCheckResponse> {
+  public async htmlCheck(
+    id: string = "latest",
+  ): Promise<MailpitHTMLCheckResponse> {
     return this.handleRequest(() =>
       this.axiosInstance.get<MailpitHTMLCheckResponse>(
         `/api/v1/message/${id}/html-check`,
@@ -360,16 +412,20 @@ export class MailpitClient {
     );
   }
 
-  public async linkCheck(id: string): Promise<MailpitLinkCheckResponse> {
+  public async linkCheck(
+    id: string = "latest",
+    follow: "true" | "false" = "false",
+  ): Promise<MailpitLinkCheckResponse> {
     return this.handleRequest(() =>
       this.axiosInstance.get<MailpitLinkCheckResponse>(
         `/api/v1/message/${id}/link-check`,
+        { params: { follow } },
       ),
     );
   }
 
   public async spamAssassinCheck(
-    id: string,
+    id: string = "latest",
   ): Promise<MailpitSpamAssassinResponse> {
     return this.handleRequest(() =>
       this.axiosInstance.get<MailpitSpamAssassinResponse>(
@@ -379,9 +435,15 @@ export class MailpitClient {
   }
 
   // Messages
-  public async listMessages(): Promise<MailpitMessagesSummary> {
+  public async listMessages(
+    start: number = 0,
+    limit: number = 50,
+  ): Promise<MailpitMessagesSummaryResponse> {
     return this.handleRequest(() =>
-      this.axiosInstance.get<MailpitMessagesSummary>(`/api/v1/messages`),
+      this.axiosInstance.get<MailpitMessagesSummaryResponse>(
+        `/api/v1/messages`,
+        { params: { start, limit } },
+      ),
     );
   }
 
@@ -405,16 +467,18 @@ export class MailpitClient {
 
   // See https://mailpit.axllent.org/docs/usage/search-filters/
   public async searchMessages(
-    search: MailpitSearch,
-  ): Promise<MailpitMessagesSummary> {
+    search: MailpitSearchRequest,
+  ): Promise<MailpitMessagesSummaryResponse> {
     return this.handleRequest(() =>
-      this.axiosInstance.put<MailpitMessagesSummary>(`/api/v1/search`, search),
+      this.axiosInstance.get<MailpitMessagesSummaryResponse>(`/api/v1/search`, {
+        params: search,
+      }),
     );
   }
 
   // See https://mailpit.axllent.org/docs/usage/search-filters/
   public async deleteMessagesBySearch(
-    search: MailpitSearchDelete,
+    search: MailpitSearchDeleteRequest,
   ): Promise<string> {
     return this.handleRequest(() =>
       this.axiosInstance.delete<string>(`/api/v1/search`, { data: search }),
@@ -451,15 +515,15 @@ export class MailpitClient {
   }
 
   // Testing
-  public async renderMessageHTML(id: string): Promise<string> {
+  public async renderMessageHTML(id: string = "latest"): Promise<string> {
     return this.handleRequest(() =>
       this.axiosInstance.get<string>(`/view/${id}.html`),
     );
   }
 
-  public async renderMessageText(id: string): Promise<string> {
+  public async renderMessageText(id: string = "latest"): Promise<string> {
     return this.handleRequest(() =>
       this.axiosInstance.get<string>(`/view/${id}.txt`),
     );
   }
-}
+}

package/tsconfig-base.json

@@ -1,25 +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"]
-}
+  "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

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

package/tsconfig.json

@@ -1,8 +1,8 @@
 {
   "extends": "./tsconfig-base.json",
   "compilerOptions": {
-      "module": "esnext",
-      "outDir": "dist/mjs",
-      "target": "esnext"
+    "module": "esnext",
+    "outDir": "dist/mjs",
+    "target": "esnext"
   }
 }