Skip to main content

Emails and Messages

Saleor version required: 3.10Repository: GitHub

Deprecation notice​

If you plan to use SMTP server, please use the SMTP app instead. Emails and Messages app is being split into separate SMTP and Sendgrid apps.

Introduction

Emails and messages (EAM) application is responsible for sending emails and messages to the customers. It is connected to the Saleor API via webhooks, which notify the application about the events. The messages are delivered by external providers configured in the application.

Supported providers​

Emails and Messages app currently supports the following providers:

  • Sendgrid - Create templates in the Sendgrid visual editor and send them to your customers.
  • SMTP - Use your own SMTP server to send emails. Email templates are created using MJML and handlebars.

Supported events​

Account confirmation​

A message containing an account activation token after registration. To activate the account, your storefront should perform an API call according to the documentation.

If you don't want to use the email confirmation, you can disable it in the Saleor dashboard:

  1. Open the Saleor dashboard
  2. Navigate to the Configuration page
  3. Click on the Site settings card
  4. Update the User registration form

The event has been implemented using the NOTIFY_USER webhook.

Account password reset​

Message sent after requesting a password change. The payload contains a token that has to be attached to the request to the Saleor API to change the password. To implement a storefront interface for password change, follow the documentation.

The event has been implemented using the NOTIFY_USER webhook.

Account password reset for staff-created accounts​

As in the previous event, but for accounts created by Staff users in the Saleor Dashboard.

The event has been implemented using the NOTIFY_USER webhook.

Account email address change​

Message sent on the email address change request. Follow the documentation for more details.

The event has been implemented using the NOTIFY_USER webhook.

Account email change confirmation​

Confirmation is sent to the new address after following instructions from the previous message.

The event has been implemented using the NOTIFY_USER webhook.

Account deletion request​

A message with a token that's used for account deletion. To implement a storefront interface for account deletion, follow the documentation.

The event has been implemented using the NOTIFY_USER webhook.

Invoice sent​

The event is triggered when the Staff users use the Sent invoice action. The message contains a link to the invoice.

The event has been implemented using the INVOICE_SENT webhook.

Order confirmation​

Sends a message when the order is confirmed.

The event has been implemented using the ORDER_CONFIRMED webhook.

Order has been fulfilled​

Sends a message when the order status is changed to FULFILLED.

The event has been implemented using the ORDER_FULFILLED webhook.

Order has been fully paid​

Sends a message when the order is fully paid.

The event has been implemented using the ORDER_FULLY_PAID webhook.

Order has been canceled​

Sends a message when the order is canceled.

The event has been implemented using the ORDER_CANCELLED webhook.

Sent gift card​

Sends a message when the gift card is sent to the customer.

The event has been implemented using the GIFT_CARD_SENT webhook.

Configuration​

The application can use multiple providers at the same time. This way, you'll be able to:

  • create test configurations before using them in production
  • use different providers for different events
  • use different providers for different channels

Multichannel​

Each provider can be configured to work with specific channels. The configurations are used for all the channels by default. It can be changed in the configuration details to:

  • use only the specific channels
  • use all channels except the specific ones

Development​

To run the application locally, follow the documentation.

Known limitations and issues​

  • When the application has multiple active configurations and one of them fails, it may result in duplicated email deliveries. Issue link
  • Emails use the default language of the Saleor instance. Using translations is not supported yet. Issue link
  • The order refunded event is not supported yet. Issue link
  • The fulfillment updated event is not supported yet. Issue link