Skip to content

Commit 8169d13

Browse files
authored
Update mailtrap.md (#549)
* Update mailtrap.md We updated the Mailtrap product itself, and it's no longer a testing tool exclusively. This description is more accurate and still focuses on MODX's users' SMTP based email sending needs. Also updated 'smtp.mailtrap.io' to 'live.smtp.mailtrap.io'. Trying again after previous PR received a comment about being promotional. Removed any possible fluff. * Update mailtrap.md This description is more accurate considering that Mailtrap is no longer only a testing tool. Added email sending features and kept the testing features. Also went in more detail on how to set up both functions. * Update mailtrap.md
1 parent 551c3de commit 8169d13

File tree

1 file changed

+40
-6
lines changed

1 file changed

+40
-6
lines changed
Lines changed: 40 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,52 @@
11
---
2-
title: mailtrap.io
2+
title: Mailtrap
33
---
44

5-
[Mailtrap](https://mailtrap.io) is a service (free plan available) that you can use to "trap" emails, without actually sending them to their intended recipient. Instead they're shown to you in a user interface.
5+
When working on your MODX site, it's useful to have a single platform to both test emails in development and send them reliably in production. We suggest using Mailtrap for this.
66

7-
When working on a development site, it's useful to configure emails to use such a service to prevent accidentally sending test emails to actual customers.
7+
[Mailtrap](https://mailtrap.io) is an email platform for developer and product teams. It provides both an SMTP Service for sending transactional and bulk emails and an Email Sandbox for testing emails (free plan available for both).
88

9-
After creating an account, you can find the credentials in the inbox settings.
9+
## Email Sandbox
10+
11+
[Email Sandbox](https://mailtrap.io/email-sandbox/) is a service that you can use to "trap" emails, without actually sending them to their intended recipient. Instead, they're shown to you in a user interface.
12+
13+
After creating an account, you can find the credentials in the Email Sandbox > Sandboxes > your sandbox.
14+
15+
In MODX, configure the following via System > System Settings:
16+
17+
- `mail_smtp_hosts`: sandbox.smtp.mailtrap.io
18+
- `mail_smtp_port`: 587
19+
- `mail_smtp_user` and `mail_smtp_pass` are provided in the sandbox settings in Mailtrap.
20+
- `mail_smtp_prefix`: tls
21+
22+
## SMTP service
23+
24+
To send emails with [Mailtrap's SMTP](https://mailtrap.io/email-sending/), the [generic instructions apply](building-sites/sending-mail), but here's how to configure Mailtrap specifically.
25+
26+
### Setup and verify your sending domain
27+
28+
1. In your Mailtrap account, navigate to Sending Domains and click Add Domain
29+
2. Enter the domain name you want to send from (you must have access to its DNS records)
30+
3. Add the provided DNS records to your domain provider
31+
4. Click Verify DNS Records once all records are added
32+
5. Wait for the automatic domain review to complete (usually takes a few minutes)
33+
6. Once verified, you'll see a Verified badge next to your domain
34+
35+
_Important note: Some domains may require additional compliance checks. If selected, you'll be asked to fill out a simple compliance form._
36+
37+
### Get your SMTP credentials
38+
39+
Once your domain is verified, navigate to Sending Domains, select your domain, and open the Integrations tab.
40+
41+
Click Integrate under Transactional Stream (for automated emails) or Bulk Stream (for marketing campaigns).
42+
43+
Toggle to SMTP to reveal your credentials.
1044

1145
In MODX, configure the following via System > System Settings:
1246

13-
- `mail_smtp_hosts`: smtp.mailtrap.io
47+
- `mail_smtp_hosts`: live.smtp.mailtrap.io
1448
- `mail_smtp_port`: 587
15-
- `mail_smtp_user` and `mail_smtp_pass` are provided in the inbox settings in mailtrap.
49+
- `mail_smtp_user` and `mail_smtp_pass` are provided in Mailtrap's Integration settings.
1650
- `mail_smtp_prefix`: tls
1751

1852
[Also see the generic instructions for sending email with SMTP for further activation and testing instructions](building-sites/sending-mail)

0 commit comments

Comments
 (0)