Email Templates
From Flux Developer Portal
Configure Email Templates is accessible under the Community Settings section of your community manager. From the Configure Email Templates page, the Community Admin can perform the following actions:
- Customize the content of an individual email template, including both text and HTML versions.
- Revert a customized template to the default state.
- View the content of an email template.
- Suppress individual email templates so that members of their community will not receive that specific email.
Definitions
- Email Templates = The template for emails sent by the community, such as Welcome, Change Password, etc.
- Content, Content Object = Element of the content
- UCID = Unique identifier in flux. Every content object, user and community has UCID.
- Replacement Tag = Specially formatted text, which will be substituted by appropriate text value during email creation.
How Can I View, Suppress, or Customize an Email Template?
- Click “Community Manager” from the “More” menu dropdown:
- Click “Manage Email Templates” under the “Customize” section of your Community Manager.
- You will see a list of email templates available for your community.
- To preview a template, click the template title under the Email Template heading.
- The template will open in preview mode.
- To disable a template, so that the email no longer gets sent to members on your community, simply click the “Disable Email” button for that template.
- The “Disable Email” button will change to “Enable Email” and you will see a message indicating the email template is suppressed.
- If you want to start sending a disabled email again, simply click the “Enable Email” button.
- To edit a template, click the Edit icon under “Actions” for the template you wish to customize.
- You can also select the “Edit” button at the bottom of the view-only version of the template.
- From the Edit Screen, you can choose the email template type (HTML, Plain Text, or MultiPart), change the “From”, “Subject” and/or Body text. You can also revert an already customized email template to the flux default version, by clicking “Revert to Default”. If you want to preview your template while editing, just click the “Preview” button from the Edit screen.
- flux email templates support multipart messages (MIME). You can send messages as text, html or both.
If you want to have both the text and the HTML versions of your message in one email please, choose the “MultiPart” radio button from the Edit screen and use the following code example
%BOUNDARY_GUID%
Content-Type: text/plain; charset=utf-8
[Here copy & paste your text template]
%BOUNDARY_GUID%
Content-Type: text/html; charset=utf-8
[Here copy & paste your HTML template]
%BOUNDARY_GUID%
If you want to have text or html message please use the following example
- IMPORTANT! Don’t forget to save your changes by clicking “Save” at the bottom of the page.
Email Templates Replacement Tags
Introduction
This section contains descriptions of all replacement tags available in email templates. A replacement tag is specially formatted text, which will be substituted by appropriate text value during email creation.
Example:
%COMMUNITY_TITLE%
The tag in the example above will be replaced by community title (as set in the Title field on Community Settings page).
Every replacement tag starts and ends with % character.
Replacement tags
All replacement tags will be dynamically replaced by the appropriate value from system, as described in “Description” sections under each below.
%SUBJECT% Pulls subject of the message.
%RECIPIENT_UCID% Pulls recipient user UCID.
%RECIPIENT_USERNAME_OR_EMAIL% Pulls recipient username. If username is empty,
it pulls the following value - Email:[recipient email].
%RECIPIENT_PASSWORD% Pulls recipient password.
%RECIPIENT_DISPLAYNAME% Pulls recipient display name.
%COMMUNITY_DOMAIN% Pulls community domain name.
%COMMUNITY_TITLE% Pulls community title.
%COMMUNITY_THUMBNAIL_URL% Pulls absolute path to the community thumbnail (size 70x70).
%FLUX_THUMBNAIL_SMALL% Pulls absolute path to flux thumbnail (size 50x50).
%RECIPIENT_URLNAME_OR_URLUCID% Pulls recipient username. If username is not set, pulls recipient UCID.
%SENDER_URLNAME_OR_URLUCID% Pulls sender username. If username is not set, pulls sender UCID.
Message type specific tags
%EMAIL_VERIFICATION_ID% Pulls verification GUID. Tag is available only for Welcome and Verification emails.
%CONTENT_UCID% Pulls commented content UCID. Tag is available only for Comment notification email.
%CONTENT_TYPE% Pulls content type (it can be Picture, Video, Post, Topic, Audio, User, etc).
Tag is available only for Comment notification email and Share email.
% CONTENT_TITLE% Pulls content title. Tag is available only for External Share Message.
%INVITATION_CODE% Pulls invitation identifier (GUID). Tag is available only for Invitation emails.
%SENDER_DISPLAYNAME% Pulls sender display name. Tag is available only for Invitation and External Share Message.
%SENDER_THUMBNAIL_URL% Pulls absolute path to sender thumbnail (size 25x25).
Tag is available only for External Share Message.
%SHARE_MESSAGE_BODY% Pulls share message text. Tag is available only for External Share Message.
%SHARE_SOURCE% Pulls the following text, source: [Content Owner Display Name].
Tag is available only for External Share Message.
%CONTENT_DETAIL_URL% Pulls absolute path to the content detail page for shared content.
Tag is available only for External Share Message.
Multipart message tag
%BOUNDARY_GUID% This parameter helps to create multipart templates.
It allows you to create different parts in the same email. E.g. you can have both text and html parts in the email.
Sample
From: %FROM_TITLE% <%FROM_EMAIL_PREF%@%FROM_EMAIL_SUF%>
Subject: %SUBJECT%
MIME-Version: 1.0
Content-Type: multipart/alternative;
boundary=%BOUNDARY_GUID%
%BOUNDARY_GUID%
Content-Type: text/plain; charset=utf-8
[Plain text message here]
%BOUNDARY_GUID%
Content-Type: text/html; charset=utf-8
[Html message here]
%BOUNDARY_GUID%
Tags for the FROM field
%FROM_TITLE% Pulls sender display name (for user) or title (for community). Tag can be used only in the FROM field.
Sample
From: %FROM_TITLE% <%FROM_EMAIL_PREF%@%FROM_EMAIL_SUF%>
%FROM_EMAIL_PREF% By default pulls the “no-reply” text, but can be initiated by other community specific value.
Tag can be used only in the FROM field. See sample for %FROM_TITLE%
%FROM_EMAIL_SUF% By default pulls the community domain name, but can be initiated by other community specific value.
Tag can be used only in the FROM field. See sample for %FROM_TITLE%
