Skip to content

Commit

Permalink
Merge branch '5.x' into 13448
Browse files Browse the repository at this point in the history
  • Loading branch information
RCheesley authored Jun 13, 2024
2 parents 190b756 + e9fa78c commit 0e6a7e9
Show file tree
Hide file tree
Showing 24 changed files with 188 additions and 60 deletions.
9 changes: 9 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,15 @@
"contributions": [
"doc"
]
},
{
"login": "uadf",
"name": "CPweb",
"avatar_url": "https://avatars.githubusercontent.com/u/2785980?v=4",
"profile": "https://eglise.catholique.fr",
"contributions": [
"review"
]
}
],
"contributorsPerLine": 7,
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![Documentation Status][RTD badge URL]][RTD URL]
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-11-orange.svg?style=flat-square)](#contributors-)
[![All Contributors](https://img.shields.io/badge/all_contributors-12-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/mautic/user-documentation)
Expand Down Expand Up @@ -111,6 +111,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<td align="center" valign="top" width="14.28%"><a href="https://github.com/J-Wick4"><img src="https://avatars.githubusercontent.com/u/1954540?v=4?s=100" width="100px;" alt="John Wick"/><br /><sub><b>John Wick</b></sub></a><br /><a href="https://github.com/mautic/user-documentation/issues?q=author%3AJ-Wick4" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/jagtapreshma"><img src="https://avatars.githubusercontent.com/u/81143250?v=4?s=100" width="100px;" alt="jagtapreshma"/><br /><sub><b>jagtapreshma</b></sub></a><br /><a href="https://github.com/mautic/user-documentation/commits?author=jagtapreshma" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/markusVJH"><img src="https://avatars.githubusercontent.com/u/121946942?v=4?s=100" width="100px;" alt="Markus Heinilä"/><br /><sub><b>Markus Heinilä</b></sub></a><br /><a href="https://github.com/mautic/user-documentation/commits?author=markusVJH" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://eglise.catholique.fr"><img src="https://avatars.githubusercontent.com/u/2785980?v=4?s=100" width="100px;" alt="CPweb"/><br /><sub><b>CPweb</b></sub></a><br /><a href="https://github.com/mautic/user-documentation/pulls?q=is%3Apr+reviewed-by%3Auadf" title="Reviewed Pull Requests">👀</a></td>
</tr>
</tbody>
</table>
Expand Down
18 changes: 10 additions & 8 deletions docs/channels/emails.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,12 @@ Tokens

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 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 @@ A token can have a default value for cases when the Contact doesn't have the val
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 @@ It's possible to encode values used in a token using the following syntax:
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 @@ To make use of monitoring replies from Contacts, you must have access to an IMAP
``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 @@ For example:
<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 @@ Elastic Email, SparkPost, Mandrill, Mailjet, SendGrid and Amazon SES support Web
.. vale off
Monitored inbox configuration
*****************************
=============================

.. vale on
Expand All @@ -309,15 +311,15 @@ If sending mail through GMail, the Return Path of the Email is automatically rew
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

0 comments on commit 0e6a7e9

Please sign in to comment.