Email on CloudBolt Documentation

Email templates

Mon, 01 Jan 0001 00:00:00 +0000

Templates are listed by name and slug on the Templates tab of Admin > Email Settings.

Edit a template

On the Templates tab, select the pencil icon in the template’s row. Each template has the following fields:

Field	Description
Subject	The subject line, rendered with the context the sender passes in.
From address	A sending address, written as `Full Name <email@address>`. Leave empty to use the default from Email Settings.
CC Addresses, BCC Addresses	Comma-separated addresses copied on every email from this template.
Body	The HTML body, rendered with the context the sender passes in. Omit `<html>` and `<body>` tags, as these are supplied by the wrapper described below.
Text body	The plain-text body. If left empty, CMP strips the tags from the HTML body and uses the result.

For example, to drop the rate from the Order Complete email, find this block in the Body field:

Send email manually

Mon, 01 Jan 0001 00:00:00 +0000

There is one helper for the administrator and one for any list of recipients, and both render an email template.

Email the administrator

email_admin() writes to the CB Admin address on Email Settings. Provide a subject and a message:

from utilities.mail import email_admin

email_admin(context={'subject': 'Hello', 'message': 'My email message'})

To use a specific template, pass its slug. The context is rendered into the template’s Subject, Body, and Text body fields:

from utilities.mail import email_admin

email_admin(
    slug='order-complete',
    context={
        'subject': 'Your order is complete',
        'message': 'Success!',
        'order': order,
    },
)

Email anyone else

email() takes a list of recipients, allowing you to reach, for example, a group’s admins or a server owner:

Send email automatically

Mon, 01 Jan 0001 00:00:00 +0000

Each one is rendered from a built-in, customizable email template.

Orders

When an order needs approval, CMP emails the approvers for that order’s group. See Users.
Send Reminder on the order sends approvers another request.
When an order is finished, CMP emails the requester with the result. This is controlled by the Email on order completion setting in Email Settings, enabled by default.
When an order that names a recipient finishes successfully, that recipient is emailed.

Rules and actions

Several built-in rules send email as their action. You can see the pattern in the Then behavior of the Notify admins when a newer version of CloudBolt is available rule, and copy it in your own rules.