strapi/docs/3.0.0-beta.x/guides/email.md

Email

::: note This feature requires the Email plugin (installed by default). :::

Thanks to the plugin Email, you can send email on your server or externals providers such as Sendgrid.

Programmatic usage

await strapi.plugins['email'].services.email.send({
  to: 'paulbocuse@strapi.io',
  from: 'joelrobuchon@strapi.io',
  replyTo: 'no-reply@strapi.io',
  subject: 'Use strapi email provider successfully',
  text: 'Hello world!',
  html: 'Hello world!',
});

Install new providers

By default Strapi provides a local email system. You might want to send email with a third party.

You can check all the available providers developed by the community on npmjs.org - Providers list

To install a new provider run:

:::: tabs cache-lifetime="10" :options="{ useUrlFragment: false }"

::: tab "yarn"

yarn add strapi-provider-email-sendgrid@beta --save

:::

::: tab "npm"

npm install strapi-provider-email-sendgrid@beta --save

:::

::::

::: note If the provider is not in the mono repo, you probably don't need @beta depending if the creator published it with this tag or not. :::

Configure the plugin

The plugin provide you a setting page to be able to define the email provider you want to use. You will also be able to add some configuration.

• Click on Plugins in the left menu
• Click on the cog button on the Email plugin line

Create new provider

If you want to create your own, make sure the name starts with strapi-provider-email- (duplicating an existing one will be easier), modify the auth config object and customize the send function.

Default template

module.exports = {
  provider: 'provider-id',
  name: 'display name',
  auth: {
    config_1: {
      label: 'My Config 1',
      type: 'text',
    },
  },
  init: config => {
    return {
      send: async options => {},
    };
  },
};

In the send function you will have access to:

• config that contain configuration you setup in your admin panel
• options that contain option your send when you called the send function from the email plugin service