Skip to content

Commit d4cf577

Browse files
authored
finalized changelog [no ci]
1 parent b528eba commit d4cf577

File tree

1 file changed

+74
-73
lines changed

1 file changed

+74
-73
lines changed

changelog.md

Lines changed: 74 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -16,215 +16,216 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1616
- ColdBox 7 Auto Testing
1717
- New `start:fakemail` command to start FakeSMTP for testing
1818
- Addded fake smtp server for testing on the harness
19+
- Skipping of parsing tokens if the mail type is template to avoid complex data in the send-grip protocol https://github.com/coldbox-modules/cbmailservices/pull/34
1920

2021
## [v2.7.1] => 2023-FEB-14
2122

2223
### Fixed
2324

24-
* Fix usage of invalid named member function #33 (https://github.com/coldbox-modules/cbmailservices/pull/33)
25+
- Fix usage of invalid named member function #33 (https://github.com/coldbox-modules/cbmailservices/pull/33)
2526

2627
## [v2.7.0] => 2023-JAN-16
2728

2829
A big thanks to @richardherbert for all the updates in this release.
2930

3031
### Fixed
3132

32-
* FIXED var scoping of attachments variable
33-
* Updated to handle a response that is not JSON
34-
* 🐛 FIX: Update GHA to avoid deprecated syntax
33+
- FIXED var scoping of attachments variable
34+
- Updated to handle a response that is not JSON
35+
- 🐛 FIX: Update GHA to avoid deprecated syntax
3536

3637
### Added
3738

38-
* Added test for MAILGUN_BASEURL property
39-
* Updated to make MAILGUN_APIURL optional
40-
* Added support for Mailgun EU region by making MAILGUN_APIURL an optional property with https://api.mailgun.net/v3/ as the default.
39+
- Added test for MAILGUN_BASEURL property
40+
- Updated to make MAILGUN_APIURL optional
41+
- Added support for Mailgun EU region by making MAILGUN_APIURL an optional property with https://api.mailgun.net/v3/ as the default.
4142

4243
### Changed
4344

44-
* Updated all GHA actions to latest versions and moved to use `temurin` Java distributions from adopt due to deprecation of the service.
45+
- Updated all GHA actions to latest versions and moved to use `temurin` Java distributions from adopt due to deprecation of the service.
4546

4647
## [v2.6.2] => 2022-DEC-20
4748

4849
### Fixed
4950

50-
* If the incoming `layout` arugment for the `setView()` method in the mail is empty, it should ignore it.
51+
- If the incoming `layout` arugment for the `setView()` method in the mail is empty, it should ignore it.
5152

5253
## [v2.6.1] => 2022-NOV-21
5354

5455
### Changed
5556

56-
* Less verbosity for the mail queue log
57+
- Less verbosity for the mail queue log
5758

5859
## [v2.6.0] => 2022-NOV-15
5960

6061
### Added
6162

62-
* New ColdBox 7 delegate `Mailable@cbmailservices` so you can easily add mailing capabilities to objects
63+
- New ColdBox 7 delegate `Mailable@cbmailservices` so you can easily add mailing capabilities to objects
6364

6465
## [v2.5.1] => 2022-NOV-1
6566

6667
### Fixed
6768

68-
* Fixing asset version
69+
- Fixing asset version
6970

7071
## [v2.5.0] => 2022-OCT-19
7172

7273
### Modified
7374

74-
* More updates of injections to generic `box` instead of `coldbox`.
75+
- More updates of injections to generic `box` instead of `coldbox`.
7576

7677
## [v2.4.0] => 2022-AUG-20
7778

7879
### Modified
7980

80-
* Updated injections to generic `box` instead of `coldbox`.
81+
- Updated injections to generic `box` instead of `coldbox`.
8182

8283
## [v2.3.1] => 2022-AUG-04
8384

8485
### Fixed
8586

86-
* Fix github action
87+
- Fix github action
8788

8889
## [v2.3.0] => 2022-AUG-04
8990

9091
### Fixed
9192

92-
* Fixed build process so it doesn't include `box.bin` in the final artifact.
93+
- Fixed build process so it doesn't include `box.bin` in the final artifact.
9394

9495
## [v2.2.0] => 2022-JUN-06
9596

9697
### Added
9798

98-
* Added mailgun protocol to available mail protocols @scottsteinbeck
99+
- Added mailgun protocol to available mail protocols @scottsteinbeck
99100

100101
## [v2.1.0] => 2022-MAY-17
101102

102103
### Added
103104

104-
* Ability for the `preMailSend` event to influence the `mail` record thanks to @gpickin
105-
* Getters only work if there is a `variables.config` key in existence. Add reasonable defaults for commonly accessed mail fields
106-
* New module setting: `runQueueTask` which is defaulted to `true`. If `false` it will not run the mail queue task in the background
105+
- Ability for the `preMailSend` event to influence the `mail` record thanks to @gpickin
106+
- Getters only work if there is a `variables.config` key in existence. Add reasonable defaults for commonly accessed mail fields
107+
- New module setting: `runQueueTask` which is defaulted to `true`. If `false` it will not run the mail queue task in the background
107108

108109
## [v2.0.4] => 2022-FEB-09
109110

110111
### Fixed
111112

112-
* `-snapshot` left on the box.json
113+
- `-snapshot` left on the box.json
113114

114115
### Added
115116

116-
* Github actions standards via new module template
117-
* Reusable Workflows
117+
- Github actions standards via new module template
118+
- Reusable Workflows
118119

119120
## [v2.0.3] => 2021-NOV-17
120121

121122
### Fixed
122123

123-
* Fix for Default-Settings overwrites Mail-Bean Payload
124+
- Fix for Default-Settings overwrites Mail-Bean Payload
124125

125126
## [v2.0.2] => 2021-NOV-17
126127

127128
### Fixed
128129

129-
* Fixed `getFileMimeType()` so postmark attachments can work. Thanks to @garciadev
130+
- Fixed `getFileMimeType()` so postmark attachments can work. Thanks to @garciadev
130131

131132
## [v2.0.1] => 2021-NOV-12
132133

133134
### Fixed
134135

135-
* BOX-119 CBMailService - Setting the defaultProtocol in moduleSettings to something other than default gets ignored
136+
- BOX-119 CBMailService - Setting the defaultProtocol in moduleSettings to something other than default gets ignored
136137

137138
## [v2.0.0] => 2021-NOV-08
138139

139140
### Changed
140141

141-
* `COMPATIBILITY` : Settings are now using ColdBox 5 module approach of `moduleSettings.cbmailservices` instead of a root key element called `cbmailservices`. Make sure you update your settings and move them to `modulesettings.cbmailservices`
142-
* `COMPATIBILITY` : Changed all arguments called `default` to `defaultValue` to avoid ACF issues with the parser
143-
* `Mail` object `config()` renamed to `configure()`
144-
* The return results structure from the protocols `errorArray` has been renamed to just `messages` as it can contain warnings, information messages as well as error messages
145-
* PostmarkAPI result returns `MessageID` instead of `message_id` now.
142+
- `COMPATIBILITY` : Settings are now using ColdBox 5 module approach of `moduleSettings.cbmailservices` instead of a root key element called `cbmailservices`. Make sure you update your settings and move them to `modulesettings.cbmailservices`
143+
- `COMPATIBILITY` : Changed all arguments called `default` to `defaultValue` to avoid ACF issues with the parser
144+
- `Mail` object `config()` renamed to `configure()`
145+
- The return results structure from the protocols `errorArray` has been renamed to just `messages` as it can contain warnings, information messages as well as error messages
146+
- PostmarkAPI result returns `MessageID` instead of `message_id` now.
146147

147148
### Added
148149

149-
* Ability for the mail payload to render the body from a view or a view/layout combination using the `setView()` method.
150-
* New ability to queue mail for sending using the async scheduler for the module and the new `queue()` method
151-
* New asynchronous mail sending via `sendAsync()` which returns a ColdBox Future
152-
* New mixin helper: `newMail()` so you can get access to send mails easily in handlers and interceptors.
153-
* In order to run and validate SMPT tests, we now use FakeSMTP as a container located in /test-harnes/tests/resources/docker-compose.yml. This will send mail to disk for us when testing smtp. If you want to run the tests on your machine, you will need to startup the container.
154-
* Every protocol now has a `log` LogBox logger configured object thanks to the `AbstractProtocol`.
155-
* Every protocol gets a `name` property now for a numan readable name thanks to the `AbstractProtocol`.
156-
* `Mail` object now can send itself via the new `send()` method which delegates to the service, but provides a nice sending DSL.
157-
* `Mail` object now has dynamic getters and setters for ALL configuration objects.
158-
* You can now use aliases to build out any of the core protocols: `CFMail, File, InMemory, Null or Postmark` instead of the full path.
159-
* You can now use a wirebox id or class path as the protocol class apart from the core protocols.
160-
* Added ability for the `getProperty( property, defaultValue )` method on the abstract protocol to have a default value.
161-
* Migration to script of all core items.
162-
* Migration to github actions.
163-
* Adobe 2021 Support.
164-
* Modernization of all source code.
150+
- Ability for the mail payload to render the body from a view or a view/layout combination using the `setView()` method.
151+
- New ability to queue mail for sending using the async scheduler for the module and the new `queue()` method
152+
- New asynchronous mail sending via `sendAsync()` which returns a ColdBox Future
153+
- New mixin helper: `newMail()` so you can get access to send mails easily in handlers and interceptors.
154+
- In order to run and validate SMPT tests, we now use FakeSMTP as a container located in /test-harnes/tests/resources/docker-compose.yml. This will send mail to disk for us when testing smtp. If you want to run the tests on your machine, you will need to startup the container.
155+
- Every protocol now has a `log` LogBox logger configured object thanks to the `AbstractProtocol`.
156+
- Every protocol gets a `name` property now for a numan readable name thanks to the `AbstractProtocol`.
157+
- `Mail` object now can send itself via the new `send()` method which delegates to the service, but provides a nice sending DSL.
158+
- `Mail` object now has dynamic getters and setters for ALL configuration objects.
159+
- You can now use aliases to build out any of the core protocols: `CFMail, File, InMemory, Null or Postmark` instead of the full path.
160+
- You can now use a wirebox id or class path as the protocol class apart from the core protocols.
161+
- Added ability for the `getProperty( property, defaultValue )` method on the abstract protocol to have a default value.
162+
- Migration to script of all core items.
163+
- Migration to github actions.
164+
- Adobe 2021 Support.
165+
- Modernization of all source code.
165166

166167
### Removed
167168

168-
* `MailSettingsBean` removed in favor of a more cohesive `MailService`
169-
* `protocol` setting removed in favor of multiple mailers approach and `defaultProtocol` usage. Please see docs.
170-
* Adobe ColdFusion 2016 Support.
169+
- `MailSettingsBean` removed in favor of a more cohesive `MailService`
170+
- `protocol` setting removed in favor of multiple mailers approach and `defaultProtocol` usage. Please see docs.
171+
- Adobe ColdFusion 2016 Support.
171172

172173
## [v1.6.0] => 2021-FEB-22
173174

174175
### Addded
175176

176-
* Two new protocols: `NullProtocol, InMemoryProtocol`
177-
* The `NullProtocol` ignores all calls to it.
178-
* The `InMemoryProtocol` stores mail mementos in an internal array. This can be useful for testing to check that mail was sent. It also includes a handle `hasMessage` method which takes a predicate callback and checks it against each sent mail. A `reset` method is included for use inside tests.
179-
* New CI updates and code quality systems
180-
* New updates for ColdBox 6
177+
- Two new protocols: `NullProtocol, InMemoryProtocol`
178+
- The `NullProtocol` ignores all calls to it.
179+
- The `InMemoryProtocol` stores mail mementos in an internal array. This can be useful for testing to check that mail was sent. It also includes a handle `hasMessage` method which takes a predicate callback and checks it against each sent mail. A `reset` method is included for use inside tests.
180+
- New CI updates and code quality systems
181+
- New updates for ColdBox 6
181182

182183
## [v1.5.0] => 2019-NOV-12
183184

184185
### New Features
185186

186-
* Added a `fromName` to the Mail bean to track names due to some protocols allowing it
187-
* The module will register two interception points. `PreMailSend` and `PostMailSend`
187+
- Added a `fromName` to the Mail bean to track names due to some protocols allowing it
188+
- The module will register two interception points. `PreMailSend` and `PostMailSend`
188189

189190
### Improvements
190191

191-
* New module layout
192-
* Removed unecessary routing endpoint
192+
- New module layout
193+
- Removed unecessary routing endpoint
193194

194195
### Bugs
195196

196-
* Var scoping issue
197+
- Var scoping issue
197198

198199
## [v1.4.2]
199200

200-
* Fixes incorrect argument collection nesting on protocol registration
201+
- Fixes incorrect argument collection nesting on protocol registration
201202

202203
## [v1.4.1]
203204

204-
* Auto create folder paths in FileProtocol if they do not exist
205+
- Auto create folder paths in FileProtocol if they do not exist
205206

206207
## [v1.4.0]
207208

208-
* Updated to use module templating
209-
* Proposed additionalInfo data struct for provider specific implementations. Added a couple of helper methods : https://github.com/coldbox-modules/cbox-mailservices/pull/5
210-
* Updated to leverage WireBox for object creations instead of internal new and createobjects
209+
- Updated to use module templating
210+
- Proposed additionalInfo data struct for provider specific implementations. Added a couple of helper methods : https://github.com/coldbox-modules/cbox-mailservices/pull/5
211+
- Updated to leverage WireBox for object creations instead of internal new and createobjects
211212

212213
## [v1.3.0]
213214

214-
* Fix on date formatting on file protocol thanks to @elpete
215-
* Fix for type inclusion on the file protocol thanks to @elpete
215+
- Fix on date formatting on file protocol thanks to @elpete
216+
- Fix for type inclusion on the file protocol thanks to @elpete
216217

217218
## [v1.2.0]
218219

219-
* Travis integration
220-
* DocBox updates
221-
* Build process updates
220+
- Travis integration
221+
- DocBox updates
222+
- Build process updates
222223

223224
## [v1.1.0]
224225

225-
* Updated build process
226-
* Updated readme and instructions
226+
- Updated build process
227+
- Updated readme and instructions
227228

228229
## [v1.0.0]
229230

230-
* Create first module version
231+
- Create first module version

0 commit comments

Comments
 (0)