You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+15-11Lines changed: 15 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,15 @@
1
-
# Welcome to the ColdBox Mail Services => (cbmailservices)
1
+
# Welcome to the ColdBox Mail Services => (`cbmailservices`)
2
2
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:
4
4
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/)|
10
13
11
14
It also sports tons of useful features for mail sending:
12
15
@@ -20,11 +23,12 @@ It also sports tons of useful features for mail sending:
20
23
* Success and Error callbacks
21
24
* So Much More!
22
25
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.
24
27
This feature can be turned off, if desired, by these steps:
28
+
25
29
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`.
28
32
29
33
```
30
34
moduleSettings = {
@@ -58,7 +62,7 @@ Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp
0 commit comments