-
Notifications
You must be signed in to change notification settings - Fork 75
docs: Document global defaults for Preference Center and UTM tracking #698
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -398,14 +398,32 @@ | |||||||||||||||||||||
| * **Convert embed images to Base64** - Select **Yes** to display embedded images in Emails using embedded base64 code rather than as embedded images. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| * **Disable trackable URLs** - Removes tracking from URLs in your Emails. Select Yes to prevent tracking, reporting on, and using decisions based on link clicks. Some Email service providers don't like redirecting URLs. Using trackable URLs in your Emails may impact deliverability. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Default UTM tags | ||||||||||||||||||||||
| ---------------- | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Configure default UTM tags for new Emails. When you create a new Email, Mautic pre-populates the UTM fields with these defaults. Existing Emails, edited Emails, and cloned Emails retain their own UTM values. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| * **Default UTM source** - The default value for the Campaign Source field. For example: ``newsletter``, ``website``. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| * **Default UTM medium** - The default value for the Campaign Medium field. For example: ``email``, ``cpc``. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| * **Default UTM campaign** - The default value for the Campaign Name field. For example: ``spring_sale``, ``product_launch``. | ||||||||||||||||||||||
|
Check warning on line 411 in docs/configuration/settings.rst
|
||||||||||||||||||||||
|
Comment on lines
+407
to
+411
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| * **Default UTM content** - The default value for the Campaign Content field. For example: ``header_link``, ``footer_link``. | ||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| .. note:: | ||||||||||||||||||||||
| Default UTM tags only apply to new Emails. If you edit an existing Email or clone an Email, the original values remain unchanged - even if those values are empty. | ||||||||||||||||||||||
|
Comment on lines
+415
to
+416
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Unsubscribe settings | ||||||||||||||||||||||
| ==================== | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| .. image:: images/unsubscribe-settings.png | ||||||||||||||||||||||
| :width: 600 | ||||||||||||||||||||||
| :alt: Screenshot showing Unsubscribe Settings Configuration in Mautic | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| * **Default Preference Center** - Select a default Preference Center page for new Emails. When you create a new Email, Mautic pre-populates the Preference Center field with this selection. Existing Emails, edited Emails, and cloned Emails retain their own Preference Center selection. For more information on creating Preference Center pages, see the :doc:`Preference Center documentation</contacts/preference_center>`. | ||||||||||||||||||||||
|
Check warning on line 425 in docs/configuration/settings.rst
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| * **Text for the {unsubscribe_text} token** - Like the ``{webview_text}`` token, this allows you to customize the **Unsubscribe** link. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| For example - Edit between the ``<a href="|URL|">`` and ``</a>`` tags. Don't change the URL as it's tokenized. If you add ``{unsubscribe_url}`` as a token in the Email, you won't see this text. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -179,6 +179,10 @@ | |
|
|
||
| | | ||
|
|
||
| .. tip:: | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Tip about default Preference Center added based on PR #15905 which allows setting a site-wide default Preference Center page. Source: mautic/mautic#15905 |
||
|
|
||
| You can set a default Preference Center in **Configuration > Email Settings**. When you create a new Email, Mautic pre-populates the Preference Center field with this default selection. This saves time if most of your Emails use the same Preference Center page. For details, see :ref:`Unsubscribe settings <configuration/settings:Unsubscribe settings>`. | ||
|
Check warning on line 184 in docs/contacts/preference_center.rst
|
||
|
|
||
| Keep in mind that your mail must use the same language as the Preference Center landing page - if not, Mautic shows the default Preference Center. | ||
|
|
||
| Now when sending the Email, all recipients can click the Unsubscribe link provided in the ``{unsubscribe_text}`` and ``{unsubscribe_url}`` variables, taking them to the new Preference Center. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Global UTM defaults section added based on PR #15905 which introduces site-wide default UTM values in Email configuration.
Source: mautic/mautic#15905