Introduction:
Email Tokens in the BuddyBoss Platform are placeholders for dynamic content used in email notifications. These tokens automatically insert personalized details such as user names, links, and other contextual information, enhancing the relevance of your emails. Tokens can be wrapped in either two curly braces {{ }} or three curly braces {{{ }}}. Tokens wrapped in three curly braces are not escaped on merging, which is important for including certain content such as links.
This guide covers:
- Global Tokens – Applicable across all email types.
- Registration Tokens – Used for account registration and activation emails.
- Group Tokens – Used in group-related notifications.
- Forum Tokens – Used in forum discussions and replies.
- Activity Tokens – Used for mentions and activity updates.
- Private Messaging Tokens – Used for private message notifications.
- Connection Tokens – Used for connection (friend request) notifications.
- Invites Tokens – Used for community invitation emails.
1. Global Tokens
These tokens can be used in any email template and provide general information about the site or recipient.
| Token | Description |
{{site.admin-email}} | Email address of the site administrator. |
{{{site.url}}} | URL of the site (value of home_url()). |
{{site.description}} | Site’s description (blog description). |
{{site.name}} | Site’s name (blog name). |
{{recipient.email}} | Email address of the recipient. |
{{recipient.name}} | Display name of the recipient. |
{{recipient.username}} | Username (login) of the recipient. |
{{{unsubscribe}}} | Link to recipient’s email notifications settings. |
{{email.subject}} | The subject line of the email. |
2. Registration Tokens
Used in emails related to account registration, activation, and email verification.
Activation Email
Sent when a user registers for an account.
| Token | Description |
{{{activate.url}}} | Link to account activation page (includes activation key). |
{{key}} | Activation key for the new account. |
{{user.email}} | Email address of the new user. |
{{user.id}} | User ID of the new account. |
Email Verification
Sent when a user changes their email address.
| Token | Description |
{{{verify.url}}} | Link for verifying the new email address. |
{{displayname}} | Display name of the recipient. |
{{old-user.email}} | Previous email address of the user. |
{{user.email}} | New email address of the user. |
3. Group Tokens
Used in group-related notifications such as membership requests, invitations, and promotions.
Group Details Updated
Sent when group details are changed.
| Token | Description |
{{changed_text}} | Description of the updated details. |
{{{group.url}}} | Link to the group. |
{{group.name}} | Name of the group. |
{{{group.small_card}}} | Group card showing group photo and details. |
Membership Request
Sent when a member requests to join a group.
| Token | Description |
{{group.name}} | Name of the group. |
{{{group-requests.url}}} | Link to manage group membership requests. |
{{requesting-user.name}} | Name of the user requesting membership. |
{{{member.card}}} | Profile card of the requesting user. |
4. Forum Tokens
Used in forum-related notifications such as new discussions and replies.
New Discussion
Sent when a new forum discussion is created.
| Token | Description |
{{poster.name}} | Name of the user who created the discussion. |
{{{discussion.url}}} | Link to the newly created discussion. |
{{discussion.title}} | Title of the new discussion. |
{{{discussion.content}}} | Content of the new discussion. |
New Reply
Sent when a user replies to a forum discussion.
| Token | Description |
{{poster.name}} | Name of the member who replied. |
{{{reply.content}}} | Content of the reply. |
{{{thread.url}}} | Link to the discussion thread. |
5. Activity Tokens
Used for mentions, replies, and status updates in activity feeds.
Mention Notification
Sent when a user is mentioned in an activity update.
| Token | Description |
{{usermessage}} | Content of the activity update. |
{{{mentioned.url}}} | Link to the activity item. |
{{poster.name}} | Name of the activity author. |
6. Private Messaging Tokens
Used for notifications related to private messages and replies.
| Token | Description |
{{sender.name}} | Display name of the message sender. |
{{{message}}} | Content of the message. |
{{{message.url}}} | Link to the message thread. |
7. Connection Tokens
Used for connection (friend request) notifications.
New Connection Request
Sent when a member sends a friend request.
| Token | Description |
{{initiator.name}} | Display name of the request initiator. |
{{{initiator.url}}} | Link to the initiator’s profile. |
{{{friend-requests.url}}} | Link to manage friendship requests. |
Request Accepted
Sent when a friend request is accepted.
| Token | Description |
{{friend.name}} | Display name of the new connection. |
{{{friendship.url}}} | Link to the recipient’s profile. |
8. Invites Tokens
Used when a member invites someone to join the community.
| Token | Description |
{{inviter.name}} | Name of the member who sent the invite. |
{{{site.url}}} | URL of the site. |
Best Practices for Using Tokens
- Use {{ }} for regular text placeholders and {{{ }}} for unescaped content like links.
- Double-check token placement to ensure personalized and dynamic content.
- Test emails by sending to yourself to verify the tokens render correctly.
Related Resources
- Customizing Email Layout in BuddyBoss
- Managing Notifications in BuddyBoss
- Improving Email Deliverability in WordPress
