Skip to content
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

7811 add tokens in from field #264

Merged
merged 4 commits into from
Jun 13, 2024
Merged

7811 add tokens in from field #264

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a2d63a9
Fix incorrect headings
RCheesley Apr 16, 2024
a830a9b
Add text about using tokens in from fields
RCheesley Apr 16, 2024
6a5ec06
Merge branch '5.x' into 7811-tokens-in-from
RCheesley Apr 16, 2024
4921dc2
Merge branch '5.x' into 7811-tokens-in-from
RCheesley Jun 13, 2024
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
18 changes: 10 additions & 8 deletions docs/channels/emails.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,12 @@

Mautic allows the use of tokens in Emails which gives the marketer the possibility to integrate a number of Contact fields in your Emails. These can be easily placed within your Emails and are automatically replaced with the appropriate text once sent.

It's also possible to override the 'from' field in an Email with a token from your :doc:`/contacts/custom_fields` since Mautic 5.1.

Check warning on line 86 in docs/channels/emails.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Contacts' instead of 'contacts'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Contacts' instead of 'contacts'.", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 86, "column": 91}}}, "severity": "INFO"}

Check the :doc:`/configuration/variables` documentation for a list of all the available default fields.

Default value
~~~~~~~~~~~~~
-------------

A token can have a default value for cases when the Contact doesn't have the value known. You must specify the default value after a ``|`` character, for example:

Expand All @@ -97,7 +99,7 @@
The ``|friend`` tells Mautic to use 'friend' if there is no first name present in the Contact field.

Encoded value
~~~~~~~~~~~~~
-------------

It's possible to encode values used in a token using the following syntax:

Expand All @@ -108,7 +110,7 @@
The ``|true`` tells Mautic to encode the value used, for example in URLs.

Date formats
~~~~~~~~~~~~
------------

To use custom date fields in tokens, use the following format:

Expand Down Expand Up @@ -144,7 +146,7 @@
``php path/to/mautic/bin/console mautic:email:fetch``

Usage
~~~~~
-----
Contact replies within Campaigns function as decision after an Email Send action, to take further action based on whether the Contact has replied to the Email. Mautic tries to read the inbox, parse messages, and find replies from the specified Contact. The Contact, when matched with an incoming reply, proceeds down the positive path immediately after the reply detection.


Expand Down Expand Up @@ -271,7 +273,7 @@
<a href="{webview_url}" target="_blank">View in your browser</a>

Bounce management
#################
*****************

Mautic provides a feature which allows monitoring of IMAP accounts to detect bounced Emails and unsubscribe requests.

Expand All @@ -284,7 +286,7 @@
.. vale off

Monitored inbox configuration
*****************************
=============================

.. vale on

Expand All @@ -309,15 +311,15 @@
If you select an Unsubscribe folder, Mautic also appends the Email as part of the "List-Unsubscribe" header. It then parses messages it finds in that folder and automatically unsubscribe the Contact.

Webhook bounce management
*************************
=========================

Since Mautic 5 all the Email transports use the same Webhook - sometimes called callback - URL: ``https://mautic.example.com/mailer/callback``. Please follow the documentation for the specific Email transport you've installed to get more information about the Webhook configuration.


.. vale off

Create a Segment with bounced Emails
************************************
=====================================

.. vale on

Expand Down
Loading