Skip to content

Commit

Permalink
Merge branch '5.x' into 13503
Browse files Browse the repository at this point in the history
  • Loading branch information
RCheesley authored Jun 13, 2024
2 parents 04d893a + d96a2b7 commit 20fb839
Show file tree
Hide file tree
Showing 34 changed files with 263 additions and 77 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
38 changes: 29 additions & 9 deletions docs/channels/emails.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,19 @@ Segment Emails are marketing Emails by default. On creation the marketer assigns

This entry field is a multi-select which allows you to choose several Segments if necessary.

.. vale off
Excluding Segments
==================

.. vale on
There is a multi-select field that allows excluding Contacts belonging given Segments.

.. image:: images/emails/email-excluding-segments.png
:width: 400
:alt: Screenshot showing selecting Segments to exclude.

Mautic initiates the sending of these Emails with a :doc:`/configuration/cron_jobs` - see section on Send Scheduled Broadcasts - for example, Segment Emails - for more details on this.

Email formats
Expand All @@ -65,6 +78,12 @@ When creating the Email, there is an option to assign a language and a translati

It's also possible to have translations of A/B test variants.

From Mautic 5.1 it's possible to preview A/B and Translation variants:

.. image:: images/emails/ab-translation-preview.png
:width: 400
:alt: Screenshot showing A/B and Translation preview

Base64 encoded images
=====================

Expand All @@ -83,10 +102,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 +118,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 +129,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 +165,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 +292,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 +305,7 @@ Elastic Email, SparkPost, Mandrill, Mailjet, SendGrid and Amazon SES support Web
.. vale off
Monitored inbox configuration
*****************************
=============================

.. vale on
Expand All @@ -309,15 +330,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 Expand Up @@ -370,4 +391,3 @@ This is because Mautic sends test Emails to a Mautic User and not to a Mautic Co
Mautic Users can't unsubscribe and therefore the unsubscribe link looks like this: ``https://mautic.example.com/|URL|``. However, the link **does** work correctly when you send the Email to a Contact.

Best practice is to create a Segment with a small number of Contacts to receive test Emails - for example, yourself - which ensures that you can fully test features such as unsubscribe behaviour.

5 changes: 1 addition & 4 deletions docs/channels/focus_items.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ For each type of Focus Item, there are settings to configure which control the t
:width: 400
:alt: Screenshot showing the engagement settings for Focus Items.

.. vale off
- **Animate** - When set to Yes, this applies a slide-in animation to the Focus Item. When set to No, the item appears without any kind of sliding motion.
- **When to engage** - This setting controls the Focus Item shows. There are several options:
- **Upon arrival** - As soon as a visitor lands on the page
Expand All @@ -49,8 +47,7 @@ For each type of Focus Item, there are settings to configure which control the t
- **Once per hour** - Show the Focus Item once every hour that the visitor is on your website
- **Once per day** - Show the Focus Item once per day that the visitor is on your website
- **Stop engaging after a conversion** - This option is only available for the types which track a conversion (Collect Data and Emphasize a Link). If set to Yes, the Focus Item no longer displays if the visitor has either submitted the Form (Collect Data type) or clicked on the link (Emphasize a Link type).

.. vale on
- **Stop engaging after closing Focus** - This option is available for Focus Items and uses cookies. If set to Yes, the Focus Item no longer displays to the visitor after they have interacted with it, until they clear their cookies.

Styles
======
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 20fb839

Please sign in to comment.