Home

WELCOME TO THE COLDBOX MAILSERVICES MODULE

The ColdBox Mail services module will allow you to send email the OO way in multiple protocols for many environments. The supported protocols are:

• CFMail - Traditional cfmail sending
• Files - Write emails to disk
• Postmark API - Send via the PostMark Service (https://postmarkapp.com/)

You can easily add your own mail protocols by building upon our standards.

LICENSE

Apache License, Version 2.0.

IMPORTANT LINKS

• https://github.com/ColdBox/cbox-mailservices
• http://forgebox.io/view/cbmailservices

SYSTEM REQUIREMENTS

• Lucee 4.5+
• Railo 4+ (Deprecated)
• ColdFusion 9+

INSTRUCTIONS

Just drop into your modules folder or use the box-cli to install

box install cbmailservices

The mail services registers all mail components so you can use them in your application.

Settings

You will need to update the your ColdBox.cfc with a mailsettings structure with your preferred mail settings and mail protocol to use. All the keys that can go into the mailsettings struct map 1-1 to the cfmail tag except for the tokenMarker and protocol keys.

mailsettings = {
    // The default token Marker Symbol
    tokenMarker = "@",
    // protocol
    protocol = {
        class = "",
        properties = {}
    }
};