From 618a48539e8f2ba145d94ca29df437ba1474575c Mon Sep 17 00:00:00 2001 From: Eric Schallock Date: Wed, 9 Dec 2015 13:55:14 -0700 Subject: [PATCH] changed refernces to Template Engine to Transactional Template Engine or simply transactional templates --- source/API_Reference/SMTP_API/apps.html | 6 +-- .../API_Reference/Web_API/filter_settings.md | 50 +++++++++---------- .../Web_API_v3/Template_Engine/index.md | 4 +- .../Web_API_v3/Template_Engine/smtpapi.md | 6 +-- .../Web_API_v3/Template_Engine/templates.md | 4 +- source/User_Guide/Settings/mail.md | 2 +- source/User_Guide/Templates/create_edit.md | 10 ++-- source/User_Guide/Templates/index.html | 16 +++--- 8 files changed, 48 insertions(+), 50 deletions(-) diff --git a/source/API_Reference/SMTP_API/apps.html b/source/API_Reference/SMTP_API/apps.html index 2a8c48b9f2..149d7bb4a9 100644 --- a/source/API_Reference/SMTP_API/apps.html +++ b/source/API_Reference/SMTP_API/apps.html @@ -523,11 +523,11 @@

Example X-SMTPAPI Header Value

{% endanchor %} {% info %} -This setting is our Template Engine, that supports multiple templates, versioning and more. Previously, we had a Template App, now called the Legacy Template App. +This setting is our Transactional Template Engine, that supports multiple templates, versioning and more. Previously, we had a Template App, now called the Legacy Template App. {% endinfo %} -

Uses a template created with the Template Engine when sending an email. More information on usage of the Template Engine with the SMTP API may be found in the Template Engine API Reference. +

Uses a template created with the Transactional Template Engine when sending an email. More information on using transactional templates with the SMTP API may be found in the Transactional Templates API Reference. @@ -570,7 +570,7 @@

Example X-SMTPAPI Header Value

{% endanchor %} {% warning %} -This setting is our original Email Template app, today we have a more full featured Template Engine, which supports multiple templates, versioning and more. +This setting is our original Email Template app, today we have a more full featured Transactional Template Engine, which supports multiple templates, versioning and more. {% endwarning %} diff --git a/source/API_Reference/Web_API/filter_settings.md b/source/API_Reference/Web_API/filter_settings.md index 66af9420a7..b6a9868e8d 100644 --- a/source/API_Reference/Web_API/filter_settings.md +++ b/source/API_Reference/Web_API/filter_settings.md @@ -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 %} @@ -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 %} @@ -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 %} @@ -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' %} @@ -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.' '\\\\\
\<% body %\>\\\' %} {% endparameters %} @@ -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 %} @@ -209,7 +209,7 @@ All fields except version are required for each call. * * * * * {% anchor h2 %} -Footer +Footer {% endanchor %} *Name - `footer`* @@ -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`* @@ -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`* @@ -304,7 +304,7 @@ SPAM Filter Checker * * * * * {% anchor h2 %} -Subscription Tracking +Subscription Tracking {% endanchor %} *Name - `subscriptiontrack`* @@ -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`* @@ -366,7 +366,7 @@ SendGrid for New Relic * * * * * {% anchor h2 %} -Sendwithus +Sendwithus {% endanchor %} *Name - `sendwithus`* diff --git a/source/API_Reference/Web_API_v3/Template_Engine/index.md b/source/API_Reference/Web_API_v3/Template_Engine/index.md index 7c57855b76..bf1f1009b1 100644 --- a/source/API_Reference/Web_API_v3/Template_Engine/index.md +++ b/source/API_Reference/Web_API_v3/Template_Engine/index.md @@ -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. \ No newline at end of file +[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. diff --git a/source/API_Reference/Web_API_v3/Template_Engine/smtpapi.md b/source/API_Reference/Web_API_v3/Template_Engine/smtpapi.md index fb68012d4d..4559a2eb8d 100644 --- a/source/API_Reference/Web_API_v3/Template_Engine/smtpapi.md +++ b/source/API_Reference/Web_API_v3/Template_Engine/smtpapi.md @@ -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 %} @@ -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. diff --git a/source/API_Reference/Web_API_v3/Template_Engine/templates.md b/source/API_Reference/Web_API_v3/Template_Engine/templates.md index 43b52d202e..3f658255b4 100644 --- a/source/API_Reference/Web_API_v3/Template_Engine/templates.md +++ b/source/API_Reference/Web_API_v3/Template_Engine/templates.md @@ -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 %} * * * * * diff --git a/source/User_Guide/Settings/mail.md b/source/User_Guide/Settings/mail.md index f033f89b50..5684c53b4b 100644 --- a/source/User_Guide/Settings/mail.md +++ b/source/User_Guide/Settings/mail.md @@ -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. diff --git a/source/User_Guide/Templates/create_edit.md b/source/User_Guide/Templates/create_edit.md index d1e327d785..47d99e1bf9 100644 --- a/source/User_Guide/Templates/create_edit.md +++ b/source/User_Guide/Templates/create_edit.md @@ -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. ![](/images/template_engine_17.png "Add a Template") @@ -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. @@ -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 @@ -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. - - diff --git a/source/User_Guide/Templates/index.html b/source/User_Guide/Templates/index.html index 52af774957..3a54cc57e3 100644 --- a/source/User_Guide/Templates/index.html +++ b/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: @@ -11,9 +11,9 @@

-The SendGrid Template Engine gives you unmatched simplicity, flexibility, and +SendGrid's transactional templates 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.

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

-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.

@@ -31,7 +31,7 @@

Create and Edit Your Templates

- 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.
@@ -63,7 +63,7 @@

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 Template Engine Web API Reference docs + how to integrate templates by checking out our Transactional Templates Web API Reference docs and our SMTP API docs.
@@ -79,6 +79,6 @@

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!