da55306a5a
* --init * progress... * add more docs * bunch of changes and added back platform * development guides added * more guides in develop with cal * self hosted WIP * deployments * fix deployment steps * self-hosted guides * .. * Removed the development only sections * Removed 'with Cal.com' * use steps component for steps --------- Co-authored-by: Keith Williams <keithwillcode@gmail.com>
40 lines
2.0 KiB
Plaintext
40 lines
2.0 KiB
Plaintext
---
|
|
title: "Setting up mailtrap for email testing"
|
|
---
|
|
Mailtrap is a versatile tool for testing email notifications without sending them to the real users of your application. It's especially useful for testing and ensuring that the system sends out accurate emails in a secure and efficient manner.
|
|
|
|
To set up Mailtrap for email testing on Cal.com, follow these steps:
|
|
|
|
<Steps>
|
|
<Step title="Create an Account">
|
|
The first step is to register an account with Mailtrap. It offers a free plan for small testing needs, and also paid plans for larger organizations.
|
|
</Step>
|
|
<Step title="Create an Inbox">
|
|
After registering, create an inbox for your application. Each inbox comes with its SMTP and POP3 credentials, which can be used to send and retrieve emails.
|
|
</Step>
|
|
<Step title="Configure the Cal.com env file">
|
|
Change the tab to nodemailer and copy the information to `.env`:
|
|
```
|
|
EMAIL_SERVER_HOST='sandbox.smtp.mailtrap.io'
|
|
EMAIL_SERVER_PORT=2525
|
|
EMAIL_SERVER_USER='XXX'
|
|
EMAIL_SERVER_PASSWORD='XXX'
|
|
```
|
|
<Info>Please remember to change the user and password and replace 'XXX' above with their respective values.</Info>
|
|
</Step>
|
|
<Step title="Set EMAIL_FROM">
|
|
Set the `EMAIL_FROM` environment variable in the `.env` file. For example:
|
|
```
|
|
EMAIL_FROM='notifications@yourselfhostedcal.com'
|
|
```
|
|
</Step>
|
|
<Step title="Send Test Emails">
|
|
Once your instance is configured, you can start sending test emails. These emails are "trapped" in the Mailtrap inbox, enabling you to verify email content, headers, and attachments.
|
|
</Step>
|
|
<Step title="Analyze and Debug">
|
|
Mailtrap provides features to analyze and debug your emails. You can check whether the HTML displays correctly, ensure the email is not treated as spam, and also see if it contains any broken links, invalid format, or incorrect images.
|
|
</Step>
|
|
</Steps>
|
|
|
|
Happy testing!
|