@tryghost/nodemailer 0.3.48 → 0.3.49

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 (3) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +21 -6
  3. package/package.json +5 -6
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2013-2025 Ghost Foundation
3
+ Copyright (c) 2013-2026 Ghost Foundation
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -1,16 +1,31 @@
1
1
  # Nodemailer
2
2
 
3
- ## Install
3
+ This is a wrapper around the [nodemailer](https://nodemailer.com/) module for use internally by [Ghost](https://ghost.org/). It is not intended to be installed or used outside of Ghost.
4
4
 
5
- `npm install @tryghost/nodemailer --save`
5
+ See the [official docs for configurating transaction email sending for Ghost](https://ghost.org/docs/config/#mail).
6
6
 
7
- or
7
+ ## Description
8
8
 
9
- `yarn add @tryghost/nodemailer`
9
+ Provides pre-configured transport options for common transport services.
10
10
 
11
+ ### Supported Transport Types
11
12
 
12
- ## Usage
13
+ 1. `smtp` - send via SMTP server.
14
+ * Detects when service: 'sendmail' is used and enables sendmail mode
13
15
 
16
+ 2. `mailgun` - Allows using Mailgun with API key instead of via SMTP.
17
+ * `auth: { api_key: 'your-mailgun-api-key' }`
18
+ * Defaults to 60-second timeout.
19
+
20
+ 3. `sendmail` - use local sendmail binary.
21
+
22
+ 4. `ses` - [Send via AWS SES](https://ghost.org/docs/config/#amazon-ses).
23
+
24
+ 5. `direct` - Attempt to connect directly to remote SMTP servers. This is the default and requires no configuration, but is more likely to be blocked by remote mail services.
25
+
26
+ 6. `stub` - For testing and development. Doesn't actually send mail.
27
+
28
+ Other Nodemailer transports are not supported.
14
29
 
15
30
  ## Develop
16
31
 
@@ -36,4 +51,4 @@ Follow the instructions for the top-level repo.
36
51
 
37
52
  # Copyright & License
38
53
 
39
- Copyright (c) 2013-2025 Ghost Foundation - Released under the [MIT license](LICENSE).
54
+ Copyright (c) 2013-2026 Ghost Foundation - Released under the [MIT license](LICENSE).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tryghost/nodemailer",
3
- "version": "0.3.48",
3
+ "version": "0.3.49",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "git+https://github.com/TryGhost/framework.git",
@@ -24,17 +24,16 @@
24
24
  },
25
25
  "devDependencies": {
26
26
  "c8": "10.1.3",
27
- "mocha": "10.7.3",
27
+ "mocha": "11.7.5",
28
28
  "should": "13.2.3",
29
- "sinon": "18.0.0"
29
+ "sinon": "21.0.1"
30
30
  },
31
31
  "dependencies": {
32
32
  "@aws-sdk/client-ses": "^3.31.0",
33
- "@tryghost/errors": "^1.3.8",
33
+ "@tryghost/errors": "^1.3.9",
34
34
  "nodemailer": "^6.6.3",
35
35
  "nodemailer-direct-transport": "^3.3.2",
36
36
  "nodemailer-mailgun-transport": "^2.1.5",
37
37
  "nodemailer-stub-transport": "^1.1.0"
38
- },
39
- "gitHead": "e395f1d79edee4aecc36e572bb402016a8ba9273"
38
+ }
40
39
  }