Capture Email Templates Repository

This repository is designed to manage email templates and test data for the capture service. It is built to make it simple and accessible for anyone, including new developers, to create, edit, validate, and preview email templates. You can edit the HTML files using any text editor you prefer.

The Capture service fetches email templates in real time. However, due to a caching mechanism, it may take up to one hour for template updates to take effect.

Service Name

To create customized email templates for Capture-powered services, please contact the Numbers Team at [email protected] to obtain an API Key and reserve a unique service name. You can also optionally customize the service logo and service email used in the templates.

Repository Structure

./templates

• Contains all email templates, organized by service, template name, and language.

• Path structure:

  ./templates/<service-name>/<template-name>/<language>.html

• Defaults:

  • service-name: capture
  • language: en-us

• Fallback Behavior:

  • If a specific language HTML file does not exist for a service and the user has set that language in their preferences, the system will first fall back to en-us for that service.
  • If the en-us file also does not exist for the service, the system will fall back to the capture service's template for the same template name.

Example:

./templates/capture/password_reset/en-us.html

./test

• Contains test data for templates.

• Path structure:

  ./test/<template-name>/data.json

• Test data is shared across all services and languages for a given template.

Example:

./test/password_reset/data.json

Sample content for data.json:

{
  "action_url": "https://api.numbersprotocol.io/account/password_reset/0/0",
  "service_info": {
    "display_name": "The Capture Team",
    "service_logo": "https://static-cdn.numbersprotocol.io/Capture+GradWhite+App.png"
  }
}

How to Add or Modify Templates

Creating a New Set of Templates for a Service

1. Create the Directory Structure:

   Run the following command to create a new directory for the service and copy the existing templates from the capture service:

   mkdir -p ./templates/<new-service-name> && cp -r ./templates/capture/* ./templates/<new-service-name>/

   Replace <new-service-name> with the name of your new service.

2. Edit the Templates: Navigate to the new service's directory and update the templates as needed. Use any editor you prefer. Example:

   nano ./templates/<new-service-name>/password_reset/en-us.html

3. Add or Modify Test Data: Test data is shared across services. If necessary, update the corresponding test data in ./test/<template-name>/data.json. Example:

   nano ./test/password_reset/data.json

4. Validate Your HTML: Run npm run test to ensure your templates are valid.

Modifying an Existing Template

1. Locate the template in ./templates/<service-name>/<template-name>/<language>.html.
2. Make your changes using your preferred editor.
3. Update the corresponding test data in ./test/<template-name>/data.json if needed.
4. Run npm run test to validate the changes.
5. Preview your changes using npm run build and npm run dev.

Commands

npm run test

Validates all HTML templates using the html-validate tool to ensure they meet the required standards.

npm run build

Generates a preview webpage (index.html) for all templates.

npm run dev

Starts a local development server at http://localhost:3000 to preview email content in a browser.

Previewing Email Content

1. Run npm run build to generate the preview webpage.
2. Start the development server using npm run dev.
3. Open http://localhost:3000 in your browser.
4. Select a template from the sidebar to view its content on the right-hand side.