feat: update dependencies (#32)

.gitignore

@@ -63,3 +63,6 @@ profile*
 
 # package-lock
 package-lock.json
+
+# node-tap
+.tap

README.md

@@ -1,18 +1,19 @@
-## fastify-mail
+# fastify-mail
 
 A [Fastify](https://www.fastify.io/) plugin that uses [point-of-view](https://github.com/fastify/point-of-view#readme) and [fastify-nodemailer](https://github.com/lependu/fastify-nodemailer#readme) to template and send email messages.
 
-### Usage
+## Usage
 
 ```sh
 npm i @autotelic/fastify-mail
 ```
 
-### Setup
+## Setup
 
 `fastify-mail` decorates the reply interface with the `mail` method and takes two options to get started: `pov` and `transporter`
 
-##### Point-of-View
+### Point-of-View
+
 - `pov.engine` should be a template engine object used to configure point-of-view
 - to see a list of engines currently supported by point-of-view with options, [view docs here](https://github.com/fastify/point-of-view/blob/master/index.d.ts)
 - For quick start, `fastify-mail` only requires the engine. For example, using `nunjucks`:
@@ -23,14 +24,17 @@ npm i @autotelic/fastify-mail
 
 - If you'd prefer to register `point-of-view` on your own, omit the `engine` option and `fastify-mail` will not register it.
 - If you configure `point-of-view` with a different decorator name, add this to the options of `fastify-mail`
+
   ```js
   fastify.register(mail, { pov: { propertyName: 'POV_DECORATOR' }, transporter: ... })
   ```
 
-##### Nodemailer
+### Nodemailer
+
 - `transporter` should be an object defining connection data to be used as a `nodemailer` SMTP transport. [View nodemailer's docs here](https://nodemailer.com/smtp/)
 - `fastify-mail` decorates `fastify` with `nodemailer` so a transporter must be defined
 - For example, using `maildev`:
+
   ```js
   const transporter = {
     host: 'localhost',
@@ -41,7 +45,7 @@ npm i @autotelic/fastify-mail
   fastify.register(mail, { pov: { engine: ... }, transporter })
   ```
 
-### Example
+## Example
 
 ```js
 // index.js
@@ -78,69 +82,73 @@ fastify.get("/sendmail", async (req, reply) => {
 })
 ```
 
-#### Templates
+## Templates
+
 Each message must have the following templates with the file extension set in point-of-view config:
-  - 'html': Contains the html template for the email.
-  - 'text': Contains the text template for the email.
 
-```
+- 'html': Contains the html template for the email.
+- 'text': Contains the text template for the email.
+
+```sh
 .
 |--index.js
 |--templates
     |-- html.njk
     |-- text.njk
 ```
 
-#### Example Apps
+## Example Apps
+
 See [/examples/mailgun](./examples/mailgun) for a working example app using [nodemailer-mailgun-transport](https://github.com/xr0master/mailgun-nodemailer-transport#readme).
 
 See [/examples/maildev](./examples/maildev) for a working example app using [MailDev](https://maildev.github.io/maildev/)
 
-### API
+## API
 
-#### Decorator
+### Decorator
 
 This plugin decorates fastify with a `mail` object containing the following methods:
 
--  sendMail: 'function' - Calls `createMessage` to generate an message and uses [fastify-nodemailer](https://github.com/lependu/fastify-nodemailer) to send the generated email. 
-  - Accepts the following arguments: 
-    - message: 'object'
-            *This is a valid 'message' object as per the Nodemailer API*
-        - from: 'string' - The email address the email is to be sent from.
-        - to: 'array' - Comma separated list or an array of recipients email addresses (`string`) that will appear on the To: field
-        - cc: 'array' - Comma separated list or an array of recipients email addresses (`string`) that will appear on the Cc: field
-        - bcc: 'array' - Comma separated list or an array of recipients email addresses (`string`) that will appear on the Bcc: field
-        - replyTo : 'string' - An email address that will appear on the Reply-To: field
-        - subject: 'string' - The subject of the email with context injected.
-        - html: 'string' - The HTML version of the message as an Unicode string, with context injected.
-        - text : 'string' - The plaintext version of the message as an Unicode string, with context injected
-
-    - opts: 'object' - Object containing options:
-        -  templatePath:  'string' - the relative path to the message's templates.
-        -  context: 'object' - Object containing context for the message (such as - variables that will be used in copy)
-
-  - Returns: 'object' with following properties:
-    - accepted : 'array' of email addresses accepted - eg. [ 'test@example.com' ]
-    - rejected : 'array' of email addresses rejected - eg. [],
-    - envelopeTime
-    - messageTime 
-    - messageSize 
-    - response 
-    - envelope 
-    - messageId
+- sendMail: 'function' - Calls `createMessage` to generate an message and uses [fastify-nodemailer](https://github.com/lependu/fastify-nodemailer) to send the generated email.
+- Accepts the following arguments:
+  - message: 'object'
+          *This is a valid 'message' object as per the Nodemailer API*
+    - from: 'string' - The email address the email is to be sent from.
+    - to: 'array' - Comma separated list or an array of recipients email addresses (`string`) that will appear on the To: field
+    - cc: 'array' - Comma separated list or an array of recipients email addresses (`string`) that will appear on the Cc: field
+    - bcc: 'array' - Comma separated list or an array of recipients email addresses (`string`) that will appear on the Bcc: field
+    - replyTo : 'string' - An email address that will appear on the Reply-To: field
+    - subject: 'string' - The subject of the email with context injected.
+    - html: 'string' - The HTML version of the message as an Unicode string, with context injected.
+    - text : 'string' - The plaintext version of the message as an Unicode string, with context injected
+
+  - opts: 'object' - Object containing options:
+    - templatePath:  'string' - the relative path to the message's templates.
+    - context: 'object' - Object containing context for the message (such as - variables that will be used in copy)
+
+- Returns: 'object' with following properties:
+  - accepted : 'array' of email addresses accepted - eg. [ 'test@example.com' ]
+  - rejected : 'array' of email addresses rejected - eg. [],
+  - envelopeTime
+  - messageTime
+  - messageSize
+  - response
+  - envelope
+  - messageId
 
 - createMessage: 'function' - Generates a message object where the data provided is updated to use templates where available with context variables injected
-  - Accepts the following arguments: 
+  - Accepts the following arguments:
     - message: 'object'
       - fields as above
     - templatePath: 'string' - the relative path to the message's templates.
     - context: 'object' - Object containing context for the message (such as - variables that will be used in copy)
 
-    For more details on this response see the Nodemail documentation [View nodemailer's docs here](https://nodemailer.com/smtp/)
+    For more details on this response see the nodemailer documentation [View nodemailer's docs here](https://nodemailer.com/smtp/)
 
 ### Testing
 
 [Tap](https://node-tap.org/) is used for testing. To run tests:
+
+```sh
+npm test
 ```
-$ npm test
-```

examples/maildev/README.md

@@ -1,7 +1,5 @@
 # Fastify-Mail Plugin with MailDev Example
 
-### Setup:
-
 - Fork and clone [fastify-mail repo](https://github.com/autotelic/fastify-mail).
 - Install dependencies: `npm i`
 - Change directory to `examples/maildev` and install dependencies:
@@ -14,8 +12,7 @@
 - Run a new docker container to get mailDev running:
 
   ```sh
-  docker pull maildev/maildev
-  docker run -p 1080:80 -p 1025:25 --name maildev maildev/maildev
+  docker run -p 1080:1080 -p 1025:1025 maildev/maildev bin/maildev --base-pathname /maildev -w 1080 -s 1025
   ```
 
 - Open a new terminal and run fastify-mail example:
@@ -27,6 +24,3 @@
 - Open a browser to `localhost:1080` to view test inbox.
 - Send a GET request to `localhost:3000/sendmail` and watch it appear at `localhost:1080`.
 - Send a GET request to `localhost:3000/no-templates` for a version where no templates are provided
-
-
-

examples/maildev/index.js

@@ -45,7 +45,7 @@ module.exports = async function (fastify, options) {
       '</html>\n'
 
     const message = {
-      to: ['test@example.com'],
+      to: 'test@example.com',
       from: 'someone@example.com',
       subject: 'Test Subject',
       html: testHtml,

examples/maildev/package.json

@@ -6,8 +6,8 @@
     "start": "fastify start index.js -l info -w"
   },
   "dependencies": {
-    "fastify": "^3.0.0",
-    "fastify-cli": "^2.5.1",
-    "nunjucks": "^3.2.2"
+    "fastify": "^4.25.2",
+    "fastify-cli": "^6.0.0",
+    "nunjucks": "^3.2.4"
   }
 }

examples/mailgun/.env.example

@@ -1,4 +1,4 @@
 export MAILGUN_API_KEY=1234
 export MAILGUN_DOMAIN=sandbox...mailgun.org
-export RECIPIENTS=example@email.com
-export SENDER=example@email.com
+export RECIPIENT=example@email.com
+export SENDER=example@email.com

examples/mailgun/README.md

@@ -1,7 +1,5 @@
 # Fastify-Mail Plugin with mailgun Example
 
-### Setup:
-
 - Fork and clone [fastify-mail repo](https://github.com/autotelic/fastify-mail).
 - Install dependencies: `npm i`
 - change directory to `examples/mailgun` and install dependencies:

examples/mailgun/index.js

@@ -16,11 +16,14 @@ module.exports = async function (fastify, options) {
   await fastify.register(fastifyMail, { pov: { engine: { nunjucks } }, transporter })
 
   fastify.get('/sendmail', async (req, reply) => {
-    const recipients = [process.env.RECIPIENTS]
-    const templates = './templates'
+    const templatePath = './templates'
     const context = { name: 'Test Name', sender: process.env.SENDER }
 
-    const queued = await fastify.mail.sendMail(recipients, templates, context)
+    const queued = await fastify.mail.sendMail({
+      to: process.env.RECIPIENT,
+      from: process.env.SENDER,
+      subject: 'fastify-mail test'
+    }, { templatePath, context })
     if (queued.error) {
       const { error } = queued
       reply.send(error)

examples/mailgun/package.json

@@ -6,9 +6,9 @@
     "start": "fastify start index.js -l info -w"
   },
   "dependencies": {
-    "fastify": "^3.0.0",
-    "fastify-cli": "^2.5.1",
-    "nodemailer-mailgun-transport": "^2.0.2",
-    "nunjucks": "^3.2.2"
+    "fastify": "^4.25.2",
+    "fastify-cli": "^6.0.0",
+    "nodemailer-mailgun-transport": "^2.1.5",
+    "nunjucks": "^3.2.4"
   }
 }

index.js

@@ -33,7 +33,7 @@ const fastifyMail = async (fastify, opts) => {
   // mail decorator configurations:
   const mail = {
     // the method that external users will call to send emails
-    // it either sends the messsage straight to nodemailer or uses createMessage to render templates if opts.templatePath is a provided
+    // it either sends the message straight to nodemailer or uses createMessage to render templates if opts.templatePath is a provided
     sendMail: async function (message, opts = {}) {
       try {
         const errors = this.validateMessage(message)