mailpit-api 1.5.0 → 1.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +1 -1
  2. package/dist/index.d.mts +6 -0
  3. package/dist/index.d.ts +6 -0
  4. package/package.json +19 -12
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  [![Package Version](https://img.shields.io/npm/v/mailpit-api.svg?label=npm)](https://www.npmjs.com/package/mailpit-api)
4
4
  [![Test Suite](https://github.com/mpspahr/mailpit-api/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/mpspahr/mailpit-api/actions/workflows/npm-publish.yml)
5
- [![Code Coverage](https://codecov.io/gh/mpspahr/mailpit-api/branch/main/graph/badge.svg)](https://codecov.io/gh/mpspahr/mailpit-api)
5
+ [![Code Coverage](https://codecov.io/gh/mpspahr/mailpit-api/graph/badge.svg?token=VUWKIYK1WM)](https://codecov.io/gh/mpspahr/mailpit-api)
6
6
  [![Documentation](https://github.com/mpspahr/mailpit-api/actions/workflows/deploy-docs.yml/badge.svg?branch=main&label=docs)](https://mpspahr.github.io/mailpit-api/)
7
7
 
8
8
  A TypeScript client for interacting with [Mailpit](https://mailpit.axllent.org/)'s [REST API](https://mailpit.axllent.org/docs/api-v1/view.html#get-/api/v1/info). Ideal for automating your email testing.
package/dist/index.d.mts CHANGED
@@ -114,6 +114,8 @@ interface MailpitConfigurationResponse {
114
114
  Enabled: boolean;
115
115
  /** Overrides the "From" address for all relayed messages */
116
116
  OverrideFrom: string;
117
+ /** Preserve the original Message-IDs when relaying messages */
118
+ PreserveMessageIDs: boolean;
117
119
  /** @deprecated Refer to `AllowedRecipients` instead. No longer documented upstream */
118
120
  RecipientAllowlist: string;
119
121
  /** Enforced Return-Path (if set) for relay bounces */
@@ -169,6 +171,8 @@ interface MailpitMessageSummaryResponse {
169
171
  Text: string;
170
172
  /** To addresses */
171
173
  To: MailpitEmailAddressResponse[];
174
+ /** Username used for authentication (if provided) with the SMTP or {@link MailpitClient.sendMessage| sendMessage} */
175
+ Username?: string;
172
176
  }
173
177
  /** Response for the {@link MailpitClient.listMessages| listMessages()} API containing the summary of multiple messages. */
174
178
  interface MailpitMessagesSummaryResponse {
@@ -202,6 +206,8 @@ interface MailpitMessagesSummaryResponse {
202
206
  Tags: string[];
203
207
  /** To addresses */
204
208
  To: MailpitEmailAddressResponse[];
209
+ /** Username used for authentication (if provided) with the SMTP or {@link MailpitClient.sendMessage| sendMessage} */
210
+ Username?: string;
205
211
  }[];
206
212
  /** Total number of messages matching the current query */
207
213
  messages_count: number;
package/dist/index.d.ts CHANGED
@@ -114,6 +114,8 @@ interface MailpitConfigurationResponse {
114
114
  Enabled: boolean;
115
115
  /** Overrides the "From" address for all relayed messages */
116
116
  OverrideFrom: string;
117
+ /** Preserve the original Message-IDs when relaying messages */
118
+ PreserveMessageIDs: boolean;
117
119
  /** @deprecated Refer to `AllowedRecipients` instead. No longer documented upstream */
118
120
  RecipientAllowlist: string;
119
121
  /** Enforced Return-Path (if set) for relay bounces */
@@ -169,6 +171,8 @@ interface MailpitMessageSummaryResponse {
169
171
  Text: string;
170
172
  /** To addresses */
171
173
  To: MailpitEmailAddressResponse[];
174
+ /** Username used for authentication (if provided) with the SMTP or {@link MailpitClient.sendMessage| sendMessage} */
175
+ Username?: string;
172
176
  }
173
177
  /** Response for the {@link MailpitClient.listMessages| listMessages()} API containing the summary of multiple messages. */
174
178
  interface MailpitMessagesSummaryResponse {
@@ -202,6 +206,8 @@ interface MailpitMessagesSummaryResponse {
202
206
  Tags: string[];
203
207
  /** To addresses */
204
208
  To: MailpitEmailAddressResponse[];
209
+ /** Username used for authentication (if provided) with the SMTP or {@link MailpitClient.sendMessage| sendMessage} */
210
+ Username?: string;
205
211
  }[];
206
212
  /** Total number of messages matching the current query */
207
213
  messages_count: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mailpit-api",
3
- "version": "1.5.0",
3
+ "version": "1.5.2",
4
4
  "description": "A TypeScript client for interacting with Mailpit's REST API.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -10,6 +10,13 @@
10
10
  "bugs": {
11
11
  "url": "https://github.com/mpspahr/mailpit-api/issues"
12
12
  },
13
+ "publishConfig": {
14
+ "registry": "https://registry.npmjs.org/",
15
+ "provenance": true
16
+ },
17
+ "engines": {
18
+ "node": ">=18.0.0"
19
+ },
13
20
  "main": "dist/index.js",
14
21
  "module": "dist/index.mjs",
15
22
  "exports": {
@@ -52,23 +59,23 @@
52
59
  "author": "Matthew Spahr",
53
60
  "license": "MIT",
54
61
  "dependencies": {
55
- "axios": "^1.9.0"
62
+ "axios": "^1.10.0"
56
63
  },
57
64
  "devDependencies": {
58
- "@eslint/js": "^9.28.0",
59
- "@jest/globals": "^29.7.0",
60
- "@types/node": "^22.15.30",
65
+ "@eslint/js": "^9.29.0",
66
+ "@jest/globals": "^30.0.2",
67
+ "@types/node": "^22.15.32",
61
68
  "dotenv": "^16.5.0",
62
- "eslint": "^9.28.0",
63
- "eslint-plugin-jest": "^28.13.0",
64
- "jest": "^29.7.0",
65
- "prettier": "3.5.3",
66
- "ts-jest": "^29.3.4",
69
+ "eslint": "^9.29.0",
70
+ "eslint-plugin-jest": "^29.0.1",
71
+ "jest": "^30.0.2",
72
+ "prettier": "3.6.0",
73
+ "ts-jest": "^29.4.0",
67
74
  "tsup": "^8.5.0",
68
- "tsx": "^4.19.4",
75
+ "tsx": "^4.20.3",
69
76
  "typedoc": "^0.28.5",
70
77
  "typedoc-github-theme": "^0.3.0",
71
78
  "typescript": "^5.8.3",
72
- "typescript-eslint": "^8.33.1"
79
+ "typescript-eslint": "^8.34.1"
73
80
  }
74
81
  }