Codex Home → Emails → Email Tokens

Email Tokens

With the release of BuddyPress 2.5.0, site administrators can easily edit the contents of email notifications. These notifications use “tokens,” which are generic placeholders that are replaced with specific data when a single message is generated and sent.

We’ve created some general-purpose tokens that are available for use in any message, like the display name of the recipient (tokenized as {{recipient.username}}). Because messages sent in different contexts need different information to be meaningful, each message also has access to more specific tokens. Take the message sent when a member is invited to a group, for instance. It includes tokens that allow you to include the group’s name, the display name and member profile of the member who extended the invitation, and a link to the recipient’s “manage invitations” screen. The tokens available in each specific message are listed below.

Finally, some tokens are wrapped in two sets of curly braces, like {{site.description}}, while other are wrapped in three sets, like {{{site.url}}}. Tokens wrapped in three braces are treated differently (they are not escaped on merging) which is critical for including working links, for instance. So, keep track of how many braces the token you’re including needs to work properly.

 

Global tokens available in all messages

{{site.admin-email}}	Email address of the site administrator.
{{{site.url}}}	Value of home_url().
{{site.description}}	Value of ‘blog description’.
{{site.name}}	Value of ‘blog name’.
{{recipient.email}}	Email address of recipient.
{{recipient.name}}	Display name of recipient.
{{recipient.username}}	Username (login) of recipient.
{{{unsubscribe}}}	Link to the recipient’s email notifications settings screen in his or her user profile.
{{email.subject}}	The subject line of the email.

 

Activity

[{{{site.name}}}] {{poster.name}} mentioned you in a status update

Situation: Recipient was mentioned in an activity update.

{{usermessage}}	The content of the activity update.
{{{mentioned.url}}}	Permalink to the activity item.
{{poster.name}}	Display name of activity item author.
{{receiver-user.id}}	The ID of the user who is receiving the update.

 

[{{{site.name}}}] {{poster.name}} mentioned you in an update

Situation: Recipient was mentioned in a group activity update.

{{usermessage}}	The content of the activity update.
{{{mentioned.url}}}	Permalink to the activity item.
{{poster.name}}	Display name of activity item author.
{{group.name}}	Name of the group housing the activity update. Empty if not in a group.
{{receiver-user.id}}	The ID of the user who is receiving the update.

 

[{{{site.name}}}] {{poster.name}} replied to one of your updates

Situation: A member has replied to an activity update that the recipient posted.

{{usermessage}}	The content of the comment.
{{poster.name}}	Display name of comment author.
{{{thread.url}}}	Permalink to the original activity item thread.
{{comment.id}}	The comment ID.
{{commenter.id}}	The ID of the user who posted the comment.
{{original_activity.user_id}}	The ID of the user who wrote the original activity update.

 

[{{{site.name}}}] {{poster.name}} replied to one of your comments

Situation: A member has replied to a comment on an activity update that the recipient posted.

{{usermessage}}	The content of the comment.
{{poster.name}}	Display name of comment author.
{{{thread.url}}}	Permalink to the original activity item thread.
{{comment.id}}	The comment ID.
{{parent-comment-user.id}}	The ID of the user who wrote the immediate parent comment.
{{commenter.id}}	The ID of the user who posted the comment.

 

Members

[{{{site.name}}}] Activate {{{user-site.url}}}

Situation: Recipient has registered for an account and site.

{{{activate-site.url}}}	Link to the site’s membership and new blog activation page.
{{{user-site.url}}}	The link to the new blog created by the user.
{{title}}	The new blog’s title.
{{domain}}	The new blog’s domain.
{{path}}	The new blog’s path.
{{key_blog}}	The activation key created in wpmu_signup_blog().
{{user.email}}	The new user’s email address. (Dupes recipient.email?)

 

[{{{site.name}}}] Activate your account

Situation: Recipient has registered for an account.

{{{activate.url}}}	Link to the site’s membership activation page, including the user’s activation key.
{{key}}	Activation key.
{{user.email}}	The new user’s email address. (Dupes recipient.email?)
{{user.id}}	The new user’s ID.

 

[{{{site.name}}}] New friendship request from {{initiator.name}}

Situation: A member has sent a friend request to the recipient.

{{{friend-requests.url}}}	Link to the user’s friendship request management screen.
{{{initiator.url}}}	The initiator’s user profile.
{{initiator.name}}	Display name of the initiator.
{{friendship.id}}	ID of the friendship object.
{{friend.id}}	ID of the request recipient.
{{initiator.id}}	ID of the user who initiated the request.

 

[{{{site.name}}}] {{friend.name}} accepted your friendship request

Situation: Recipient has had a friend request accepted by a member.

{{{friendship.url}}}	Link to the request recipient’s user profile.
{{friend.name}}	Display name of the request recipient.
{{friendship.id}}	ID of the friendship object.
{{friend.id}}	ID of the request recipient.
{{initiator.id}}	ID of the user who initiated the request.

 

[{{{site.name}}}] Verify your new email address

Situation: Recipient has changed their email address.

{{{verify.url}}}	Link used to verify the new email address.
{{displayname}}	Display name of recipient (Dupes recipient.name?)
{{old-user.email}}	The user’s previous email address.
{{user.email}}	The user’s new email address.

 

Private Messages

{{{site.name}}}] New message from {{sender.name}}

Situation: Recipient has received a private message.

{{usersubject}}	The subject of the message.
{{usermessage}}	The content of the message.
{{{message.url}}}	Link to the message thread.
{{sender.name}}	Display name of the message sender.

 

Groups

[{{{site.name}}}] Group details updated

Situation: A group’s details were updated.

{{changed_text}}	Text describing the details of the change.
{{{group.url}}}	Link to the group.
{{group.name}}	Name of the group.
{{group.id}}	ID of the group.

 

[{{{site.name}}}] Membership request for group: {{group.name}}

Situation: A member has requested permission to join a group.

{{group.name}}	Name of the group.
{{{group-requests.url}}}	Link to the group’s membership requests management screen.
{{requesting-user.name}}	Display name of the user who is requesting membership.
{{{profile.url}}	User profile of the user who is requesting membership.
{{admin.id}}	ID of the group admin who is receiving this email.
{{group.id}}	ID of the group.
{{membership.id}}	ID of the membership object.
{{requesting-user.id}}	ID of the user who is requesting membership.

 

Title: [{{{site.name}}}] Membership request for group “{{group.name}}” accepted

Situation: Recipient had requested to join a group, which was accepted.

{{group.name}}	Name of the group.
{{{group.url}}}	Link to the group.
{{group.id}}	ID of the group.
{{requesting-user.id}}	ID of the user who is requesting membership.

 

Title: [{{{site.name}}}] Membership request for group “{{group.name}}” rejected

Situation: Recipient had requested to join a group, which was rejected.

{{group.name}}	Name of the group.
{{{group.url}}}	Link to the group.
{{group.id}}	ID of the group.
{{requesting-user.id}}	ID of the user who is requesting membership.

 

[{{{site.name}}}] You have been promoted in the group: “{{group.name}}”

Situation: Recipient’s status within a group has changed.

{{group.name}}	Name of the group.
{{{group.url}}}	Link to the group.
{{promoted_to}}	String describing new group responsibilitied. Possible values: ‘an administrator’ or ‘a moderator’.
{{group.id}}	ID of the group.
{{user.id}}	ID of the promoted user.

 

[{{{site.name}}}] You have an invitation to the group: “{{group.name}}”

Situation: A member has sent a group invitation to the recipient.

{{group.name}}	Name of the group.
{{{group.url}}}	Link to the group.
{{inviter.name}}	Inviter’s display name wrapped in a link to that user’s profile.
{{{inviter.url}}}	Link to the profile of the user who extended the invitation.
{{{invites.url}}}	Link to the recipient’s invitation management screen.

---