Switch from the deprecated Swift Mailer module replaced by Symfony Mailer

Created on 8 December 2021, almost 3 years ago

Updated 30 May 2023, over 1 year ago

Problem/Motivation

Varbase uses Swift Mailer → module which is now deprecated and got replaced by Symfony Mailer → .

Started to get the following message in composer install/update

Package swiftmailer/swiftmailer is abandoned, you should avoid using it. Use symfony/mailer instead.

Symfony Mailer 1.1.0-beta3 was released 25 November 2022
https://www.drupal.org/project/symfony_mailer/releases/1.1.0-beta3 →

Replaced by:

Symfony Mailer →

A new mail-system based on the popular Symfony Mailer giving full support of HTML mails, file attachments, embedded images, 3rd-party delivery integrations, load-balancing/failover, signing/encryption, async sending and more. Other libraries add capability for CSS inlining and HTML to text conversion.

This module provides a deep integration into Drupal mechanisms, including theme/template/render, multi-language, CSS libraries, configuration, plug-ins, hooks, and logging.

Warning: the swiftmailer library is no longer maintained and so this module is obsolete. It has not yet been marked unsupported, but that could change at any time due to discovery of a security bug or on advice of the Drupal Security Team.

A new module Symfony Mailer → is under development, and has a reasonable alpha release. Help with testing or development is welcome.

Proposed resolution

In the 9.0.x branch

Keep the Swift Mailer → in the 9.0.x branch of Varbase Email, and keep swiftmailer as the default, But let developers use the Symfony Mailer module and do the switch manually

Having all template switching with the same template works in both Swift Mailer and Symfony mailer using the same style and HTML script for the template.
Add the Symfony Mailer → module.
Have the migration steps to switch from Swift Mailer to Symfony Mailer.

Switch From Swift Mailer to Symfony Mailer
Have the full switch in the 10.0.x branch
📌 Start a 10.0.x branch to use the Symfony Mailer module as the default emailing system with Varbase 10.0.x Fixed
Remove Swift Mailer from the 10.0.x branch, and remove any custom code for the module
📌 Remove the Mail System module. To switch to Symfony Mailer Back-compatibility only on the Varbase 10.0.x branch Fixed

Remaining tasks

✅ File an issue about this project
✅ Addition/Change/Update/Fix to this project
✅ Testing to ensure no regression
➖ Automated unit/functional testing coverage
✅ Developer Documentation support on feature change/addition

Changed
Varbase Email

Added
Switch From Swift Mailer to Symfony Mailer
✅ User Guide Documentation support on feature change/addition

Added
Configuring Varbase Mailer Settings

Added
Configure Swift Mailer
✅ Accessibility and Readability
✅ Code review from 1 Varbase core team member
✅ Full testing and approval
✅ Credit contributors
✅ Review with the product owner
✅ Update Release Notes and Update Helper on new feature change/addition
✅ Release varbase-9.0.11 → , varbase_email-9.0.2 → , varbase-10.0.0-alpha1 → , varbase_email-10.0.0-alpha1 →

Varbase update type:

✅ No Update
➖ Optional Update
➖ Forced Update
➖ Forced Update if Unchanged

User interface changes

API changes

Data model changes

Issue #3253315 → : Switched from the deprecated Swift Mailer module replaced by Symfony Mailer on the 10.0.x branch, kept the Swift Mailer in the 9.0.x branch, and kept Swift Mailer as the default, But let developers use the Symfony Mailer module and do the switch manually. Using the same style and HTML script for the template

📌 Task

Status

Fixed

Version

10.0

Component

Code

Created by

🇯🇴Jordan Alaa Jwiehan

Live updates comments and jobs are added and updated live.