Email Framework
General Information
The Pimcore Email Framework provides an easy way to send/create emails with Pimcore.
For this you have several components:
- Document\Email
- Pimcore\Mail
Pimcore provides a Pimcore\Mail
Class which extends the \Symfony\Component\Mime\Email
Class.
If email settings are configured in your config/config.yaml
then on initializing
Pimcore\Mail
object, these settings applied automatically
It is recommended to configure email settings in config/config.yaml
file:
pimcore:
email:
sender:
name: 'Pimcore Demo'
email: demo@pimcore.com
return:
name: ''
email: ''
and debug email addresses should be configured in Admin Settings > System > Debug > Debug Email Addresses.
If the Debug Mode is enabled, all emails will be sent to the Debug Email recipients defined in Settings > System > Debug > Debug Email Addresses. Additionally the debug information (to whom the email would have been sent) is appended to the email and the Subject contains the prefix "Debug email:".
This is done by extending Symfony Mailer, with injected service RedirectingPlugin
, which calls beforeSendPerformed before mail is sent and sendPerformed immediately after email is sent.
Emails are sent via transport and \Pimcore\Mailer
requires transports: main
for sending emails and pimcore_newsletter
for sending newsletters(if newsletter specific settings are used), which needs to be configured in your config.yaml e.g.,
framework:
mailer:
transports:
main: smtp://user:pass@smtp.example.com:port
pimcore_newsletter: smtp://user:pass@smtp.example.com:port
Please refer to the Transport Setup for further details on how this can be set up.
Pimcore provides a Document Email
type where you can define the recipients ... (more information
here) and Twig variables.
To send a email you just create a Email Document
in the Pimcore Backend UI, define the subject,
recipients, add Dynamic Placeholders... and pass this document to the Pimcore\Mail
object. All
nasty stuff (creating valid URLs, embedding CSS, compile Less files, rendering the document..) is
automatically handled by the Pimcore\Mail
object.
In the Settings
section of the Email Document
you can use Full Username <user@domain.fr>
or Full Username (user@domain.fr)
to set full username.
Usage Example
Lets assume that we have created a Email Document
in the Pimcore Backen UI (/email/myemaildocument
)
which looks like this:
To send this document as email we just have to write the following code-snippet in our controller action:
//dynamic parameters
$params = array('firstName' => 'Pim',
'lastName' => 'Core',
'product' => \Pimcore\Model\DataObject::getById(73613)
);
//sending the email
$mail = new \Pimcore\Mail();
$mail->to('example@pimcore.org');
$mail->setDocument('/email/myemaildocument');
$mail->setParams($params);
$mail->send();
you can access the parameters in your mail content.
Hello {{ firstName }} {{ lastName }}
Regarding the product {{ product.getName() }} ....
Sending a Plain Text Email:
$mail = new \Pimcore\Mail();
$mail->to('example@pimcore.org');
$mail->text("This is just plain text");
$mail->send();
Sending a Rich Text (HTML) Email:
$mail = new \Pimcore\Mail();
$mail->to('example@pimcore.org');
$mail->bcc("bcc@pimcore.org");
$mail->html("<b>some</b> rich text");
$mail->send();
Sandbox Restrictions
Sending mails renders user controlled twig templates in a sandbox with restrictive security policies for tags, filters & functions. Please use following configuration to allow more in template rendering:
pimcore:
templating_engine:
twig:
sandbox_security_policy:
tags: ['if']
filters: ['upper']
functions: ['include', 'path']