Skip to content

Latest commit

 

History

History
519 lines (388 loc) · 20.7 KB

CHANGELOG.md

File metadata and controls

519 lines (388 loc) · 20.7 KB
Raw

Changelog

Most changes for each Bamboo version are included here. For a complete changelog, see the git history for each version via the version links.

To see the exact dates a version was published see the hex package page.

2.3.1 (2024-09-26)

Bug Fixes

  • Fix Elixir 1.17 warning about function call without parens (1c1d002)
  • fix invalid typespec (7b5d99d)
  • README badge and broken links (c0ea19b)

2.3.0 - 2023-01-06

Additions

  • Add inline images in mandrill adapter (#608)
  • add support for enabling sendgrid click tracking (#618)
  • Better local preview for text-only emails (#622)

Fixes/Enhancements

  • Improve format of SendGridHelper docs (#611)
  • Change "enabled" to "enable" to conform to SendGrid API (#624)
  • Update mime package version (#627)

2.2.0 - 2021-06-11

Additions

  • Add support for Sendgrid unique arguments (#609)
  • Accept timeout option in test helpers (#605)
  • Add assign/2 to Bamboo.Template to set many assigns (#600)

Fixes/Enhancements

  • Set default timeout in test helpers to 100 (#607)
  • Turn some test helpers from macros -> functions (#604)
  • Use refute_timeout configured for all refute_ assertions (#603)
  • Organize Bamboo's TestAdapter test file (#601)
  • fix deliver_later typo (#598)
  • Fix typo: Bambooo -> Bamboo (#597)

2.1.0 - 2021-04-09

Additions

  • Adds ability to define interceptors (#591)

Fixes/Enhancements

  • Updates broken screencast link in README (fbf148a)

2.0.2 - 2021-03-26

Fixes/Enhancements

  • Fix LocalAdapter.deliver/2 return type (#589)
  • Return email sent in LocalAdapter with an open_email_in_browser_url config (#590)
  • Fix example for MandrillHelper.put_param/3 (#593)

2.0.1 - 2021-03-05

Fixes/Enhancements

  • Fix type spec of Mailer.deliver_later/1 (#584)
  • Fix format_email_address/2 spec. Returns a single address or a list (#585)

2.0.0 - 2021-02-19

Breaking Changes

  • Adds Mailer.deliver_now! and deliver_later! (#571)
  • Extract Bamboo.Phoenix (#581)
  • Remove deprecated code (#580)

Please see the upgrade guide.

Additions/Improvements

  • Update SendGrid Adapter to return ok/error tuple (#572)
  • Update Mailgun.deliver to return ok/error tuples (#573)
  • Update Mandrill to return ok/error tuples (#574)
  • Adds upgrade guide to Bamboo 2.0 (#582)

1.7.1 - 2021-02-18

Fixes/Enhancements

  • Show all senders in sent email viewer template (#569)
  • Import ExUnit.Assertions in Bamboo.Test.assert_delivered_email_matches (#578)
  • Fallback to screen.availHeight for iframe bug (#579)
  • Small language updates to README (5e35f5f)

1.7.0 - 2021-02-05

New Additions

  • Introduce Bamboo.Template and Bamboo.View (#576)
  • Add support for Mailgun recipient variables (#566)

Fixes/Enhancements

  • Update min version of hackney to 1.15.2 (#575)
  • Fix Email.address() typespec (#570)
  • Fix mailgun adapter error reporting (#521)
  • Improve attachment support detection (#567)
  • Update phoenix.ex docs (#564)
  • Elixir 1.11 warnings (#556)
  • fix: typespec in generated code (#561)
  • Remove unneeded @email_view_module in Bamboo.Phoenix (#559)
  • Relax formatter opts (#557)

1.6.0 - 2020-10-13

New Additions

  • Allow specifying an IP Pool name for SendGrid (#539)
  • Add SendGrid personalizations (#535)
  • Specify dynamic SendGrid key in config (#523)
  • Show attachments in sent email viewer (#553)
  • Show recipient names in sent email viewer (#547)
  • Add assert_email_delivered_matches/1 to test functions (#534)

Fixes/Enhancements

  • Fix passing both response: true and config options (#538)
  • Escape HTML in preview email subject and text body (#548)
  • Add space between name and email in mailviewer (#546)
  • Use api.sendgrid.com instead of non-api version (#545)
  • Docs fixes (#554), (d1c06d)

1.5.0 - 2020-05-05

New Additions

  • Support SendGrid send_at field (#519)

Fixes/Enhancements

  • Fix variable substitution for nested maps in Mailgun templates (#496)
  • Relax Jason version constraint (#531)
  • SendGrid requires an Accept header (#529)
  • Remove dead link in README (#527)

1.4.0 - 2020-01-24

New Additions

  • Send headers in Sendgrid adapter (#479)
  • Allow dynamic override of mailer config (#497)
  • Implement Mailgun's o:deliverytime to schedule email delivery (#511)
  • Add Mailgun template version and template text options (#504)
  • Pass opts to hackney (#498)
  • Add content_id for displaying attachments in HTML email (#475)

Fixes/Enhancements

  • Add refute_email_delivered_with (#484)
  • Add GmailAdapter to available adapters list (#513)

1.3.0 - 2019-08-02

New Additions

  • Add support for SendGrid's asm_group_id (#457)
  • Add SentEmailApiPlug (#456)
  • Add ability to bypass list management for SendGrid Adapter (#458, #463)
  • Add supports_attachments? to adapter behaviour (#410)
  • Allow setting of Mailgun config from env (#363)
  • Add option to deliver_now to return adapter response (#466)
  • SendGrid Adapter Reply-To parameter updates (#487)
  • Google Analytics settings for SendGrid Adapter (#462)
  • Add support for Mailgun tags and templates (#490)
  • Config driven base_uri for Mailgun Adapter (#491)

Fixes/Enhancements

  • Fix typos and documentation (#454, #447, #455, #461, #468, #473, #488)
  • Add additional adapters to README (#446, #480)
  • Add .t() spec type to Bamboo.Attachment (#389)
  • Add Elixir code formatter (#464)
  • Clarify changes and test phases in mailer test (#465)
  • Restructure/update README (#467)
  • Add Code of Conduct (#471)
  • Replace Poison with Jason for json encoding/decoding (#485)
  • Upgrade ex_doc (#486)
  • Remove whitespaces inside pre tag in SentEmailViewer (#493)
  • Use a formatter for assert_email_delivered_with/1 (#482)

1.2.0 - 2019-01-30

New Additions

Fixes/Enhancements

1.1.0 - 2018-08-15

Fixes/Enhancements

  • Update hackney version requirement to 1.13.0
  • README improvements
  • Migrate circleci configuration to 2.0 (beam-community#411)

1.0.0 - 2018-06-14

New Additions

Fixes/Enhancements

1.0.0-rc2 - 2017-11-03

New Additions

Fixes/Enhancements

1.0.0-rc.1 - 2017-05-05

New Additions

Fixes/Enhancements

Breaking changes

0.8.0 - 2017-01-06

New Additions

  • Add helper for working with Mandrill merge vars (#219)
  • Show header in email preview (#225)
  • Add SendGrid template support (#163)
  • Add Bamboo.Test.assert_delivered_with for more fine grained assertions (#228)
  • Add Mailgun header support (#235)

Fixes/Enhancements

  • Drop dependency on HTTPoison and use Hackney directly (#201)
  • Remove warnings and deprecations for Elixir 1.4 (#240, #241)

0.7.0 - 2016-07-29

New Additions

  • Add example of using HTML layouts with Bamboo.Phoenix (#173)
  • Give suggestions for why email preview may not be working (#177)
  • Add Mandrill template support (#176)

Fixes/Enhancements

  • Build mailer config during runtime. Allows for configuration with Conform (#170)
  • Fix "leaking" HTML email styles (#172)
  • Catch nil email addresses when used in 2-item tuple (#151)
  • Remove ExMachina from dev/prod deps. It should have been a test only dep (#198)
  • Small typo fixes (#199)
  • Explicitly set content type in email preview so that HTML emails are always preview as HTML (#203 and #204)

0.6.0

New Additions

  • Improved error message when mailer config is invalid (#148)
  • Added typespecs to many modules and functions (#150, #164)
  • Strip assigns from the email when testing. Makes testing more reliable (#158)

0.5.0

New Additions

  • Much improved test helpers (#109)
  • Bamboo.TaskSupervisorStrategy is now started by default (#133)
  • New Mailgun adapter (#125)
  • Link to new Sparkpost adapter (#118)
  • Shared mode for working with multiple process/acceptance tests (#136)
  • New Bamboo.Phoenix.put_layout/2 for setting HTML and text layouts at the same time (#122)

Fixes

  • Show correct "from" address in EmailPreview (#127)

Breaking changes

  • Bamboo.Test.assert_no_emails_sent has been renamed to assert_no_emails_delivered (#109)
  • Since Bamboo.TaskSupervisorStrategy is started automatically, Bamboo.TaskSupervisorStrategy.child_spec has been removed. Please remove the call to that function from your lib/my_app.ex file.

0.4.2

New Additions

  • Add Bamboo.SendgridAdapter
  • Improve and update docs

0.4.1

New Additions

  • Improve docs

0.4.0

New Additions

  • EmailPreviewPlug for previewing emails in development.
  • Improved documentation with more and better examples.

Breaking Changes

  • MandrillEmail has been renamed to MandrillHelper. The API is the same so all you will have to do is rename your imports and/or aliases.
  • Mailer.deliver/1 has been renamed to Mandrill.deliver_now/1 to add clarity. See discussion here: beam-community#89