This documentation relates to CiviCRM version 3.3. It's not maintained anymore.
Current version of documentation.

CiviMail Action Tokens

Aller directement à la fin des métadonnées
Aller au début des métadonnées

This page refers to outdated version of CiviCRM. Check current version of documentation.


Documentation Search


CiviCRM 3.3 Documentation

Support and Participation

Developer Resources


CiviCRM book!

Make sure to check out Understanding CiviCRM as well! You can also support this project by ordering a hard copy.

CiviMail uses a number of action tokens which can be placed in Mailing Messages, Footers, and Automated Messages. These tokens are converted dynamically to text, reply-to email addresses, and URLs. The chart belows describes each token, where it can be used and an example of how to use it.

Required Tokens

The following tokens MUST be included in all CiviMail mailings - either in the mailing body, the header or the footer:

  • {action.optOutUrl} OR {action.optOut} - Clickable opt-out link (optOutUrl) is recommended
  • {domain.address} - Display postal address for sending organization.

This table documents the available tokens, their purpose and the place(s) they can be used. Refer to Mail-merge Tokens for Contact Data to learn about tokens you can use to insert contact information like First and Last Name in your mailings.

Token

Purpose

Where used...

Example

{action.unsubscribeUrl}

Provides an unsubscribe link for each recipient.

Mailing Body, Header, Footer,unsubscribe,resubscribe

To unsubscribe from this mailing, click <a href="{action.unsubscribeUrl}" >here</a>.

{action.unsubscribe}

Provides an unsubscribe email address for each recipient

Mailing Body, Header, Footer,unsubscribe,resubscribe

To unsubscribe from this mailing, send mail to {action.unsubscribe}

{action.resubscribeUrl}

Provides a re-subscribe link for each recipient

Mailing Body, Header, Footer,unsubscribe,resubscribe

To resubscribe to this mailing, click <a href="{action.resubscribeUrl}" >here</a>.

{action.resubscribe}

Provides a re-subscribe email address for each recipient.

Mailing Body, Header, Footer,unsubscribe,resubscribe

To resubscribe to this mailing, send mail to {action.resubscribe}

{action.optOutUrl}

Provides an opt-out link for each recipient.

Mailing Body, Header, Footer,unsubscribe,resubscribe

To opt-out of all future mailings from us, click <a href="{action.optOut}" >here</a>.

{action.optOut}

Provides an opt-out email address for each recipient.

Mailing Body, Header, Footer,unsubscribe,resubscribe

To opt-out of all mailings from us, send mail to {action.optOut}

{action.forward}

Provides a link for each recipient to forward the mailing to others.

Mailing Body, Header, Footer

To forward this mailing to friends or colleagues, click <a href="{action.forward}" >here</a>.

{action.reply}

 Provides a reply-to email address for each recipient

Mailing Body, Header, Footer,unsubscribe,resubscribe

To reply to this mailing, send mail to {action.reply}

 {action.subscribeUrl}

Provides a link to view and subscribe to any public mailing lists.

Mailing Body, Header, Footer

To see our mailing lists and join the ones you're interested in, click <a href="{action.subscribeUrl}" >here</a>.

 {action.subscribeUrl.gid}

Provides a link to subscribe to a specific group (gid = CiviCRM ID of that group).

  Mailing Body, Header, Footer

 To subscribe to our Monthly Newsletter, click <a href="{action.subscribeUrl.2}" >here</a>.

 {action.subscribe.gid}

Provides an email address to subscribe to a specific group.

Mailing Body, Header, Footer

To subscribe to our Monthly Newsletter, send mail to {action.subscribe}.

{welcome.group}

Displays the newly joined group name in a welcome messages.

Welcome message

Welcome to {welcome.group}.

{subscribe.group}

Displays group name in subscription confirmation requests.

Subscription confirmation request 

You requested to be subscribed to the {subscribe.group}.

{unsubscribe.group}

Displays group name in unsubscribe confirmation messages.

Unsubscribe Message

You have been unsubscribed from {unsubscribe.group}.

{resubscribe.group}

Displays group name in re-subscribe messages.

Resubscribe Message

As requested, you have been resubscribed to {resubscribe.group}.

{domain.name}

Displays your domain name.

Mailing Body or any message templates

This mailing is from {domain.name}.

{domain.address}

Displays postal address for your domain.

Mailing Body or any message templates

Mailing Address:  {domain.address}

{domain.phone}

Displays phone number of domain.

Mailing Body or any message templates

To contact us call   {domain.phone}

{domain.email}

Displays email address of domain.

Mailing Body or any message templates

Or send a mail to  {domain.email}

 {mailing.name}

Displays name of mailing.

Mailing Body, Header, Footer,resubscribe,unsubscribe or optout

Name of this mailing is {mailing.name}.

 {mailing.group}

Displays a listing of the names of the groups to which a mailing has been sent.

Mailing Body, Header, Footer,resubscribe,unsubscribe or optout

This mailing has been sent to the members of {mailing.group}.

Étiquette
  • Aucun

Creative Commons License
Except where otherwise noted, content on this site is licensed under a Creative Commons Attribution-Share Alike 3.0 United States Licence.