asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

added readme links

Browse Source
This commit is contained in:
Shahed Nasser
2022-05-20 11:40:57 +03:00
parent 636edb6530
commit be3ad001ee
12 changed files with 127 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/medusa-plugin-sendgrid/README.md
+20 -18
View File
@@ -2,30 +2,32 @@
Sendgrid Plugin for Medusa to send transactional emails.
Learn more about how you can use this plugin in the [documentaion](https://docs.medusajs.com/add-plugins/sendgrid).
## Options
If no values are defined for a given option, the plugin will not try to send an email for that event.
## Plugin Options
```
```js
{
api_key: [your 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],
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],
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]",
}
}
}