Document toolboxDocument toolbox

Emails

Add, remove, or edit email templates. Email Templates are used when creating new projects, or sending on project information reminders. The information an email contains can be customized to the Server Administrators needs. 

Creating and Editing templates

Email templates can be simple or more advanced with embedded code. They can be either plain or HTML format.

We use a templating language called Liquid all features here are available for use.

You can insert variables in the email templates using "{{ variable }}" a list of available variables is further down on the page. We have two types of emails that can be sent, either emails for new users or reminders to existing users. The two types have different variables available.


Available variables for new user email: 

Variable

Description

Variable

Description

project_user.project.name

Project Name

project_user.project.description

Project Description

project_user.name

Full Name of new user

project_user.email

Email for new user

project_user.first_name

First name for new user

project_user.last_name

Last name for new user

project_user.project.database.name

Name of database for the project

project_user.project.database.server

Server for database for the project

project_user.project.owner

Name of the owner of the project

Control flow variables for new user email

Variable

Description

Variable

Description

new_user

If the user is a completely new user or if they are just new in the project

different_owner

If the user sending the email is from another owner(or is a server administrator


Available variables for reminder email: 

Variable

Description

Variable

Description

user.name

Full Name of user

user.email

Email for  user

user.last_name

Last name for  user

user.first_name

First name for the user

user.username

Username for the user

server

Server for the user

Available variables for both types

Variable

Description

Variable

Description

pw

Password for the user(if it has been generated)

current_user.name

Name of the user sending the email

current_user.firm

Firm of the user sending the email

project_list

List of projects the user has access to