Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
 
 
Cannot retrieve contributors at this time

Email Channel

image

Use the mail channel to submit your form data via email documents.

Localization

You're able to define an email for every given locale, depending on your pimcore system settings. There is also a Default fallback field. If a requested locale can't be found during submission, the default configuration will be used.

Available Options

Name Type Description
Mail Template Pimcore Mail Type Use it to define the mail template via drag'n'drop.
Ignored Field in Email Tags In some cases, you don't want to send specific fields via mail. For example, if you send a copy to the user. Add one or multiple fields as string. Notice: The field name needs be identical to the field name in your form configuration.
Allow Attachment Checkbox If this is checked, attachments or attachments-links will be appended to the mail.
Force Plain Text Submission Checkbox If you want to force the plain text submission, you need to check this option. Read more about the submission types below.
Required By Checkbox If this is checked, you need to add your own data to the mail template. You can use all the field names as placeholder. This function is only necessary in rare cases.

Placeholder

Place your form somewhere on your Website. If you want to submit the form to the user, you can use your field names as placeholders. Formbuilder automatically will transform the field into the given address. For Example you can set a placeholder called %emailaddress% (where emailaddress is the name of your form field) in the To: field ("Settings" Tab of your email template).

Subject, From, ReplyTo You also may want to add some placeholder in the subject of your mail template. To do so, just add a placeholder like %emailaddress% to the subject field. They will get transformed automatically.


Mail Submission Types

HTML

FormBuilder always submits html mails. However, it will also append a text/plain version to each email. With that, the email client is able to choose between html and plain text.

Plain Text

In some cases you may want to force the text/plain submission. To do so, you need to set the mail_force_plain_text Property.

Advanced HTML Templating

Use the emailizr library to generate simple structured html templates and inline styled markup out of the box. This library does not comes with the default FormBuilder installation.

Configure html2text Options

The default html2text options in PIMCORE are not quite good enough for real text emails. You may want to change those settings:

form_builder:
    email:
        html_2_text_options:
            strip_tags: true
            hard_break: true

You'll find all available options directly on GitHub via thephpleague/html-to-markdown


Mail Layout Editor

Attention: This mail layout editor does not respect any special mail template language (like inky)!

Things to know

  • Always save your form before opening the mail editor

Custom Service

Use the mail editor to specify some special mail templates. It's very easy to add some custom template widgets (Eg. date field).

Register Service

App\MailEditor\Widget\SpecialWidget:
    tags:
        - { name: form_builder.mail_editor.widget, type: special }

Add PHP Service

<?php

namespace App\MailEditor\Widget;

use FormBuilderBundle\MailEditor\Widget\MailEditorWidgetInterface;

class DateWidget implements MailEditorWidgetInterface
{
    public function getWidgetGroupName()
    {
        return 'form_builder.mail_editor.widget_provider.others';
    }

    public function getWidgetLabel()
    {
        return 'form_builder.mail_editor.widget_provider.special.label';
    }

    public function getWidgetConfig()
    {
        // this config will appear in the editor if you double-click on your widget
        return [
            'link' => [
                'type'         => 'input',
                'defaultValue' => null,
                'label'        => 'form_builder.mail_editor.widget_provider.special.link'
            ],
        ];
    }

    public function getValueForOutput(array $config)
    {
        $form = $config['form'];
        $link = isset($config['link']) ? $config['link'] : '';

        return 'SPECIAL_DATA';
    }
}