Skip to content

Document email address validation step for unsubscribe and resubscribe #913

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

Draft
promptless-for-oss wants to merge 1 commit into
base: 7.2
Choose a base branch
from
Draft

Document email address validation step for unsubscribe and resubscribe #913

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 8 additions & 2 deletions docs/channels/emails.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -790,8 +790,8 @@

Mautic has a built in means of allowing a Contact to unsubscribe from Email communication. You can insert various tokens into your Email to provide unsubscribe options at your desired location:
- ``{unsubscribe_text}``: inserts a sentence with a link instructing the Contact to click to unsubscribe.
- ``{unsubscribe_url}``: inserts the URL to the preferences center when it's activated, or to the unsubscribe page if not.
- ``{resubscribe_url}``: inserts the URL to the resubscribe page regardless of whether there's a preference centre in use. It resubscribes the Contact. Useful for double opt out Campaigns.
- ``{unsubscribe_url}``: inserts the URL to the preferences center when it's activated, or to the unsubscribe page if not. The Contact confirms their Email address on a validation page first - see below.

Check warning on line 793 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 'Landing Page' instead of 'page'.

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

Check warning on line 793 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 'Landing Page' instead of 'page'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'.", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 793, "column": 111}}}, "severity": "INFO"}
- ``{resubscribe_url}``: inserts the URL to the resubscribe page regardless of whether there's a preference centre in use. It resubscribes the Contact. Useful for double opt out Campaigns. As with unsubscribe links, the Contact confirms their Email address on a validation page first - see below.

Check warning on line 794 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 'Landing Page' instead of 'page'.

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

Check warning on line 794 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 'Landing Page' instead of 'page'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'.", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 794, "column": 61}}}, "severity": "INFO"}
- ``{dnc_url}``: inserts the URL to unsubscribe from all Marketing Messages when you activate the preference center.

The unsubscribe URL token inserts the URL into your custom written instructions.
Expand All @@ -805,6 +805,12 @@

You can find the configuration of the unsubscribe text in the global settings.

Mautic resolves the ``{unsubscribe_url}``, ``{unsubscribe_text}``, and ``{resubscribe_url}`` tokens to a validation page rather than executing the action immediately. When a Contact clicks the link they first land on a 'Confirm your email address' page and must type the Email address the message was sent to. Mautic completes the unsubscribe or resubscribe only if the entered Email address matches. The Contact's Email address is no longer embedded in the link itself, which protects against leaked or forwarded links. If the entered address doesn't match, Mautic shows the error 'This email address does not match the email address that was used to generate this link.' and makes no change.

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

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Contractions] Feel free to use 'doesn't' instead of 'does not'.

Raw Output:
{"message": "[Google.Contractions] Feel free to use 'doesn't' instead of 'does not'.", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 808, "column": 603}}}, "severity": "INFO"}

Check warning on line 808 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 'Email' instead of 'email'.

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

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

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('was sent').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('was sent').", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 808, "column": 298}}}, "severity": "INFO"}

Check warning on line 808 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 'Landing Page' instead of 'page'.

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

Check warning on line 808 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 'Email' instead of 'email'.

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

Check warning on line 808 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 'Landing Page' instead of 'page'.

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

.. note::

Links in Emails sent by older versions of Mautic no longer unsubscribe or resubscribe automatically on click. If Mautic still has a record of that send, it redirects the Contact to the same confirmation page. If it doesn't, an unsubscribe link shows a 'Record not found.' message, and a resubscribe link shows a page-not-found (``404``) error.

Online version
**************

Expand Down
2 changes: 1 addition & 1 deletion docs/contacts/preference_center.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ When creating or editing an Email, you can select the Preference Center Page fro

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.
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. Contacts first confirm their Email address on a validation page before reaching the Preference Center - see :ref:`Unsubscribing` for details.

.. image:: images/pref6.png
:align: center
Expand Down
Loading