New in Symfony 5.1: Misc. improvements (Part 2)

Warning: This post is about an unsupported Symfony version. Some of this information may be out of date. Read the most recent Symfony Docs.

YAML linter command

Contributed by
Jan Schädlich
in #34387.

Symfony includes a linter that checks the validity of the syntax of your YAML config files. It's available under the lint:yaml command, but requires using the entire Symfony project console application.

In Symfony 5.1 we added a single-command application called yaml-lint so you can lint YAML files using only the Yaml and Console components:

$ php vendor/bin/yaml-lint translations/

Improved RoundRobin mailer transport

Contributed by
Fabien Potencier
in #35525.

If your application doesn't use the Messenger component to send emails and sends just one message, the RoundRobin transport doesn't work as expected, because its first transport is always used. In Symfony 5.1 we improved it to select the first transport randomly.

Separate log channel for deprecations

Contributed by
Laurent Voullemier
in #36621.

Deprecation messages are the key of the Symfony Backward Compatibility Promise, which ensures a smooth upgrade between minor Symfony versions. However, sometimes it's overwhelming to see lots of deprecations in your log files. In other projects, you may want to focus exclusively on deprecations, so the other log messages only complicate things.

That's why in Symfony 5.1 we've added some optional configuration in the config/packages/prod/monolog.yaml file to log the deprecations in a separate file. The new config is commented by default, so you need to enable it explicitly if you want to use it.

Added support for mailer tags/metadata

Contributed by
Kevin Bond in #35050.

Some mailing services allow to define tags/metadata in your messages to add any data that may be useful for your application. In Symfony 5.1 we added support for them in mailers such as Postmark and Mailgun:

use Symfony\Component\Mailer\Header\MetadataHeader;
use Symfony\Component\Mailer\Header\TagHeader;

$email->getHeaders()->add(new TagHeader('password-reset'));
$email->getHeaders()->add(new MetadataHeader('Color', 'blue'));
$email->getHeaders()->add(new MetadataHeader('Client-ID', '12345'));

In mailers that support these features, you'll see the data in the custom headers or payload of the messages. In the rest of mailers, you'll see them as custom headers:

X-Tag: password-reset
X-Metadata-Color: blue
X-Metadata-Client-ID: 12345
Help the Symfony project!

As with any Open-Source project, contributing code or documentation is the most common way to help, but we also have a wide range of sponsoring opportunities.


Part 3 - Dark Mode Exceptions? :)
"X-" prefix for custom headers are deprecated. See
@Massimiliano Arione the tag is based on the mailer transport that is used and depends on the specification of the specific transport. It's not something that Symfony can decide on.

Comments are closed.

To ensure that comments stay relevant, they are closed for old posts.