This is a test email sent using Medusa Emails in a Cloud project.
", subject: "Welcome to Medusa Emails", }, }) } ) ``` ### Scheduled Job / Subscriber / API Route ```ts import { Modules } from "@medusajs/framework/utils" // ... const notificationModuleService = container.resolve( Modules.NOTIFICATION ) await notificationModuleService.createNotifications({ // must either have an added sender domain or use an email // address that belongs to your Cloud organization to: "user@example.com", channel: "email", content: { html: "This is a test email sent using Medusa Emails in a Cloud project.
", subject: "Welcome to Medusa Emails", }, }) ``` When this code is executed in your Cloud project, Medusa sends the email using Medusa Emails. You can track whether the email was delivered on the [Email Activity page](#monitor-email-sending-activity-on-cloud). ### Writing Email Templates To write email templates for Medusa Emails, use packages like [react-email](https://react.email). React Email lets you create email templates using React components with preview and testing capabilities. Refer to the [Set Up React Email Templates](./react-email/page.mdx) guide to learn how to set up React Email templates in your Cloud project with examples. *** ## Add Email Sender Domain to Cloud ### Prerequisites Verified email sender domains are available for Launch, Scale, and Enterprise plans only. Learn more about plan features on the [pricing page](../pricing/page.mdx). To send emails to external email addresses using Medusa Emails, you need to add an email sender domain in your Cloud organization. You can add multiple sender domains if needed. To add your email sender domain: You can also navigate to the sender domains form from the [command palette](../command-palette/page.mdx). Press + K and select **Add Sender Domain**. 1. If you're in a different organization, [switch to the organization](../organizations/page.mdx#switch-organization). 2. Click **Projects** in the sidebar and select a project. 3. Click **Emails** -> **Sender Domains** from the sidebar. 4. Click the **Add sender domain** button. 5. In the form that opens, enter the domain you want to add (for example, `yourdomain.com`) and click **Continue**. After submitting, you'll be taken to the domain's detail page where the required DNS records are shown. Add these records to your domain's DNS settings: - **DKIM** (labeled **Required**): DomainKeys Identified Mail records that authenticate your emails. You must add these records to send emails from your domain. - **SPF**: (Optional) Sender Policy Framework records that help receiving mail servers verify your domain. Adding SPF records improves deliverability but is not required. - **DMARC**: (Optional) Domain-based Message Authentication records that build on DKIM and SPF to protect against email spoofing. Adding DMARC records is recommended for improved email security but is not required. If you're unsure how to add DNS records, refer to your domain registrar's documentation or support. The domain will then be verified periodically. This process may take a few minutes to several hours, depending on your DNS provider. ### View Domain Verification Status After adding a sender domain, you can view its verification status on the domain detail page. To open it, click the domain name in the **Sender Domains** list. The detail page is organized into three sections: **DKIM**, **SPF**, and **DMARC**. Each section shows whether the corresponding DNS records have been verified. The domain header also shows when the most recent verification check ran. ### Provisioning Failure If the domain's status is **Provisioning failed**, the domain detail page replaces the DNS configuration instructions with an alert explaining the failure. The **Check records** and **Restart verification** buttons are not available when provisioning has failed. Contact support if you encounter this state. ### Verify DNS Records Manually You can trigger an immediate DNS check at any time instead of waiting for the next automatic check by clicking the **Check records** button at the top right of the domain detail page. ### Restart DNS Verification To restart the verification process from the beginning at any time, click the **Restart Verification** button at the top right of the domain detail page. ### Diagnose DNS Record Issues On the domain detail page, you can click theThis is a test email sent using Medusa Emails in a Cloud project.
", subject: "Welcome to Medusa Emails", }, }) } ) ``` ### Scheduled Job / Subscriber / API Route ```ts import { Modules } from "@medusajs/framework/utils" // ... const notificationModuleService = container.resolve( Modules.NOTIFICATION ) await notificationModuleService.createNotifications({ to: "user@example.com", from: "no-reply@yourdomain.com", channel: "email", content: { html: "This is a test email sent using Medusa Emails in a Cloud project.
", subject: "Welcome to Medusa Emails", }, }) ``` The email will be sent from the `no-reply@yourdomain.com` address, assuming it belongs to your verified sender domain. *** ## Monitor Email Sending Activity on Cloud You can monitor email sending activity like sent emails, delivery rates, open rates, and click rates for your Cloud organization using the Email Activity page in your Cloud dashboard. To view email sending activity: You can also navigate to the Email Activity page from the [command palette](../command-palette/page.mdx). Press + K and select **Sender Domains**. 1. If you're in a different organization, [switch to the organization](../organizations/page.mdx#switch-organization). 2. Click **Projects** in the sidebar and select a project. 3. Click **Emails** -> **Activity** from the sidebar. At the top of the Email Activity page, you'll see email sending statistics for your organization across all projects, including: - **Sent**: Total number of sent emails in the specified time range. - **Deliverability Rate**: Percentage of sent emails that were successfully delivered to recipients. - **Open Rate**: Percentage of delivered emails that were opened by recipients. - **Click Rate**: Percentage of opened emails where recipients clicked on links within the email. - **Bounce Rate**: Percentage of sent emails that were not delivered due to permanent delivery failures. - **Complaint Rate**: Percentage of sent emails that recipients marked as spam or junk. Below the statistics, you'll find a detailed list of sent emails.  ### Change Email Activity Time Range To change the time range for email activity statistics and the list of sent emails, click the time range dropdown at the top right of the page. You can choose custom ranges or predefined ranges like "Last 7 days" or "Last 30 days".  The earliest selectable start date depends on your organization's [plan](../pricing/page.mdx): - **Develop plan**: You can query email logs from up to the past 12 hours. - **Launch and Scale plans**: You can query email logs from up to the past 3 days. If you select a start date earlier than what your plan allows, the picker automatically moves it forward to the earliest permitted time. ### Filter Emails by Project By default, the Email Activity page shows emails from all projects in your Cloud organization. To filter emails by a specific project, click the "All projects" dropdown at the top right of the page and select the desired project. This updates the email sending statistics and list to show only emails from the selected project.  ### View Email Details To view an email's details, click the email entry in the list on the Email Activity page. At the top of the Email Details page, you'll see an overview of the email's event history, including when it was sent, delivered, opened, and when its links were clicked. Below that, you'll see a preview of the email content as it was sent to the recipient, with support for both HTML and plain text views.  *** ## Troubleshoot Email Delivery Issues on Cloud If you try to send an email using Medusa Emails in your Cloud project and it's not delivered, consider these troubleshooting steps: 1. **Check Email Activity**: Go to the [Email Activity page](#monitor-email-sending-activity-on-cloud) in your Cloud organization's dashboard to see if the email appears in the list. If it does, check its status and event history for delivery issues. 2. **Verify Sender Domain**: If you're sending emails to external addresses, ensure you've verified your email sender domain in your Cloud organization. Without a verified sender domain, you can only send emails to addresses in your Cloud organization. 3. **Check Logs**: Review your project's [logs](../logs/page.mdx#view-runtime-logs-on-cloud) for errors or warnings related to email sending. Look for issues that might indicate why the email wasn't sent or delivered. 4. **Check Spam/Junk Folder**: Ask the recipient to check their spam or junk email folder. Sometimes emails may be incorrectly marked as spam by email providers. 5. **Contact Support**: If you've tried the above steps and are still experiencing issues, contact support for assistance. If the email activity and logs don't show a cause related to your application, [check the Cloud status page](../status/page.mdx) for ongoing Cloud incidents that may be affecting email delivery. --- The best way to deploy Medusa is through Medusa Cloud where you get autoscaling production infrastructure fine tuned for Medusa. Create an account by signing up at cloud.medusajs.com/signup.