cbMailServices
Search…
Introduction
cbMailServices is a module to send email in a fluent and abstracted approach.
Welcome to the ColdBox Mail Services
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:- CFMail - Traditional
cfmailsending - File - Write emails to disk
- InMemory - Store email mementos in an array. Perfect for testing.
- Null - Ignores emails sent to it.
- Postmark - Send via the PostMark API Service (https://postmarkapp.com/)
It also sports tons of useful features for mail sending:
- Async Mail
- Mail Queues
- Mail merging of variables
- Mail attachments, headers and parameters
- View and Layout+View rendering for mail
- Mail tracking
- Multiple mailers
- Success and Error callbacks
- So Much More!
1
newMail(
2
to : "[email protected]",
3
from : "[email protected]",
4
subject : "Mail Services Rock",
5
type : "html", // Can be plain, html, or text
6
bodyTokens : {
7
user : "Luis",
8
product : "ColdBox",
9
link : event.buildLink( 'home' )
10
}
11
)
12
.setBody("
13
<p>Dear @[email protected],</p>
14
<p>Thank you for downloading @[email protected], have a great day!</p>
15
<p><a href='@[email protected]'>@[email protected]</a></p>
16
")
17
.addAttachment( expandPath( "/tmp/reports/report.pdf" ) )
18
.setReadReceipt( "[email protected]" )
19
.send()
20
.onSuccess( function( result, mail ){
21
// Process the success
22
})
23
.onError( function( result, mail ){
24
// Process the error
25
});
Copied!
System Requirements
- Lucee 5+
- Adobe ColdFusion 2018+
Versioning
cbMailServices is maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered with the following format:1
<major>.<minor>.<patch>
Copied!
And constructed with the following guidelines:
- Breaking backward compatibility bumps the major (and resets the minor and patch)
- New additions without breaking backward compatibility bumps the minor (and resets the patch)
- Bug fixes and misc changes bumps the patch
License
Important Links
Professional Open Source
www.ortussolutions.com
This module is professional open source software backed by Ortus Solutions, Corp offering services like:
- Custom Development
- Professional Support & Mentoring
- Training
- Server Tuning
- Security Hardening
- Code Reviews
HONOR GOES TO GOD ABOVE ALL
Because of His grace, this project exists. If you don't like this, then don't read it, it's not for you.
"Therefore being justified by faith, we have peace with God through our Lord Jesus Christ: By whom also we have access by faith into this grace wherein we stand, and rejoice in hope of the glory of God." Romans 5:5
Last modified 6mo ago
Export as PDF
Copy link
Edit on GitHub