Skip to content

Commit 3386daf

Browse files
committed
updated readme for mailgun
1 parent b892c1f commit 3386daf

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

readme.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
# Welcome to the ColdBox Mail Services => (cbmailservices)
1+
# Welcome to the ColdBox Mail Services => (`cbmailservices`)
22

3-
Sending email doesn't have to be complicated or archaic. The ColdBox Mail Services (cbmailservices) module will allow you to send email in a fluent and abstracted way in multiple protocols for many environments in a single cohesive API. The supported protocols are:
3+
Sending email doesn't have to be complicated or archaic or sad 😭. The ColdBox Mail Services (`cbmailservices`) module will allow you to send email in a fluent and abstracted way in multiple protocols for many environments in a single cohesive API, which will bring you smiles 😍, rainbows 🌈 and unicorns 🦄!. The supported protocols are:
44

5-
* **CFMail** - Traditional `cfmail` sending
6-
* **File** - Write emails to disk
7-
* **InMemory** - Store email mementos in an array. Perfect for testing.
8-
* **Null** - Ignores emails sent to it.
9-
* **Postmark** - Send via the PostMark API Service (https://postmarkapp.com/)
5+
| Protocol | Description |
6+
|---------------|-------------|
7+
| `CFMail` | Traditional sending via the `cfmail` tag. |
8+
| `File` | Sends mails to a location on disk as `.html` files. |
9+
| `InMemory` | Store email mementos in an array. Perfect for testing. |
10+
| `Null` | Ignores emails send to it! |
11+
| `MailGun` | Sends mail via the Mailgun API Services (https://www.mailgun.com) |
12+
|`Postmark` | Send via the PostMark API Service (https://postmarkapp.com/) |
1013

1114
It also sports tons of useful features for mail sending:
1215

@@ -20,11 +23,12 @@ It also sports tons of useful features for mail sending:
2023
* Success and Error callbacks
2124
* So Much More!
2225

23-
Note: One of the features is the ability to queue emails for asynchronous (non-blocking) sending. This is done via a task runner which is on by default.
26+
Note: One of the features is the ability to queue emails for asynchronous (non-blocking) sending. This is done via a task runner which is on by default.
2427
This feature can be turned off, if desired, by these steps:
28+
2529
1. Open config/coldbox.cfc
26-
27-
2. In the modulesSettings section, add a key for cbmailServices with the property `runQueueTask` set to `false`.
30+
31+
2. In the modulesSettings section, add a key for cbmailServices with the property `runQueueTask` set to `false`.
2832

2933
```
3034
moduleSettings = {
@@ -58,7 +62,7 @@ Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp
5862
www.ortussolutions.com
5963
********************************************************************************
6064

61-
#### HONOR GOES TO GOD ABOVE ALL
65+
## HONOR GOES TO GOD ABOVE ALL
6266

6367
Because of His grace, this project exists. If you don't like this, then don't read it, its not for you.
6468

0 commit comments

Comments
 (0)