Files
medusa-store/packages/medusa-plugin-sendgrid
Zakaria El Asri 9fa4238ee4 chore: improve ci pipeline (#1764)
* fix: caching deps + add true parallelization to integration tests api

* fix: github action

* chore: upgrade to yarn berry (#1762)

* init migration

* remove: yarn.lock from all pkgs

* fix: build script in pkgs

* adjust yarn config

* fix: yarn.lock and yarnrc.yml

* fix: github actions

* fix: wrong type

* fix (medusa-react): use dts-cli instead of tsdx

* fix: yarn.lock

* fix: yarn v

* fix: prepare script

* add: comment on why we need to downgrade yarn before medusa-dev

* chore: move to Turborepo (#1763)

* increase number of parallel nodes

* fix (medusa-fulfillment-webshipper): build script

* fix: use new version of medusa-dev

* fix: rename cache-bootstrap to cache-deps
2022-07-10 12:11:11 +02:00
..
2022-07-05 09:51:23 +02:00
2022-05-20 11:40:57 +03:00

medusa-plugin-sendgrid

Sendgrid Plugin for Medusa to send transactional emails.

Learn more about how you can use this plugin in the documentaion.

Options

If no values are defined for a given option, the plugin will not try to send an email for that event.

{
  api_key: "SENDGRID_API_KEY", //required
  from: "[the from field, i.e. ACME <acme@mail.com>]", //required
  gift_card_created_template: "[used on gift_card.created]",
  order_placed_template: "[used on order.placed]",
  order_canceled_template: "[used on order.canceled]",
  order_shipped_template: "[used on order.shipment_created]",
  order_completed_template: "[used on order.completed]",
  user_password_reset_template: "[used on user.password_reset]",
  customer_password_reset_template: "[used on customer.password_reset]",
  localization: {
    "de-DE": { // locale key
      gift_card_created_template: "[used on gift_card.created]",
      order_placed_template: "[used on order.placed]",
      order_canceled_template: "[used on order.canceled]",
      order_shipped_template: "[used on order.shipment_created]",
      order_completed_template: "[used on order.completed]",
      user_password_reset_template: "[used on user.password_reset]",
      customer_password_reset_template: "[used on customer.password_reset]",
    }
  }
}

Dynamic usage

You can resolve the SendGrid service to dynamically send emails via sendgrid.

Example:


const sendgridService = scope.resolve("sendgridService")
sendgridService.sendEmail("d-123....", "ACME <acme@mail.com>", "customer@mail.com", { dynamic: "data" })