medusa-plugin-brevo-email v1.0.22
medusa-plugin-brevo-email
Notifications plugin for Medusa ecommerce server that sends transactional emails via Brevo.
Features
- Uses the email templating features built into BREVO
- The plugin is in active development. If you have any feature requests, please open an issue.
- Create PDF invoices and credit notes and attach them to the email
- Send out upsell emails to customers that have recently placed an order with certain collections
- Send out automated abandoned cart emails to customers that have abandoned their cart (based on last updated date of cart)
- Support different languages base on countrycode or locale. (Need to add "locale or countryCode to cart context on frontend)
Configuration
Enable in your medusa-config.js file similar to other plugins:
More events? (work in progress within the plugin!) See here
Config example with multi language
const plugins = [
// ... other plugins
{
resolve: `medusa-plugin-brevo-email`,
options: {
api_key: process.env.BREVO_API_KEY,
from_email: process.env.BREVO_FROM_EMAIL,
from_name: process.env.BREVO_FROM_NAME,
// Event templates with countryCode and locale support
events: {
order: {
placed: {
en: process.env.BREVO_ORDER_PLACED_EN || 3,
vn: process.env.BREVO_ORDER_PLACED_VN || 11, // Vietnamese template
default: process.env.BREVO_ORDER_PLACED || 3, // Fallback if neither countryCode nor locale match
},
canceled: {
en: process.env.BREVO_ORDER_CANCELED_EN || 6,
vn: process.env.BREVO_ORDER_CANCELED_VN || 14, // Vietnamese template
default: process.env.BREVO_ORDER_CANCELED || 6, // Fallback if neither countryCode nor locale match
},
shipment_created: {
en: process.env.BREVO_ORDER_SHIPMENT_CREATED_EN || 4,
vn: process.env.BREVO_ORDER_SHIPMENT_CREATED_VN || 10, // Vietnamese template
default: process.env.BREVO_ORDER_SHIPMENT_CREATED || 4, // Fallback if neither countryCode nor locale match
},
},
customer: {
created: {
en: process.env.BREVO_CUSTOMER_CREATED_EN || 7,
vn: process.env.BREVO_CUSTOMER_CREATED_VN || 12, // Vietnamese template
default: process.env.BREVO_CUSTOMER_CREATED || 7, // Fallback if neither countryCode nor locale match
},
password_reset: {
en: process.env.BREVO_CUSTOMER_PASSWORD_RESET_EN || 5,
vn: process.env.BREVO_CUSTOMER_PASSWORD_RESET_VN || 5, // Vietnamese template
default: process.env.BREVO_CUSTOMER_PASSWORD_RESET || 5, // Fallback if neither countryCode nor locale match
},
},
user: {
password_reset: {
en: process.env.BREVO_USER_PASSWORD_RESET_EN || 5,
vn: process.env.BREVO_USER_PASSWORD_RESET_VN || 5, // Vietnamese template
default: process.env.BREVO_USER_PASSWORD_RESET || 5, // Fallback if neither countryCode nor locale match
},
},
},
// Contact list settings
contact_list: {
enabled: process.env.BREVO_CONTACT_LIST_ENABLED || true,
contact_list_id: process.env.BREVO_CONTACT_LIST_ID || 2,
},
// Abandoned cart settings with locale and countryCode support
abandoned_cart: {
enabled: process.env.BREVO_ABANDONED_CART_ENABLED || false,
first: {
delay: process.env.BREVO_ABANDONED_CART_FIRST_DELAY || 24, // Delay in hours
template: {
en: process.env.BREVO_ABANDONED_CART_FIRST_TEMPLATE_EN || 2,
vn: process.env.BREVO_ABANDONED_CART_FIRST_TEMPLATE_VN || 13, // Vietnamese template
default: process.env.BREVO_ABANDONED_CART_FIRST_TEMPLATE || 2, // Fallback if neither countryCode nor locale match
},
},
second: {
delay: process.env.BREVO_ABANDONED_CART_SECOND_DELAY || 72, // Delay in hours
template: {
en: process.env.BREVO_ABANDONED_CART_SECOND_TEMPLATE_EN || 2,
vn: process.env.BREVO_ABANDONED_CART_SECOND_TEMPLATE_VN || 13, // Vietnamese template
default: process.env.BREVO_ABANDONED_CART_SECOND_TEMPLATE || 2, // Fallback if neither countryCode nor locale match
},
},
},
},
},
]
const plugins = [
// ... other plugins
{
resolve: `medusa-plugin-brevo-email`,
options: {
api_key: process.env.BREVO_API_KEY,
from_email: process.env.BREVO_FROM_EMAIL,
from_name: process.env.BREVO_FROM_NAME,
bcc: process.env.BREVO_BCC || null,
contact_list: {
enabled: process.env.BREVO_CONTACT_LIST_ENABLED || true,
contact_list_id: process.env.BREVO_CONTACT_LIST_ID || 2
},
pdf: {
enabled: process.env.BREVO_PDF_ENABLED || false,
settings: {
font: process.env.BREVO_PDF_FONT || 'Helvetica',
// [{file: 'yourfont.ttf', name: 'yourfont'},{file: 'yourfont-bold.ttf', name: 'yourfontbold'}]
format: process.env.BREVO_PDF_FORMAT || 'A4',
// see supported formats here: https://pdfkit.org/docs/paper_sizes.html
margin: {
top: process.env.BREVO_PDF_MARGIN_TOP || '50',
right: process.env.BREVO_PDF_MARGIN_RIGHT || '50',
bottom: process.env.BREVO_PDF_MARGIN_BOTTOM || '50',
left: process.env.BREVO_PDF_MARGIN_LEFT || '50'
},
empty: "" // what to show if variable can't be found. Defaults to __UNDEFINED__
},
header: {
enabled: process.env.BREVO_PDF_HEADER_ENABLED || false,
content: process.env.BREVO_PDF_HEADER_CONTENT || null,
// loads empty header if null, otherwise loads the file from `BREVO_PDF_HEADER_CONTENT`
height: process.env.BREVO_PDF_HEADER_HEIGHT || '50'
},
footer: {
enabled: process.env.BREVO_PDF_FOOTER_ENABLED || false,
content: process.env.BREVO_PDF_FOOTER_CONTENT || null,
// loads empty footer if null, otherwise loads the file from `BREVO_PDF_FOOTER_CONTENT`
},
templates: {
invoice: process.env.BREVO_PDF_INVOICE_TEMPLATE || null,
credit_note: process.env.BREVO_PDF_CREDIT_NOTE_TEMPLATE || null,
return_invoice: process.env.BREVO_PDF_RETURN_INVOICE_TEMPLATE || null
}
},
events: {
order: {
placed: process.env.BREVO_ORDER_PLACED || null,
canceled: process.env.BREVO_ORDER_CANCELED || null,
shipment_created: process.env.BREVO_ORDER_SHIPMENT_CREATED || null,
},
customer: {
created: process.env.BREVO_CUSTOMER_CREATED || null,
password_reset: process.env.BREVO_CUSTOMER_PASSWORD_RESET || null,
},
user: {
created: process.env.BREVO_USER_CREATED || null,
password_reset: process.env.BREVO_USER_PASSWORD_RESET || null,
},
auth: {
password_reset: process.env.BREVO_AUTH_PASSWORD_RESET || null,
verify_account: process.env.BREVO_AUTH_VERIFY_ACCOUNT || null,
},
activity: {
inactive_user: process.env.BREVO_ACTIVITY_INACTIVE_USER || null,
inactive_customer: process.env.BREVO_ACTIVITY_INACTIVE_CUSTOMER || null,
}
},
upsell: {
enabled: process.env.BREVO_UPSELL_ENABLED || false,
template: process.env.BREVO_UPSELL_TEMPLATE || null, // if you supply multiple templates (comma seperated), the plugin will pick one at random
delay: process.env.BREVO_UPSELL_DELAY || 9, // delay in days
valid: process.env.BREVO_UPSELL_VALID || 30, // valid in days
collection: process.env.BREVO_UPSELL_COLLECTION || null,
},
abandoned_cart: {
enabled: process.env.BREVO_ABANDONED_CART_ENABLED || false,
first: {
delay: process.env.BREVO_ABANDONED_CART_FIRST_DELAY || 1, // delay in hours
template: process.env.BREVO_ABANDONED_CART_FIRST_TEMPLATE || null, // if you supply multiple templates (comma seperated), the plugin will pick one at random
},
second: {
delay: process.env.BREVO_ABANDONED_CART_SECOND_DELAY || 24, // delay in hours
template: process.env.BREVO_ABANDONED_CART_SECOND_TEMPLATE || null, // if you supply multiple templates (comma seperated), the plugin will pick one at random
},
third: {
delay: process.env.BREVO_ABANDONED_CART_THIRD_DELAY || 48, // delay in hours
template: process.env.BREVO_ABANDONED_CART_THIRD_TEMPLATE || null, // if you supply multiple templates (comma seperated), the plugin will pick one at random
},
},
default_data: {
// ... default data to be passed to the email template
product_url: process.env.BREVO_PRODUCT_URL || '',
product_name: process.env.BREVO_PRODUCT_NAME || '',
company_name: process.env.BREVO_COMPANY_NAME || '',
company_address: process.env.BREVO_COMPANY_ADDRESS || '',
}
}
}
]
Templates
The plugin uses the BREVO template system for emails. For attachments the plugin relies on the pdfkit library.
In your JSON templates you can use several types (and variables):
image
for (local) imagestext
for simple words, (long) sentences, paragraphs and linksmoveDown
for moving the cursor down one linehr
for a horizontal linetableRow
for a table(-like) rowitemLoop
for looping over items in an orderitemLoopEnd
for ending the item loop
Example:
[
{
"type": "image",
"image": "image.png",
"x": 100,
"y": 100,
"fit": [200, 50]
},
{
"type": "text",
"text": "This is a text",
"size": 20
},
{
"type": "moveDown",
"lines": 2
},
{
"type": "hr"
},
{
"type": "moveDown",
"lines": 2
},
{
"type": "text",
"text": "Another text"
}
]
image
Images are stored in /src/images/
and can be used in the template like this:
{
"type": "image",
"image": "image.png",
"x": 100,
"y": 100,
"fit": [200, 50]
}
fit
has multiple options, see here for more info.
Optional:
align
horizontally align the image, the possible values areleft
,center
, orright
valign
vertically align the image, the possible values aretop
,center
, orbottom
text
Text can be used for words, sentences, paragraphs and links.
{
"type": "text",
"text": "This is a text"
}
If you use moveDown
correct you won't need to use x
and y
for the text.
Optional:
These options can be used to style the text or to position it.
x
the x position of the texty
the y position of the textfont
the font of the textsize
the font size of the textcolor
the color of the text (Hex codes#ff0000
)width
the width of the textalign
the alignment of the text, the possible values areleft
,center
,right
, orjustify
.
For more styling options, see here for more info.
moveDown
This is used to move the cursor down one or more line(s).
{
"type": "moveDown",
"lines": 1
}
hr
This is used to draw a horizontal line.
{
"type": "hr"
}
Optional:
color
the color of the line (Hex codes#ff0000
)width
the width of the line if you don't want it to be the full width of the pageheight
the height of the line element, including paddingy
the y position of the line if you can not rely on the cursor (affected bymoveDown
)
tableRow
This is used to draw a table row.
{
"type": "tableRow",
"columns": [
{
"text": "Column 1",
"width": 200
},
{
"text": "Column 2",
"width": 150
}
]
}
Optional:
You can use the same options as for text
to style the text in the table row. If you want a special column styled, you can add the options to the column object.
## Acknowledgement
This plugin is originally based on medusa-plugin-postmark by Fullstack-nl.
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago