@payloadcms/email-nodemailer 3.0.0-beta.17 → 3.0.0-beta.19

package/README.md

@@ -1 +1,72 @@
-# Nodemailer Email Adapter
+# Nodemailer Email Adapter for Payload
+
+This adapter allows you to send emails using the [Nodemailer](https://nodemailer.com/) library.
+
+It abstracts all of the email functionality that was in Payload by default in 2.x into a separate package.
+
+**NOTE:** Configuring email in Payload 3.0 is now completely optional. However, you will receive a startup warning that email is not configured and also a message if you attempt to send an email.
+
+## Installation
+
+```sh
+pnpm add @payloadcms/email-nodemailer` nodemailer
+```
+
+## Usage
+
+### Using nodemailer.createTransport
+
+```ts
+import { nodemailerAdapter } from '@payloadcms/email-nodemailer'
+import nodemailer from 'nodemailer'
+
+export default buildConfig({
+  email: nodemailerAdapter({
+    defaultFromAddress: 'info@payloadcms.com',
+    defaultFromName: 'Payload',
+    // Any Nodemailer transport
+    transport: await nodemailer.createTransport({
+      host: process.env.SMTP_HOST,
+      port: 587,
+      auth: {
+        user: process.env.SMTP_USER,
+        pass: process.env.SMTP_PASS,
+      },
+    }),
+  }),
+})
+```
+
+### Using transportOptions
+
+```ts
+import { nodemailerAdapter } from '@payloadcms/email-nodemailer'
+
+export default buildConfig({
+  email: nodemailerAdapter({
+    defaultFromAddress: 'info@payloadcms.com',
+    defaultFromName: 'Payload',
+    // Nodemailer transportOptions
+    transportOptions: {
+      host: process.env.SMTP_HOST,
+      port: 587,
+      auth: {
+        user: process.env.SMTP_USER,
+        pass: process.env.SMTP_PASS,
+      },
+    },
+  }),
+})
+```
+
+During development, if you pass nothing to `nodemailerAdapter`, it will use the [ethereal.email](https://ethereal.email) service.
+
+This will log the ethereal.email details to console on startup.
+
+```ts
+import { nodemailerAdapter } from '@payloadcms/email-nodemailer'
+
+export default buildConfig({
+  email: nodemailerAdapter(), // This will be the old ethereal.email functionality
+})
+```

package/package.json

@@ -1,24 +1,16 @@
 {
   "name": "@payloadcms/email-nodemailer",
-  "version": "3.0.0-beta.17",
+  "version": "3.0.0-beta.19",
   "description": "Payload Nodemailer Email Adapter",
+  "homepage": "https://payloadcms.com",
   "repository": {
     "type": "git",
     "url": "https://github.com/payloadcms/payload.git",
     "directory": "packages/email-nodemailer"
   },
   "license": "MIT",
-  "homepage": "https://payloadcms.com",
   "author": "Payload CMS, Inc.",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
   "type": "module",
-  "dependencies": {
-    "nodemailer": "6.9.10"
-  },
-  "peerDependencies": {
-    "payload": "3.0.0-beta.17"
-  },
   "exports": {
     ".": {
       "import": "./dist/index.js",
@@ -26,24 +18,32 @@
       "types": "./dist/index.d.ts"
     }
   },
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/"
-  },
-  "engines": {
-    "node": ">=18.20.2"
-  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
+  "dependencies": {
+    "nodemailer": "6.9.10"
+  },
   "devDependencies": {
     "@types/nodemailer": "6.4.14",
-    "payload": "3.0.0-beta.17"
+    "payload": "3.0.0-beta.19"
+  },
+  "peerDependencies": {
+    "payload": "3.0.0-beta.19"
+  },
+  "engines": {
+    "node": ">=18.20.2"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
     "build": "pnpm build:swc && pnpm build:types",
+    "build:clean": "find . \\( -type d \\( -name build -o -name dist -o -name .cache \\) -o -type f -name tsconfig.tsbuildinfo \\) -exec rm -rf {} + && pnpm build",
     "build:swc": "swc ./src -d ./dist --config-file .swcrc",
     "build:types": "tsc --emitDeclarationOnly --outDir dist",
-    "build:clean": "find . \\( -type d \\( -name build -o -name dist -o -name .cache \\) -o -type f -name tsconfig.tsbuildinfo \\) -exec rm -rf {} + && pnpm build",
     "clean": "rimraf {dist,*.tsbuildinfo}"
   }
 }