Skip to content
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

Documenting the resubscribe_url token #342

Open
wants to merge 2 commits into
base: 5.x
Choose a base branch
from
+7 −0
Open

Documenting the resubscribe_url token #342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
612fb1d
Documenting the resubscribe_url token
escopecz Nov 8, 2024
cf6f8f0
Vale fixes
escopecz Nov 12, 2024
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
1 change: 1 addition & 0 deletions docs/channels/emails.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,7 @@
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.

Check warning on line 282 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": 282, "column": 61}}}, "severity": "INFO"}
- ``{dnc_url}``: Inserts the URL to unsubscribe from all marketing messages when the preference center is activated.

The unsubscribe URL token inserts the URL into your custom written instructions.
Expand Down
6 changes: 6 additions & 0 deletions docs/configuration/variables.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,10 @@ See :doc:`Manage Emails</channels/emails>` for more information.
- ``{tracking_pixel}``
* - Unsubscribe Text
- ``{unsubscribe_text}``
* - Unsubscribe URL
- ``{unsubscribe_url}``
* - Resubscribe URL
- ``{resubscribe_url}``
* - Web View Text
- ``{webview_text}``
* - Web View URL
Expand Down Expand Up @@ -397,6 +401,8 @@ Alphabetical list
- ``{contactfield=twitter}``
* - Preferred Channel (Preference Center)
- ``{preferredchannel}``
* - Resubscribe URL
- ``{resubscribe_url}``
* - Share Buttons
- ``{sharebuttons}``
* - Success Message
Expand Down
Loading