mailpit-api 1.0.0 → 1.0.2-beta

package/dist/MailpitClient.d.ts

@@ -0,0 +1,255 @@
+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: {
+        [key: string]: string;
+    };
+    start?: number;
+    limit?: number;
+    tz?: string;
+}
+interface MailpitSearchDelete {
+    query: {
+        [key: string]: string;
+    };
+    tz?: string;
+}
+interface MailpitSetTagsRequest {
+    IDs: [string];
+    Tags: [string];
+}
+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,2 @@
+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":"AA8PA,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.0",
+  "version": "1.0.2-beta",
   "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": "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,255 @@
+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: {
+        [key: string]: string;
+    };
+    start?: number;
+    limit?: number;
+    tz?: string;
+}
+interface MailpitSearchDelete {
+    query: {
+        [key: string]: string;
+    };
+    tz?: string;
+}
+interface MailpitSetTagsRequest {
+    IDs: [string];
+    Tags: [string];
+}
+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/src/index.ts

@@ -0,0 +1,3 @@
+import MailpitClient from "./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"]
 }

package/.github/workflows/npm-publish.yml

@@ -1,33 +0,0 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
-
-name: Node.js Package
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-      - run: npm ci
-      - run: npm test
-
-  publish-npm:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/.prettierignore

@@ -1,3 +0,0 @@
-# Ignore artifacts:
-build
-coverage

package/.prettierrc

@@ -1 +0,0 @@
-{}

package/eslint.config.mjs

@@ -1,10 +0,0 @@
-import globals from "globals";
-import pluginJs from "@eslint/js";
-import tseslint from "typescript-eslint";
-
-export default [
-  { files: ["**/*.{js,mjs,cjs,ts}"] },
-  { languageOptions: { globals: globals.browser } },
-  pluginJs.configs.recommended,
-  ...tseslint.configs.recommended,
-];