Skip to content

Commit

Permalink
Documenting the resubscribe_url token
Browse files Browse the repository at this point in the history
  • Loading branch information
@escopecz
escopecz committed Nov 8, 2024
1 parent 64d113d commit 612fb1d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/channels/emails.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,7 @@ 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 no matter if the preference center is activated or not. It will resubscribe 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 🐶
[Google.Colons] ': I' should be in lowercase.

Raw Output:
{"message": "[Google.Colons] ': I' should be in lowercase.", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 282, "column": 24}}}, "severity": "WARNING"}

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"}

Check warning on line 282 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 ('is activated').

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

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

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 282, "column": 125}}}, "severity": "WARNING"}

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 'Contact' instead of 'contact'.

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

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 'Campaigns' instead of 'campaigns'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Campaigns' instead of 'campaigns'.", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 282, "column": 181}}}, "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
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

0 comments on commit 612fb1d

Please sign in to comment.