View as Markdown
You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

Email Notifications

Applies to: Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · Archived documentation

When your users are unable to open the editor due to initialization errors, you can receive email notifications to be aware of this. Customer's Canvas allows you to send messages about initialization errors and missing designs, mockups, or fonts.

To enable email notifications, you need the following setup:

  1. Specify your email in the IssueNotificationEmail key in ~\Configuration\AppSettings.config.
  2. Configure your mail service in ~\Configuration\email\mail.config.
  3. Add your details to ~\Configuration\email\MailTemplate.txt or leave this file as is.

Configuring Your Mail Service

Customer's Canvas contains configuration files specifying the email notifications in the ~\Configuration\email\ folder.

If you open ~\Configuration\email\mail.config, you can find the following configuration parameters.

XML 
<?xml version="1.0"?>
<Configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <SmtpServerName>smtp.example.com</SmtpServerName>
    <Port>465</Port>
    <SslEnabled>true</SslEnabled>
    <AuthMethod>Login</AuthMethod>
    <From>noreply@example.com</From>
    <Login>[LOGIN]</Login>
    <Password>[PASSWORD]</Password>
    <TemplateFileName>MailTemplate.txt</TemplateFileName>
</Configuration>

Here, you need to specify your SMTP server and port number. In the AuthMethod parameter, you can specify either a Login, Auto, or None authentication type on your SMTP server. If AuthMethod differs from None, you need to specify a Login and Password. The From parameter is an email address that appears as a sender in the notifications. You can also enable Secure Sockets Layer.

TemplateFileName refers to a template defining the content of notifications. By default, this is the MailTemplate.txt file in plain text without markup. You can use two placeholders in these notifications: [TIMESTAMP] and [MESSAGE]. The message describes details about the error that has occurred. When you open this file, you can see the following default template.

[TIMESTAMP]: [MESSAGE]

The subjects of emails are not configurable. Customer's Canvas specifies error types in the subjects.

Example Emails

If initialization errors occur, Customer's Canvas sends emails in the following formats.

  • Missing design files
    Subject:
Customer's Canvas - failed to load due to missing design/mockup
Content:
1 May 2018 13:42:18 PM -07:00: Customer's Canvas failed to load due to a missing design file: unknown
  • Missing fonts were substituted
    Subject:
Customer's Canvas - missing fonts are replaced with default fonts
Content:
1 May 2018 13:48:2 PM -07:00: Customer's Canvas failed to load due to missing font(s).
Customer's Canvas was unable to find the following font(s): MetroScript, PeoniPro used in the following design(s): FancyCard.psd
The editor loaded default fonts instead of the missing fonts which may cause the product(s) to look incorrectly.
  • Missing fonts were not substituted
    Subject:
Customer's Canvas - failed to load due to missing font(s)
Content:
1 May 2018 13:49:40 PM -07:00: Customer's Canvas was unable to find the following font(s): MetroScript, PeoniPro used in the following design(s): FancyCard.psd
  • Other server errors
    Subject:
Customer's Canvas - failed to load due to a server error
Content:
1 May 2018 13:51:34 PM -07:00: Customer's Canvas failed to load due to a server-side exception. The error details are the following:
Exception: One or more errors occurred.
Inner exception: The media format is not supported.
Call stack: ...
Request data: ...

See Also

Manual