diff --git a/docs/channels/emails.rst b/docs/channels/emails.rst index 8c81f2e1..1bab8838 100644 --- a/docs/channels/emails.rst +++ b/docs/channels/emails.rst @@ -790,8 +790,8 @@ Unsubscribing 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. +- ``{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. - ``{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. @@ -805,6 +805,12 @@ For example: 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. + +.. 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 ************** diff --git a/docs/contacts/preference_center.rst b/docs/contacts/preference_center.rst index d59d1572..d7d04d60 100644 --- a/docs/contacts/preference_center.rst +++ b/docs/contacts/preference_center.rst @@ -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