Skip to content
This repository has been archived by the owner on Aug 27, 2021. It is now read-only.

Commit

Permalink
changed refernces to Template Engine to Transactional Template Engine…
Browse files Browse the repository at this point in the history
… or simply transactional templates
  • Loading branch information
eschallock committed Dec 9, 2015
1 parent 583fab3 commit 618a485
Show file tree
Hide file tree
Showing 8 changed files with 48 additions and 50 deletions.
6 changes: 3 additions & 3 deletions source/API_Reference/SMTP_API/apps.html
Expand Up @@ -523,11 +523,11 @@ <h4>Example X-SMTPAPI Header Value</h4>
{% endanchor %}

{% info %}
This setting is our <a href="{{root_url}}/API_Reference/Web_API_v3/Template_Engine/index.html">Template Engine</a>, that supports multiple templates, versioning and more. Previously, we had a Template App, now called the <a href="#template">Legacy Template App</a>.
This setting is our <a href="{{root_url}}/API_Reference/Web_API_v3/Template_Engine/index.html">Transactional Template Engine</a>, that supports multiple templates, versioning and more. Previously, we had a Template App, now called the <a href="#template">Legacy Template App</a>.
{% endinfo %}


<p>Uses a template created with the <a href="{{root_url}}/API_Reference/Web_API_v3/Template_Engine/index.html">Template Engine</a> when sending an email. More information on usage of the Template Engine with the SMTP API may be found in the <a href="{{root_url}}/API_Reference/Web_API_v3/Template_Engine/smtpapi.html">Template Engine API Reference</a>.
<p>Uses a template created with the <a href="{{root_url}}/API_Reference/Web_API_v3/Template_Engine/index.html">Transactional Template Engine</a> when sending an email. More information on using transactional templates with the SMTP API may be found in the <a href="{{root_url}}/API_Reference/Web_API_v3/Template_Engine/smtpapi.html">Transactional Templates API Reference</a>.

<table class="table table-striped table-bordered">
<tbody>
Expand Down Expand Up @@ -570,7 +570,7 @@ <h4>Example X-SMTPAPI Header Value</h4>
{% endanchor %}

{% warning %}
This setting is our original Email Template app, today we have a more full featured <a href="#templates">Template Engine</a>, which supports multiple templates, versioning and more.
This setting is our original Email Template app, today we have a more full featured <a href="#templates">Transactional Template Engine</a>, which supports multiple templates, versioning and more.
{% endwarning %}


Expand Down
50 changes: 25 additions & 25 deletions source/API_Reference/Web_API/filter_settings.md
Expand Up @@ -15,16 +15,16 @@ For a more detailed description of each of the Filters below, please visit the [
All calls to change filter settings are made to the [filter.setup endpoint.]({{root_url}}/API_Reference/Web_API/filter_commands.html#-Setup-App)

{% anchor h2 %}
Address Whitelist
Address Whitelist
{% endanchor %}

*Name - `addresswhitelist`*

{% info %}
When using this call, you must define all emails & domains here. Using this call will overwrite any current settings for this filter. This would also be how you remove an entry, by excluding if from the call.
When using this call, you must define all emails & domains here. Using this call will overwrite any current settings for this filter. This would also be how you remove an entry, by excluding if from the call.
{% endinfo %}
{% parameters addresswhitelist %}
{% parameters addresswhitelist %}

{% parameter name yes 'addresswhitelist' 'The name of the setting.' %}
{% parameter list yes 'A list of email addresses or domains.' 'list[]=support@example.com&list[]=sales@example.com' %}
{% endparameters %}
Expand All @@ -46,13 +46,13 @@ When using this call, you must define all emails & domains here. Using this call
* * * * *

{% anchor h2 %}
BCC "Blind Carbon Copy"
BCC "Blind Carbon Copy"
{% endanchor %}

*Name - `bcc`*

{% parameters bcc %}
{% parameters bcc %}

{% parameter name yes 'bcc' 'The name of the setting.' %}
{% parameter email yes 'An email address to be the BCC recipient.' 'email@example.com' %}
{% endparameters %}
Expand All @@ -74,13 +74,13 @@ BCC "Blind Carbon Copy"
* * * * *

{% anchor h2 %}
Click Tracking
Click Tracking
{% endanchor %}

*Name - `clicktrack`*

{% parameters clicktrack %}
{% parameters clicktrack %}

{% parameter name yes 'clicktrack' 'The name of the setting.' %}
{% parameter enable_text yes 'Enable click tracking in plain text emails.' '0 or 1' %}
{% endparameters %}
Expand All @@ -102,13 +102,13 @@ Click Tracking
* * * * *

{% anchor h2 %}
DKIM
DKIM
{% endanchor %}

*Name - `dkim`*

{% parameters dkim %}
{% parameters dkim %}

{% parameter name yes 'dkim' 'The name of the setting.' %}
{% parameter domain yes 'The domain to sign messages as.' 'example.com' %}
{% parameter use_from no 'If enabled, the domain in the From: header of the email will be used to sign your DKIM.' '0 or 1' %}
Expand All @@ -131,16 +131,16 @@ DKIM
* * * * *

{% anchor h2 -Email-Templates %}
Legacy Email Templates
Legacy Email Templates
{% endanchor %}

*Name - `template`*

{% warning %}
This setting is our original Email Template app, today we have a more full featured [Template Engine]({{root_url}}/API_Reference/Web_API_v3/Template_Engine/index.html), which supports multiple templates, versioning and more. Its settings, however, are controlled using a [separate API]({{root_url}}/API_Reference/Web_API_v3/Template_Engine/index.html).
This setting is our original Email Template app, today we have a more full featured [Transactional Template Engine]({{root_url}}/API_Reference/Web_API_v3/Template_Engine/index.html), which supports multiple transactional templates, versioning and more. Its settings, however, are controlled using a [separate API]({{root_url}}/API_Reference/Web_API_v3/Template_Engine/index.html).
{% endwarning %}
{% parameters template %}
{% parameters template %}

{% parameter name yes 'template' 'The name of the setting.' %}
{% parameter text/html yes 'A string that holds the template html body.' '\<html\>\<head\>\</head\>\<body bgcolor='pink'\>\<div style='width:200px' bgcolor='\#FFF'\>\<% body %\>\</div\>\</body\>\</html\>' %}
{% endparameters %}
Expand All @@ -162,13 +162,13 @@ This setting is our original Email Template app, today we have a more full featu
* * * * *

{% anchor h2 %}
Event Notification
Event Notification
{% endanchor %}

*Name - `eventnotify`*

{% info %}
All fields except version are required for each call.
All fields except version are required for each call.
{% endinfo %}


Expand Down Expand Up @@ -209,7 +209,7 @@ All fields except version are required for each call.
* * * * *

{% anchor h2 %}
Footer
Footer
{% endanchor %}

*Name - `footer`*
Expand Down Expand Up @@ -240,7 +240,7 @@ You must provide either text/html or text/plain, or both, to avoid receiving a "
* * * * *

{% anchor h2 %}
Google Analytics
Google Analytics
{% endanchor %}

*Name - `ganalytics`*
Expand Down Expand Up @@ -274,7 +274,7 @@ At least one of the optional parameters needs to be passed to avoid a "missing p
* * * * *

{% anchor h2 %}
SPAM Filter Checker
SPAM Filter Checker
{% endanchor %}

*Name - `spamcheck`*
Expand Down Expand Up @@ -304,7 +304,7 @@ SPAM Filter Checker
* * * * *

{% anchor h2 %}
Subscription Tracking
Subscription Tracking
{% endanchor %}

*Name - `subscriptiontrack`*
Expand Down Expand Up @@ -338,7 +338,7 @@ You must pass at least one of the optional params in order to avoid the "missing
* * * * *

{% anchor h2 %}
SendGrid for New Relic
SendGrid for New Relic
{% endanchor %}

*Name - `newrelic`*
Expand Down Expand Up @@ -366,7 +366,7 @@ SendGrid for New Relic
* * * * *

{% anchor h2 %}
Sendwithus
Sendwithus
{% endanchor %}

*Name - `sendwithus`*
Expand Down
4 changes: 2 additions & 2 deletions source/API_Reference/Web_API_v3/Template_Engine/index.md
Expand Up @@ -7,11 +7,11 @@ navigation:
show: true
---

The Template Engine API lets you programmatically [create and manage
The transactional templates API lets you programmatically [create and manage
templates]({{ root_url }}/API_Reference/Web_API_v3/Template_Engine/templates.html) for your transactional email. You may [version these templates]({{ root_url }}/API_Reference/Web_API_v3/Template_Engine/versions.html), then [send them through the existing SendGrid API]({{ root_url }}/API_Reference/Web_API_v3/Template_Engine/smtpapi.html).

[Templates]({{ root_url }}/API_Reference/Web_API_v3/Template_Engine/templates.html): Templates are re-usable email layouts, that may be created and interacted with through the API. These are intended to be a specific type of message, such as 'Weekly Product Update'.

[Versions]({{ root_url }}/API_Reference/Web_API_v3/Template_Engine/versions.html): Templates may have multiple versions with different content, these may be changed and activated through the API. These allow split testing, multiple languages of the same template, etc.

[Sending Transactional Templates]({{ root_url }}/API_Reference/Web_API_v3/Template_Engine/smtpapi.html): The [SMTP API]({{ root_url }}/API_Reference/SMTP_API/index.html) is used to send templated email through SendGrid. The Web API with the [x-smtpapi parameter]({{ root_url }}/API_Reference/Web_API/mail.html#-send) can also be used.
[Sending Transactional Templates]({{ root_url }}/API_Reference/Web_API_v3/Template_Engine/smtpapi.html): The [SMTP API]({{ root_url }}/API_Reference/SMTP_API/index.html) is used to send templated email through SendGrid. The Web API with the [x-smtpapi parameter]({{ root_url }}/API_Reference/Web_API/mail.html#-send) can also be used.
6 changes: 3 additions & 3 deletions source/API_Reference/Web_API_v3/Template_Engine/smtpapi.md
Expand Up @@ -10,8 +10,8 @@ navigation:
Enabling a Template
{% endanchor %}

To use a Template Engine template when you send, enable the `templates`
filter and set the `template_id` to one of your Template Engine templates.
To use a transactional template when you send, enable the `templates`
filter and set the `template_id` to one of your transactional templates.

Example
{% codeblock lang:json %}
Expand Down Expand Up @@ -43,7 +43,7 @@ UI.
Body and Subject Tags
{% endanchor %}

Enabling a Template Engine template means that the `subject` and `body`
Enabling a transactional template means that the `subject` and `body`
content of your message will behave differently.

If you want only the message's content to be displayed, populate only the token in the template's field.
Expand Down
4 changes: 2 additions & 2 deletions source/API_Reference/Web_API_v3/Template_Engine/templates.md
Expand Up @@ -7,14 +7,14 @@ navigation:
show: true
---

The Template Engine API lets you programmatically create and manage templates for your transactional email.
The transactional templates API lets you programmatically create and manage templates for your transactional email.

{% info %}
Each user can have up to 300 templates.
{% endinfo %}

{% info %}
Templates created in Template Engine are account and subuser specific. Templates created on a parent account will not be accessible from the subuser accounts.
Transactional templates are account and subuser specific. Templates created on a parent account will not be accessible from the subuser accounts.
{% endinfo %}

* * * * *
Expand Down
2 changes: 1 addition & 1 deletion source/User_Guide/Settings/mail.md
Expand Up @@ -139,7 +139,7 @@ Legacy Email Template
{% endanchor %}

{% warning %}
This setting is for our original Email Templates, today we have a more full featured [Template Engine]({{root_url}}/User_Guide/Templates/index.html), which supports multiple templates, versioning and more.
This setting is for our original Email Templates, today we have a more full featured [Transactional Template Engine]({{root_url}}/User_Guide/Templates/index.html), which supports multiple transactional templates, versioning and more.
{% endwarning %}

This setting wraps an HTML template around your email content. This can be useful for sending out marketing email and/or other HTML formatted messages. Use the embedded, full-featured HTML editor to create a template that your emails will be wrapped in. Be sure to include a tag to place the content of your email.
Expand Down
10 changes: 4 additions & 6 deletions source/User_Guide/Templates/create_edit.md
Expand Up @@ -19,14 +19,14 @@ There is currently a limit of 300 templates and 300 versions that may be created
{% endinfo %}

{% info %}
Templates created in Template Engine are account and subuser specific. Templates created on a parent account will not be accessible from the subuser accounts.
Transactional templates are account and subuser specific. Templates created on a parent account will not be accessible from the subuser accounts.
{% endinfo %}

{% anchor h2 %}
Create a Template
{% endanchor %}

When you first visit the Template Engine, you will be asked to create your first template.
When you first visit the transactional templates page, you will be asked to create your first template.

<a href="{{site.app_url}}/templates/new">![](/images/template_engine_17.png "Add a Template")</a>

Expand Down Expand Up @@ -62,7 +62,7 @@ As soon as you add <%body%> back into the content, the warning will go away.

![](/images/template_engine_15.png "The Code Editor for Template Engine")

When you’re done editing, just hit the save button to keep all your changes. If you have not manually entered your content into the plain text editor, then you will get a notification from Template Engine offering to pull this content from your HTML code. Please double check that the content is formatted the way you want it before you send an email using this template.
When you’re done editing, just hit the save button to keep all your changes. If you have not manually entered your content into the plain text editor, then you will get a notification offering to pull this content from your HTML code. Please double check that the content is formatted the way you want before you send an email using this template.

To get the to the plain text editor, find the text icon in the editor header bar.

Expand Down Expand Up @@ -94,7 +94,7 @@ Duplicate a Template

![](/images/template_engine_13.png "Duplicate your template")

When you’re ready to create a new version of your template, you can select the “Duplicate” option from the gear icon menu near the save button. Template Engine will clone this version, giving it a name that includes the original version name, the word “clone,” and today’s date. This duplicate version will not be active until you activate it.
When you’re ready to create a new version of your template, you can select the “Duplicate” option from the gear icon menu near the save button. The Transactional Template Engine will clone this version, giving it a name that includes the original version name, the word “clone,” and today’s date. This duplicate version will not be active until you activate it.

{% anchor h2 %}
Unsubscribe Substitution Tags
Expand All @@ -119,5 +119,3 @@ Manage Email Preferences
{% endanchor %}

When you add the ```<%asm_preferences_url%>``` tag to your email, we will replace that tag with the text "Manage Email Preferences," wherever the tag is found in your email. This will allow your recipients to see your Unsubscribe Groups in a [Subscription Preference page]({{root_url}}/User_Guide/Suppressions/recipient_subscription_preferences.html) and then choose which groups they are interested in.


16 changes: 8 additions & 8 deletions source/User_Guide/Templates/index.html
@@ -1,7 +1,7 @@
---
title: Template Engine Overview
title: Transactional Templates Overview
seo:
title: Template Engine Overview
title: Transactional Templates Overview
weight: 100
layout: page
navigation:
Expand All @@ -11,9 +11,9 @@
<iframe src="https://player.vimeo.com/video/130480159" width="500" height="312" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>

<p>
The SendGrid <a href="{{site.app_url}}/templates">Template Engine</a> gives you unmatched simplicity, flexibility, and
SendGrid's <a href="{{site.app_url}}/templates">transactional templates</a> give you unmatched simplicity, flexibility, and
control in the management of your email content and design. Get your templates out of your app and instead let your app
leverage our Template Engine! Template Engine enables seamless collaboration between marketers, developers, and designers,
leverage our transactional templates! Transactional templates enable seamless collaboration between marketers, developers, and designers,
allowing each to work within SendGrid's user interface to edit and create email templates for transactional emails.
</p>

Expand All @@ -22,7 +22,7 @@
{% endinfo %}

<p>
Templates created in Template Engine are account and subuser specific. Templates created on a parent account will not be accessible from the subuser accounts.
Transactional templates are account and subuser specific. Templates created on a parent account will not be accessible from the subuser accounts.
</p>

<div class="row">
Expand All @@ -31,7 +31,7 @@ <h3>
<a href="{{root_url}}/User_Guide/Templates/create_edit.html">Create and Edit Your Templates</a>
</h3>

Templates and versions work together to allow you to easily and quickly iterate. Each version can have its own unique name, content, and subject. Template Engine allows you to insert and edit HTML and inline CSS visually or with a code editor, and supports plain-text content as well.
Templates and versions work together to allow you to easily and quickly iterate. Each version can have its own unique name, content, and subject. You may insert and edit HTML and inline CSS in your transactional templates visually or with a code editor. Plain-text content is supported as well.

</div>
<div class="col-md-6">
Expand Down Expand Up @@ -63,7 +63,7 @@ <h3>
</h3>

Talk to your development team about integrating your new template(s) with your application. They can read more about
how to integrate templates by checking out our <a href="{{root_url}}/API_Reference/Web_API_v3/Template_Engine/index.html">Template Engine Web API Reference docs</a>
how to integrate templates by checking out our <a href="{{root_url}}/API_Reference/Web_API_v3/Template_Engine/index.html">Transactional Templates Web API Reference docs</a>
and our <a href="{{root_url}}/API_Reference/SMTP_API/apps.html#templates">SMTP API docs</a>.
</div>
<div class="col-md-6">
Expand All @@ -79,6 +79,6 @@ <h3>
Start Now!
{% endanchor %}

Start using our Template Engine now by creating your first Template!
Start using our Transactional Templates now by creating your first Template!
<a href="{{site.app_url}}/templates/new"><img src="{{root_url}}/images/template_engine_6.png" class="img-responsive center-block"/></a>
</div>

0 comments on commit 618a485

Please sign in to comment.