Integration Module 2.0 for Medusa is outRead the announcement
Mail Templates logo

Mail Templates

Create email templates for Medusa

npm install @vymalo/medusa-mail
Built by
Version
1.0.9
Last updated
1 year ago
Monthly downloads
Loading downloads

MedusaJS Mail Templates

๐Ÿ“ง Powerful, Flexible Email Templating for MedusaJS

๐ŸŒŸ Features

  • Advanced email template generation
  • Nodemailer integration
  • SMTP and transport flexibility
  • Preview and development modes
  • Internationalization support
  • Extensive customization options

๐Ÿ“ฆ Installation

Install the package using npm:

Or using yarn:

๐Ÿ”ง Configuration Types

๐Ÿš€ Usage Example

๐Ÿ› ๏ธ Key Configuration Options

Message Configuration

  • : Nodemailer message options
    • : Sender email address
    • , , : Recipient configurations
    • : Email subject

Transport Options

  • : Connection method
    • SMTP:
    • SendGrid, Mailgun, etc.
  • Supports all Nodemailer transport methods

Rendering Modes

  • : Enable/disable actual email sending
  • : Generate email preview
  • : Render text-only emails
  • : Use custom rendering function

Internationalization

  • : Enable template translations
  • Supports various internationalization libraries

๐ŸŒ Environment Considerations

  • Use different configurations per environment
  • Disable sending in development
  • Enable email previews
  • Secure sensitive transport credentials

๐Ÿ”’ Security Best Practices

  • Use environment variables for credentials
  • Limit preview and sending in production
  • Implement proper error handling
  • Validate email configurations

๐Ÿค Contributing

Contributions welcome!

  • Improve template rendering
  • Add new transport methods
  • Enhance internationalization support

๐Ÿ“„ License

Check the license