Added

• Github Support Files

• Github Action Updates

• ColdBox 7 Auto Testing

• New start:fakemail command to start FakeSMTP for testing

• Addded fake smtp server for testing on the harness

• Skipping of parsing tokens if the mail type is template to avoid complex data in the send-grip protocol

[v2.7.1] => 2023-FEB-14

Fixed

Welcome to the ColdBox Mail Services

Sending emails doesn't have to be complicated or archaic. The ColdBox Mail Services (cbmailservices) module will allow you to send emails in a fluent and abstract way in multiple protocols for many environments in a single cohesive API. The supported protocols are:

In this section you will find the release notes for each version we release under this major version. If you are looking for the release notes of previous major versions use the version switcher at the top left of this documentation book. Here is a breakdown of our major version releases.

Version 2.0

Version is a major rewrite of this entire module to push it into modern land! It has been rewritten to allow for more fluent and modern syntax, more protocols, and asynchronous capabilities.

Version 1.0

Our first release as a module decoupled from the ColdBox 2 days!

New Features and Improvements

Let’s investigate the new features and improvements.

PreMailSend

• Ability for the preMailSend event to influence the mail record thanks to @gpickin

New Module Setting: runQueueTask

• This setting is defaulted to true.

  • If false it will not run the mail queue task in the background

Mailgun Mailer Protocol

You can now register a MailGun protocols by using its alias:

Added

• New ColdBox 7 delegate Mailable@cbmailservices so you can easily add mailing capabilities to objects

Added

• Ability for the preMailSend event to influence the mail record thanks to @gpickin

• Getters only work if there is a variables.config key in existence. Add reasonable defaults for commonly accessed mail fields

• New module setting: runQueueTask which is defaulted to true. If false it will not run the mail queue task in the background

Modified

• Updated injections to generic box instead of coldbox.

[v2.5.1] => 2022-NOV-1

Fixed

• Fixing asset version

[v2.5.0] => 2022-OCT-19

Modified

• More updates of injections to generic box instead of coldbox

The source code for this book is hosted in GitHub:

You can freely contribute to it and submit pull requests. The contents of this book are copyrighted by and cannot be altered or reproduced without the author's consent. All content is provided "As-Is" and can be freely distributed.

• The majority of code examples in this book are done in cfscript.

• The majority of code generation and running of examples are done via CommandBox: The ColdFusion (CFML) CLI, Package Manager, REPL -

[v2.3.1] => 2022-AUG-04

Fixed

Luis Fernando Majano Lainez

Luis Majano is a Computer Engineer that has been developing and designing software systems since the year 2000. He was born in in the late 70’s, during a period of economical instability and civil war. He lived in El Salvador until 1995 and then moved to Miami, Florida where he completed his Bachelors of Science in Computer Engineering at . Luis resides in Houston, Texas with his beautiful wife Veronica, baby girl Alexia and baby boy Lucas!

He is the CEO of , a consulting firm specializing in web development, ColdFusion (CFML), Java development and all open source professional services under the ColdBox and ContentBox stack. He is the creator of ColdBox, ContentBox, WireBox, MockBox, LogBox and anything “BOX”, and contributes to many open source ColdFusion/Java projects. You can read his blog at

cbMailServices has been rewritten from the ground up for the 2.x release. It was about time to add some 💕 and modernize it. Please note that this is a major upgrade and it WILL require some changes on your configuration and usage. We have documented all the changes for you to provide for a smooth transition.

Compatibility Changes

The following are the changes you will need to do to upgrade to version 2.x.

Adobe 2016 Support Dropped

It’s too old and too cumbersome to support now. So upgrade to a supported engine.

MailSettingsBean Dropped

This CFC was unnecessary and dropped in favor of encapsulation in the MailService

Configuration Changes

You will have to place the configuration in the standard ColdBox approach now of moduleSettings.cbmailservices in the config/coldbox.cfc configuration file instead of the top level mailServices struct.

No More Top Level Mail Settings

In the previous version you would put any payload mail default settings as a top-level key under the mailServices struct. Now you will use the defaults struct instead.

Default Protocol

In 2.x you can define multiple mailers in an application. So the previous protocol struct is now removed. You will have to register the protocol by name in the mailers struct and add a defaultProtocol key which points to the one you define in the mailers.

If no defaultProtocol is added and no mailers then the mail services module will register a cfmail protocol for you as the default mailer.

Mail bean returned from send() method

Previous a struct containing error and errorArray would be returned from the send() method. Now, the Mail bean is returned (whether using mail.send() or mailService.send( mail )). The previously available struct can be accessed using mail.getResults(). (Be sure to see the .)

No More errorArray

The return struct from the mail services has been modified. The errorArray has been renamed to messages. Which is still an array but can be used by any protocol to register an array of messages about the mailing for any status.

Mail config() renamed to configure()

The mail payload config() method was renamed to configure()

Postmark message_id renamed to messageId

The return message identifier from postmark has been renamed from message_id to messageID to be consistent with the postmark API results.

New Features and Improvements

Let’s investigate now the new features and improvements.

newMail() Helper

The module now registers several new mixin helpers. You can now use newMail() in any handler, and interceptor to start a fluent mailing.

Mailer Aliases

You can now register your mailer protocols by using their alias instead of the full CFC path:

• CFMail

• File

• InMemory

• Null

Mailer WireBox ID

You can now also register ANY WireBox ID or class path as the mailer as well. This will allow you to register mailers that come from your application or any other module.

Protocol Names

All protocols now have a name property that can be used to give a human readable name for all protocols.

Fluent Mail

The mail payload object has been completely rewritten to allow you to use it to not only construct a mail payload, but to do it in a fluent and more approachable manner. It also allows you to send the payload itself without using the mail service. It also sports a dynamic getter/setter approach for any property stored in the internal config structure. This structure is used to model all the mail settings and properties that will be used to send mail through any protocol.

Success - Errors Callback

The send() method will return itself so you can interact with the payload for either success or failures. You will do so using the following methods:

• OnError( callback )

• OnSuccess ( callback )

Utility Methods

The following utility methods can be used for inspecting results and errors.

• getResults() : struct. Empty if no results

• hasErrors() : boolean. False if no results

• getResultMessages() : array. Empty if no results

Multiple Transmission Mailer Protocols

The configuration allows for a mailers structure where you can register extra named mailer protocols. You can then use them by name in your mail payloads and set the defaultProtocol as well by it's name.

You can also seed the mailer name in the payload using the setMailer() method to register the name of the mailer to use for the payload or use the mailer configuration key.

View Rendering

Allow for the payload to render a view as the body for you instead of doing this manually using the setView() method.

This will tell the mail payload to render the view with or without the layout, pass in the args into the view and layout as the body of the mailing. If you don't pass a layout by convention we will just render the view in isolation.

Async Sending

Thanks to ColdBox futures you can now send the mailing asynchronously via the sendAsync() method. The return is a ColdBox Future object.

In Memory Mail Queue

The mail services module will also register a mail scheduler that will iterate and send mail payload asynchronously. The scheduler runs every minute and iterates and sends all mail in the queue. This allows for your application to not wait and block until mail is sent.

All you need to do is use the queue() method. That’s it. The mail services schedule will deliver the mail payload to the right mailer asynchronously and at least every minute schedule.

Please note that we are in async land, so you won’t be able to process successes or failures. The scheduler will log all activity to the applications logging facilities for either a success or failed mailing. The return of the queue() method is a task ID guid which you can use to track in log statements.