neos/symfonymailer

A Flow package for easy use of the Symfony Mailer

0.1.0 2025-02-17 13:29 UTC

Requires

• php: ^8.2
• neos/flow: ^8.0 || ^9.0 || dev-master
• symfony/mailer: ^v7.2.0

MIT

README

The Mailer package facilitates email sending via the Symfony/Mailer package and simplifies its usage with the standard method of Neos.Flow configuration.

The package can also facilitate a smoother migration from the old Swiftmailer package to the new Symfony/Mailer package.

Getting Started

$ composer require neos/symfonymailer

Configuration

The package provides a default configuration for the Symfony/Mailer package. You can override the default configuration by adding the following configuration to your Settings.yaml:

Neos:
  SymfonyMailer:
    mailer:
      dsn: 'smtp://localhost'

The dsn parameter is the only required parameter. It should be a valid DSN string for the Symfony/Mailer package. If you migrate from Swiftmailer, you can use the following command to generate the DSN:

./flow symfonymailer:migrate:generatedsnfromswiftmailer

Usage

You can test the mailer configuration by sending a test email:

./flow symfonymailer:test:send --from="[e-mail]" --to="[e-mail]" --subject="Test email" --body="This is a test email"

The package’s design principle is to minimize modifications to the original mailer package. Consequently, only the classes of Symfony/Mailer are utilized for emails, attachments, and so on. The package solely provides a service to initialize the mailer with the configuration. Additionally, the package provides a command to send test emails and migrate the SwiftMailer configuration to an appropriate DSN for Symfony/Mailer.

If you use the LoggingTransport or MboxTransport from SwiftMailer, there is no replacement for the Symfony/Mailer package.

Basic Example

#[Flow\Inject]
protected MailerService $mailerService;

public function sendEmail(string $from, string $to, string $subject, string $body): void
{
	$email = new Email();
	$email
		->from($from)
		->to($to)
		->subject($subject)
		->text($body);

	$mailer = $this->mailerService->getMailer();
	$mailer->send($email);
}

Migrate from Swiftmailer

As previously mentioned, the package includes a command to generate a DSN from the Swiftmailer configuration. To utilize this command, you must have the Swiftmailer configuration located in your Settings.yaml file.

You can use the following command to generate the DSN.

./flow symfonymailer:migrate:generatedsnfromswiftmailer

The PHP code within your package requires some modifications. To facilitate the migration process, there are several rector rules available that facilitate the transition from Swiftmailer to Symfony/Mailer.

• SwiftMessageToEmailRector
• SwiftCreateMessageToNewEmailRector
• SwiftSetBodyToHtmlPlainMethodCallRector

Utilizing these tools, it is feasible to migrate your codebase to Symfony/Mailer.