Skip to content

[Mailer] Documented the tag and metadata headers #13732

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[Mailer] Documented the tag and metadata headers #13732

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions mailer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,39 @@ Alternatively, you can pass multiple addresses to each method::
// ...
;

Message Headers
~~~~~~~~~~~~~~~

Messages include a number of header fields to describe their contents. Symfony
sets all the required headers automatically, but you can set your own headers
too. There are different types of headers (Id header, Mailbox header, Date
header, etc.) but most of the times you'll set text headers::

$email = (new Email())
->getHeaders()
// this header tells auto-repliers ("email holiday mode") to not
// reply to this message because it's an automated email
->addTextHeader('X-Auto-Response-Suppress', 'OOF, DR, RN, NRN, AutoReply');

// ...
;

When using a mailer service that supports tags and metadata, consider using the
``TagHeader`` and ``MetadataHeader`` headers instead of the plain text headers::

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

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

If your mailer doesn't support these tag/metadata headers, they are added to the
message as text headers (``X-Tag: password-reset``, ``X-Metadata-Client-ID: 12345``).

.. versionadded:: 5.1

The ``TagHeader`` and ``MetadataHeader`` headers were introduced in Symfony 5.1.

Message Contents
~~~~~~~~~~~~~~~~

Expand Down