Use email templates to notify clients about important events
In the Back Office, you can manage predefined email templates that are used to notify clients about important events, such as creating new master and investment accounts or subscribing and unsubscribing to/from master accounts.
To view a full list of predefined email templates, go to System > Templates > Email > Templates.
The following is a list of email templates used for email notifications specific to the B2COPY investment platform:
| Template type name | Description |
|---|---|
New copy-trading accounts | |
| Used to notify a client about a newly created copy-trading master account and provide the account details |
| Used to notify a client about a newly created copy-trading investment account and provide the account details |
New MAM accounts | |
| Used to notify a client about a newly created MAM master account and provide the account details |
| Used to notify a client about a newly created MAM investment account and provide the account details |
New PAMM accounts | |
| Used to notify a client about a newly created PAMM master account and provide the account details |
| Used to notify a client about a newly created PAMM investment account |
New subscriptions (used for all copy-trading, MAM, and PAMM subscriptions) | |
| Used to notify a master account owner about a new subscription to their master account and provide subscription details |
| Used to notify an investor about their new subscription to a master account and provide subscription details |
| Used to notify an investor about their unsubscription from a master account |
Other | |
| Sent to a client after the client clicks the Reset password button on the Settings page in the Web UI in order to change the password for their trading account, and then selects the Random method setup. In this case, the email notification includes a newly generated password. |
Manage email templates
You can disable or enable email templates, change the subjects of email notifications, and edit the HTML and Twig code that forms the email body.
Making substantial changes to predefined email templates requires a good understanding of HTML and Twig. If you're not familiar with these instruments, it's recommended to make only minor edits, such as changing the text color or company name.
Modify a selected email template as follows:
On the Email template page, click the Edit button located in the template row.The Edit email template page opens.
To disable the email template, select No in the Enabled dropdown. If the template is disabled, notifications about the related event aren’t sent to clients.
To enable the email template, select Yes in the Enabled dropdown.
To change the email subject, update the text displayed in the Subject field. The email subject typically includes your company name followed by the specific subject of the email notification.
{{ keyvalue('mail_subject_company') }} | Master Account Created
The company name is stored in a key-value pair. In this case, the key “mail_subject_company” is assigned a string containing your company name. During email rendering, the key is replaced with your company name. For a list of key-value pairs supported for email templates and details on how to assign values to keys refer to Set key-value pairs below.
In the Email Template field, you can view the email body coded in HTML and Twig. The Preview field displays how the code will be rendered in emails.
The preview may not show all possible template variants because a template may include variables that are substituted with actual values during email rendering. For example, the following Twig code substitutes a client's name into an email notification:
If the name is specified in a client profile, it is substituted into the email notification; otherwise, “Dear client!” is used instead of the client’s name.
In addition to substitutional variables, the email body may contain keys that are replaced with values that are stored in the key-value storage (for details, refer to Set key-value pairs below).
Click Save to apply the changes made to the email template.
Set key-value pairs
Email templates for client notifications contain keys that are replaced with the values assigned to them. These key-value pairs are stored in the key-value storage. You can modify the values assigned to keys as follows:
Go to System > Key storage > Key storage values.
The following are some keys commonly used in email notifications. You can change the values assigned to these keys.
mail_subject_company – the name of your company displayed in the subjects of email notifications
mail_company_name – the name of your company displayed in the text of email notifications
mail_support_email – the email address of the Support team in the text of email notifications
mail_logo_url – the URL of an image that is included as a company logo in email notifications
mail_logo_height – the logo height, in pixels
mail_logo_width – the logo width, in pixels
mail_text_color – the text color used in email notifications
mail_content_bg – the background color applied to content blocks in email notifications
mail_body_bg – the background color applied to email notifications
Select a key and click the Edit button located in the key row.
In the Value field, enter a new value that you want to assign to the selected key.
Click Save to apply the changes.
View a list of sent email notifications
To view a list of email notifications sent to your clients, go to Mailing > System > Log.
On the Mailing Log page, you can view a list of email notifications sent to clients and view the following information:
ID The email identifier in the system.
Active queue ID The identifier of the queue in which the email is included.
Email The client email address.
Subject The email subject.
Attempt date The date and time of the last attempt to send the email.
Status The email delivery status:
IN PROGRESS
FAIL
SUCCESS
Reason The reason why the email delivery failed.
Last updated
