Email templates and customization

Before sending any emails you have to create a new email template and define a unique key in ROQ Console.

ROQ already provides email templates for user invitation mail, reset password mail, and email confirmation for usage such as registration confirmation.

Email templates

Add Templates

To create a new email template, go to Transactional Mails → Templates menu.

Create email templates

Click the + Create Mail Template button and then set all these required keys:

Key: This is the key used to send email in code.
Select Locale: The email locale template.
Subject: The email subject.
Content: The email content.

Create email template

Editing Templates

To edit a template, click Edit Template button (pen icon) on Controls section of the Templates table.

edit email template

Deleting Templates

To delete an email template, click the Trash button and confirm the deletion.

⚠️

Be careful to delete any email template on ROQ Console. Make sure the email template is not used in any application code because it will make a runtime error if there is a code that sends an email with a nonexisting email template.

Template Content

The email content support custom variables which you can set later through code. Basically, you can create any text for the email content. You can use placeholders or variables for any content you submit in the data parameter of the sendMail API.

For instance using HTML content as a template for a New Product Release with custom variables: recipients_name, website_url, support_contact, your_name, your_position, and your_contact_information.

<!DOCTYPE html>
<html>
<head>
    <title>New Product Release</title>
</head>
<body>
    <p>Hello {{recipients_name}},</p>
    
    <p>I hope this email finds you well.</p>
 
    <p>We're thrilled to announce the release of our latest product, an innovative AI software designed to revolutionize the process of video captioning. This product promises to streamline your workflow and enhance your content's accessibility like never before.</p>
 
    <h3>Our AI Captioner brings along the following impressive features:</h3>
    
    <ul>
        <li><strong>Automated Captioning:</strong> Our software uses cutting-edge AI technology to automatically transcribe and time-code video captions, reducing the need for manual intervention.</li>
        <li><strong>Accuracy:</strong> We leverage the power of AI to deliver the highest level of accuracy, ensuring your content is represented as precisely as possible.</li>
        <li><strong>Multilingual Support:</strong> Our software supports a wide range of languages, providing an inclusive experience for your diverse audience.</li>
        <li><strong>Easy Editing:</strong> The AI Captioner provides an easy-to-use interface for reviewing and editing the automatically generated captions.</li>
        <li><strong>Fast Turnaround:</strong> Thanks to the power of AI, we offer lightning-fast caption generation without compromising on accuracy or quality.</li>
    </ul>
 
    <p>We strongly believe that this new software will make a significant difference in your content production, saving time and resources, and making your videos more accessible to a wider audience.</p>
 
    <p>We'd love to offer you a free trial so you can experience firsthand how the AI Captioner can revolutionize your content production process. Please visit our website at <a href="{{website_url}}">{{ website_url }}</a> to start your trial today.</p>
 
    <p>If you have any questions, feel free to reply to this email or contact our support team at {{ support_contact}}.</p>
 
    <p>Thank you for your time, and we look forward to your feedback on our newest innovation.</p>
 
    <p>Best Regards,</p>
    
    <p>{{your_name}}<br>
    {{your_position}}<br>
    {{your_contact_information}}</p>
</body>
</html>

API Send Emails