Your email content
', text: 'Your email content', }) ``` ## Send method The `send` method sends an email using the MailChannels API. > [!IMPORTANT] > If you set the `bcc`, `cc`, `from`, `to` properties in the `send` method, they will override the default global settings set in the `nuxt.config.ts` or `.env` file. ### Arguments | Argument | Type | Description | Required | | --- | --- | --- | --- | | `options` | [`Options`](#options) | The email options to send | ✅ | | `dryRun` | `boolean` | When set to `true`, the message will not be sent. Instead, the fully rendered message will be returned in the `data` property of the response. The default value is `false`. | ❌ | ### Options Available options for the `send` method. | Property | Description | Required | | --- | --- | --- | | `attachments` | An array of attachments to add to the email. Each attachment should be an object with `filename`, `content`, and `type` properties. | ❌ | | `bcc` | The BCC recipients of the email. Can be an object with `email` and `name` properties or a single email address string or an array of them. | ❌ | | `cc` | The CC recipients of the email. Can be an object with `email` and `name` properties or a single email address string or an array of them. | ❌ | | `from` | The sender of the email. Can be a string or an object with `email` and `name` properties. Required when the default global sender is not set. | 🟡 | | `to` | The recipient of the email. Can be an object with `email` and `name` properties or a single email address string or an array of them. Required when the default global recipient is not set. | 🟡 | | `replyTo` | The email address to reply to. Can be a string or an object with `email` and `name` properties. | ❌ | | `subject` | The subject of the email. | ✅ | | `html` | The HTML content of the email. Required if `text` is not set. | 🟡 | | `text` | The plain text content of the email. Required if `html` is not set. | 🟡 | | `mustaches` | Data to be used if the email is a mustache template, key-value pairs of variables to set for template rendering. Keys must be strings. | ❌ | > [!TIP] > Including a plain text version of your email ensures that all recipients can read your message, including those with email clients that lack HTML support. > > You can use the [`html-to-text`](https://www.npmjs.com/package/html-to-text) package to convert your HTML content to plain text. ### Response The `send` method returns a promise that resolves to an object with the following properties. | Property | Type | Description | | --- | --- | --- | | `success` | `boolean` | Indicates the success or failure of the email sending operation. | | `data` | `string[]` or `undefined` | The fully rendered message if the `dryRun` argument is set to `true`. | ## Examples Use the `send` method inside your API routes to send emails. The recipient parameters can be either an email address string or an object with `email` and `name` properties. ### Using object recipients (recommended) This is the best way to add names to the recipients. ```ts export default defineEventHandler(async (event) => { const mailchannels = useMailChannels(event) const { success } = await mailchannels.send({ from: { email: 'from@example.com', name: 'Example 2' }, to: { email: 'to@example.com', name: 'Example 1' }, subject: 'Your subject', html: 'Your email content
', text: 'Your email content', }) return { success } }) ``` ### Using string recipients This is the simplest way to send an email. ```ts export default defineEventHandler(async (event) => { const mailchannels = useMailChannels(event) const { success } = await mailchannels.send({ from: 'from@example.com', to: 'to@example.com', subject: 'Your subject', html: 'Your email content
', text: 'Your email content', }) return { success } }) ``` ### Array of recipients You can also send an email to multiple recipients. ```ts export default defineEventHandler(async (event) => { const mailchannels = useMailChannels(event) const { success } = await mailchannels.send({ from: { email: 'from@example.com', name: 'Example 3' }, to: [ { email: 'to1@example.com', name: 'Example 1' }, { email: 'to2@example.com', name: 'Example 2' } ], subject: 'Your subject', html: 'Your email content
', text: 'Your email content', }) return { success } }) ``` or ```ts export default defineEventHandler(async (event) => { const mailchannels = useMailChannels(event) const { success } = await mailchannels.send({ from: 'from@example.com', to: ['to1@example.com', 'to2@example.com'], subject: 'Your subject', html: 'Your email content
', text: 'Your email content', }) return { success } }) ``` ### Using mustache templates You can use the `mustaches` property to render mustache templates. ```ts export default defineEventHandler(async (event) => { const mailchannels = useMailChannels(event) const { success } = await mailchannels.send({ from: 'from@example.com', to: 'to@example.com', subject: 'Mustaches test', html: 'Hello {{ world }}
', text: 'Hello {{ world }}', mustaches: { world: 'World', }, }) return { success } }) ``` ### Dry run You can set the `dryRun` argument to test your email without sending it. It will return the fully rendered message in the `data` property of the response. ```ts export default defineEventHandler(async (event) => { const mailchannels = useMailChannels(event) const response = await mailchannels.send({ from: 'from@example.com', to: 'to@example.com', subject: 'Test', html: 'Test
', text: 'Test', }, true) // <-- `true` = dryRun enabled return response }) ``` ### Name-address pairs You can use name-address pairs string format. ```ts export default defineEventHandler(async (event) => { const mailchannels = useMailChannels(event) const { success } = await mailchannels.send({ from: 'Sender NameYour email content
', text: 'Your email content', }) return { success } }) ``` ## Contribution