📬
📬
📬
📬
cbMailServices
Search…
Introduction
Intro
Release History
About This Book
Essentials
Installation
Configuration
Sending Mail
Advanced
Async Mail
Building Protocols
Mail Events
Powered By GitBook
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 cfmail sending
  • 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/)
  • Mailgun - Send via the MailGun API Service (https://www.mailgun.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!
newMail(
to : "[email protected]",
from : "[email protected]",
subject : "Mail Services Rock",
type : "html", // Can be plain, html, or text
bodyTokens : {
user : "Luis",
product : "ColdBox",
link : event.buildLink( 'home' )
}
)
.setBody("
<p>Dear @[email protected],</p>
<p>Thank you for downloading @[email protected], have a great day!</p>
<p><a href='@[email protected]'>@[email protected]</a></p>
")
.addAttachment( expandPath( "/tmp/reports/report.pdf" ) )
.setReadReceipt( "[email protected]" )
.send()
.onSuccess( function( result, mail ){
// Process the success
})
.onError( function( result, mail ){
// Process the error
});

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:
<major>.<minor>.<patch>
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
  • ​Much More​

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
​
Next - Intro
Release History
Last modified 3mo ago
Export as PDF
Copy link
Edit on GitHub
On this page
Welcome to the ColdBox Mail Services
System Requirements
Versioning
License
Important Links
Professional Open Source
HONOR GOES TO GOD ABOVE ALL