# Configure Symfony Mailer

{% hint style="info" %}
Have a look at the official documentation for the **Symfony Mailer** module

See <https://www.drupal.org/docs/contributed-modules/symfony-mailer-0>
{% endhint %}

## Mailer Policy

Navigate to **Administration \ Configuration \ System \ Mailer**

To configure Mailer Policy to customize outgoing emails in many different ways. There are many possible policies to apply including: subject; body; addresses (from, to, ...); theme; transport; convert to plain text. Each policy can be set globally or for emails of a specific type.

<figure><img src="https://content.gitbook.com/content/RPp0n1Zud7iJeGbDEjdP/blobs/vqWHKG2XGhWNw8smMuUE/Mailer-policy-varbase9c1.png" alt=""><figcaption><p>Mailer Policy</p></figcaption></figure>

## Import Configuration

You can import configuration from existing modules to create an equivalent Mailer Policy. It is recommended to run the import at the beginning, before you start editing policy.

{% hint style="warning" %}
**Warning** importing overwrites existing policy. If you have already created working policy then you should skip the import.
{% endhint %}

If the **Symfony Mailer** module was enabled on the site for the first time. The site will keep prompting the following error message.

{% hint style="danger" %}

### Error message <a href="#message-error-title" id="message-error-title"></a>

There are Mailer configuration import operations pending: [import](https://docs.varbase.vardot.com/9.1.x/developers/configuring-a-varbase-site/configuring-varbase-mailer-settings/broken-reference).
{% endhint %}

<figure><img src="https://content.gitbook.com/content/RPp0n1Zud7iJeGbDEjdP/blobs/Rc4TBUIcXar4sx118AyG/Contact-varbase9c1--import-symfony-mailer--back-end--claro--part.png" alt=""><figcaption><p>Error Message to Import Configuration at the Back-end</p></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/RPp0n1Zud7iJeGbDEjdP/blobs/1ugdFlwSq3k1vFiQzvCu/Contact-varbase9c1--import-symfony-mailer--front-end.png" alt=""><figcaption><p>Error Message to Import Configuration at the Front-end</p></figcaption></figure>

Click on import from the alert message or navigate to **Administration \ Configuration \ System \ Mailer policy \&#x20;*****Import configuration***

<figure><img src="https://content.gitbook.com/content/RPp0n1Zud7iJeGbDEjdP/blobs/IpAMmb6Q1lEmqS02wi5v/Contact-varbase9c1--import-symfony-mailer--import-all.png" alt=""><figcaption><p>Import Configuration with Import All option</p></figcaption></figure>

**Import All** or only Import needed changes for:

* **Update notification addresses (update)**
* **User email settings (user)**: This overrides the default HTML messages with imported plain text versions.

<figure><img src="https://content.gitbook.com/content/RPp0n1Zud7iJeGbDEjdP/blobs/RJm9mO457a16aFbuHAGg/Contact-varbase9c1--import-symfony-mailer--import-all--Imported-all-configuration.png" alt=""><figcaption><p>Imported All Configurations</p></figcaption></figure>

## Add SMTP Transport Service

Navigate to **Administration \ Configuration \ System \ Mailer policy \&#x20;*****Transports***

To see the list of mailer transports.

<figure><img src="https://content.gitbook.com/content/RPp0n1Zud7iJeGbDEjdP/blobs/mWOrfdvPmhlBXtRMm177/Mailer-transport-varbase9c1.png" alt=""><figcaption><p>Mailer Transports Configuration Page</p></figcaption></figure>

* Select *SMTP* from the list of transport types, and click on the Add transport button
* Fill in the Label for the SMTP service
* Fill in the User name for the  SMTP service. It could be the same email sender created in the SMTP service provider
* Provide the password to log in with it
* Provide the Hostname public SMTP domain provider
* Use the right SMTP port, which the provider recommends to use

![Example Add SMTP Transport](https://content.gitbook.com/content/RPp0n1Zud7iJeGbDEjdP/blobs/bOccC0uM02EcgxN9ZlM5/Add-transport-varbase90x1.png)

Press the Save submit button to save the SMTP transport

A message of *"The transport configuration has been saved."* will show up and the page will be redirected back to the Mailer transports configuration page.

![The Transport Configuration Has Been Saved](https://content.gitbook.com/content/RPp0n1Zud7iJeGbDEjdP/blobs/9pKyorsqCfah3F2eTqOG/The%20Transport%20Configuration%20Has%20Been%20Saved.png)

Set the **STMP** transport as the default transport sender for emails, by clicking on "Set as Default" from the operations list for the **SMTP** transport.

![Set a Transport as Default](https://content.gitbook.com/content/RPp0n1Zud7iJeGbDEjdP/blobs/cuEK9HlxURxsx2VTFfLG/Set%20a%20Transport%20as%20Default.png)

## Set the Email Logo for Symfony Mailer Template

&#x20;[**Vartheme BS4**](https://www.drupal.org/project/vartheme_bs4) and [**Vartheme BS5**](https://www.drupal.org/project/vartheme_bs5) provide theme settings for emails too. **Vartheme** sub-themes followed with that too.

* Generate a new sub-theme following with [creating-your-own-theme](https://docs.varbase.vardot.com/9.1.x/developers/theme-development-with-varbase/creating-your-own-theme "mention")
* Enable the new custom sub-theme for example and set it as the default theme on the site.
* Navigate to **Administration \ Appearance \ Appearance settings \&#x20;*****A Custom Sub Theme of Vartheme***

The email logo custom theme settings can be filled as desired

![Email Logo Settings in Vartheme and Vartheme Sub Themes](https://content.gitbook.com/content/RPp0n1Zud7iJeGbDEjdP/blobs/Ec2fMCY6XzHr6NFwN4Go/Email%20Logo%20-%20Vartheme%20\(Bootstrap%204%20-%20SASS\)%20_%20varbase90x1.png)

The provided Email Logo will feed the Symfony Mailer template with the selected logo, which it will be linked in the email.

## Custom Templates and Styling In Custom Themes

When the custom theme for a project did not have any changes. No extra work is needed at this point.

Change the following steps when having any changes over the custom theme in the project.

Inline or style elements are cleared out in the `email.twig` , `varbase_email.twig` template file.

Create a new library to attach the needed styles to it

**Example:** `custom_subtheme.libraries.yml` file

```
default.email-style.ltr:
  css:
    theme:
      css/theme/email-style.theme.ltr.css: {}

default.email-style.rtl:
  css:
    theme:
      css/theme/email-style.theme.rtl.css: {}

```

Have all custom LTR ( left to right) and RTL ( right to left ) styling in separate files and libraries, to override the default **Varbase Email** libraries.

**Symfony Mailer** only allows attaching the custom styling to the template using the default **Drupal** library system.

The **Varbase Email** module has two libraries which are attached to the **Symfony** email template. They can be extended or overridden.

**Example:** `custom_subtheme.info.yml` file in your custom **Vartheme** sub-theme

```
libraries-override:
  varbase_email/default.email-style.ltr: custom_subtheme/default.email-style.ltr
  varbase_email/default.email-style.rtl: custom_subtheme/default.email-style.rtl
```

**Symfony Mailer** allows each module to have custom email templates and other sending transport.

The default transport service will be used when no custom transport was configured for the module. When a custom or contrib module is trying to send emails.

If the old project had any custom code or custom multiple mailers in the same system. The code should be migrated to configs. Using the **Symfony Mailer** plugin system.