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

Jump to bottom

DPMMA-2831 dnc_url token #332

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

DPMMA-2831 dnc_url token #332

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69ee4cc
feat: [DPMMA-2831] dnc_url token
patrykgruszka Oct 3, 2024
817e4f7
Merge branch '5.x' into DPMMA-2831_preferences-unsubscribe-all
favour-chibueze Oct 15, 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
8 changes: 6 additions & 2 deletions docs/channels/emails.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,15 +276,19 @@
Unsubscribing
*************

Mautic has a built in means of allowing a Contact to unsubscribe from Email communication. You can insert the tokens ``{unsubscribe_text}`` or ``{unsubscribe_url}`` into your Email to have the text or the URL show at your desired location. The unsubscribe text token inserts a sentence with a link instructing the Contact to click to unsubscribe.
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.

Check warning on line 280 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": 280, "column": 25}}}, "severity": "WARNING"}
- ``{unsubscribe_url}``: Inserts the URL to the preferences center when it's activated, or to the unsubscribe page if not.

Check warning on line 281 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": 281, "column": 24}}}, "severity": "WARNING"}

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

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": 16}}}, "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 'Marketing Messages' instead of 'marketing messages'.

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

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

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Marketing Messages' instead of 'marketing messages'.

Raw Output:
{"message": "[Vale.Terms] Use 'Marketing Messages' instead of 'marketing messages'.", "location": {"path": "docs/channels/emails.rst", "range": {"start": {"line": 282, "column": 58}}}, "severity": "ERROR"}

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": 104}}}, "severity": "INFO"}

The unsubscribe URL token inserts the URL into your custom written instructions.

For example:

.. code-block:: html

<a href="{unsubscribe_url}" target="_blank">Want to unsubscribe?</a>
<a href="{unsubscribe_url}" target="_blank">Manage your email preferences</a>
<a href="{dnc_url}" target="_blank">Unsubscribe from all emails</a>

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

Expand Down
Loading