Email parameters and templates configuration
Enable the email subsystem
Tiledesk uses NodeMailer to send outbound emails (project invitations, email verification, subscriptions, notifications, etc.).
To enable the email service set the following environment property to true for your tiledesk-server component. The default value is false.
EMAIL_ENABLED=trueSMTP configuration
The following environment variables configure the outbound SMTP subsystem:
EMAIL_HOST = YOUR_EMAIL_HOST Specifies the SMTP host name (defaults to "localhost"). This is the host name or IP address of the server to which email should be sent.
EMAIL_USERNAME = YOUR_EMAIL_USERNAME Specifies the user name of the account that connects to the SMTP server.
EMAIL_PASSWORD = YOUR_SMTP_PASSWORD Specifies the password for the user name used in EMAIL_USERNAME.
EMAIL_SECURE = true|false If true the connection will use TLS when connecting to the server. If false (the default) then TLS is used if the server supports the STARTTLS extension. In most cases set this to true when connecting to port 465. For port 587 or 25 keep it false. (Note: default port is 587 if EMAIL_SECURE is false, or 465 if true.)
EMAIL_PORT = 25 The port to connect to (defaults to 587 if EMAIL_SECURE is false, or 465 if true).
EMAIL_FROM_ADDRESS = FROM_EMAIL_ADDRESS The email address from which notifications are sent. This setting is used for emails not triggered by a user (for example, activity notification emails).
EMAIL_BASEURL = https://YOOURDOMAIN.com/dashboard The dashboard endpoint. Default value is: https://panel.tiledesk.com/v3/dashboard
Example (environment file):
EMAIL_HOST=smtp.example.com
EMAIL_USERNAME=your_username
EMAIL_PASSWORD=your_password
EMAIL_SECURE=false
EMAIL_PORT=587
EMAIL_FROM_ADDRESS=[email protected]
EMAIL_BASEURL=https://yourdomain.com/dashboardEmail template configuration
You can customize email templates using multiline environment variables of your tiledesk-server component. Provide the HTML templates as env values.
Supported template env variables:
EMAIL_ASSIGN_REQUEST_HTML_TEMPLATE — Email sent to notify a new request in the assigned mode.
EMAIL_ASSIGN_MESSAGE_EMAIL_HTML_TEMPLATE — Email sent to notify a new request in the assigned mode for inbound email channel.
EMAIL_POOLED_REQUEST_HTML_TEMPLATE — Email sent to notify a new request in the pooled mode.
EMAIL_POOLED_MESSAGE_EMAIL_HTML_TEMPLATE — Email sent to notify a new request in the pooled mode for inbound email channel.
EMAIL_NEW_MESSAGE_HTML_TEMPLATE — Email sent to the requester to notify a new message when the requester is offline.
EMAIL_TICKET_HTML_TEMPLATE — Email sent to the requester to notify a new message for inbound email channel.
EMAIL_FOLLOWER_HTML_TEMPLATE — Email sent to the request follower to notify an update.
EMAIL_DIRECT_HTML_TEMPLATE — Email sent for direct message.
EMAIL_RESET_PASSWORD_HTML_TEMPLATE — Email sent when a user resets the password.
EMAIL_PASSWORD_CHANGED_HTML_TEMPLATE — Email sent when the password is changed.
EMAIL_EXUSER_INVITED_HTML_TEMPLATE — Email sent when an agent invites an existing platform user.
EMAIL_NEWUSER_INVITED_HTML_TEMPLATE — Email sent when an agent invites a new user.
EMAIL_VERIFY_HTML_TEMPLATE — Email sent when an agent signs up on the platform.
EMAIL_SEND_TRANSCRIPT_HTML_TEMPLATE — If "Transcript by email" is enabled this email is sent automatically at the end of each chat to the requester.
Default templates are available in the tiledesk-server repository: https://github.com/Tiledesk/tiledesk-server/tree/master/template/email
Additional resources
NodeMailer documentation (used by Tiledesk): https://nodemailer.com/
Default email templates: https://github.com/Tiledesk/tiledesk-server/tree/master/template/email