Skip to content

Commit 4f093bd

Browse files
committed
Merge pull request sendgrid#1848 from sendgrid/develop
5/31/2016 Docs Update
2 parents f76a60c + 7d2503f commit 4f093bd

28 files changed

+107
-87
lines changed

source/API_Reference/Web_API_v3/API_Keys/api_key_permissions_list.html

+10-12
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,10 @@ <h3><a href="#Whitelist">Whitelist</a></h3>
8686
]
8787
{% endcodeblock %}
8888

89+
{% info %}
90+
As explained in the <a href="{{root_url}}/Classroom/Basics/API/api_key_permissions.html">Classroom</a>, Billing permissions are mutually exclusive from all others. An API Key can *either* have Billing Permissions, or any other set of Permissions.
91+
{% endinfo %}
92+
8993
{% anchor h2 %}Categories{% endanchor %}
9094

9195
{% codeblock %}
@@ -99,17 +103,6 @@ <h3><a href="#Whitelist">Whitelist</a></h3>
99103
]
100104
{% endcodeblock %}
101105

102-
{% anchor h2 %}Clients{% endanchor %}
103-
{% codeblock %}
104-
"scopes": [
105-
"clients.desktop.stats.read",
106-
"clients.phone.stats.read",
107-
"clients.stats.read",
108-
"clients.tablet.stats.read",
109-
"clients.webmail.stats.read"
110-
]
111-
{% endcodeblock %}
112-
113106
{% anchor h2 %}Credentials{% endanchor %}
114107
{% codeblock %}
115108
"scopes": [
@@ -129,7 +122,12 @@ <h3><a href="#Whitelist">Whitelist</a></h3>
129122
"browsers.stats.read",
130123
"devices.stats.read",
131124
"geo.stats.read",
132-
"mailbox_providers.stats.read"
125+
"mailbox_providers.stats.read",
126+
"clients.desktop.stats.read",
127+
"clients.phone.stats.read",
128+
"clients.stats.read",
129+
"clients.tablet.stats.read",
130+
"clients.webmail.stats.read"
133131
]
134132
{% endcodeblock %}
135133

source/Classroom/Deliver/Delivery_Introduction/the_art_of_notifications.md

-8
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,12 @@ navigation:
1313

1414
Excessive notifications can become the needy partner of email. We try to keep up with them but eventually, we give up and toss them to the wolves. We have seen the frequency of spam complaints from a single recipient increasing. Recipients are having their mailboxes flooded with notifications and must resort to selecting all of their notifications then reporting them as spam. This flood of spam complaints then makes the mailbox provider think that sender is spamming and will begin to throttle, filter, or block their messages. Now the sender is having deliverability problems and the recipient wants to have nothing to do with the sender. There are solutions!
1515

16-
** **
17-
1816
1. Put the power in the hands of the people. Notifications should be for the people and controlled by the people. Let people set their preferences for frequency and notification type at account creation time. Some people may want your service, but do not want any email notifications. Others may only want certain types of notifications.
1917

20-
** **
21-
2218
2. Create a setting where recipients can choose how they would like to be notified. Every time activity happens does not warrant an email. Group notifications in one email daily, weekly or even monthly but make it clear that the recipient can choose the frequency.
2319

24-
** **
25-
2620
3. We are now in the age of smart phones. A recent study by [ReturnPath](http://www.returnpath.com/wp-content/uploads/resource/email-mostly-mobile/Return-Path-Email-Mostly-Mobile1.jpg) revealed that the majority of emails are viewed on mobile devices. This means that the space in which people are able to view their emails has decreased. Also, people are checking their email on the go with less time to scroll through their emails. The stakes have risen for each time an email is sent to a recipient. Use your recipients time wisely.
2721

28-
** **
29-
3022
4. Caution! For those of our sender’s that also use Facebook as their main platform. Notification frequency is more important than ever. Some of our senders have reported having issues getting blocked by Facebook has been cracking down on their “notification spam”. Read [this article](http://www.huffingtonpost.com/2013/03/11/facebook-apps_n_2850893.html) from Rueters for polemic advice. Facebook notifications should be treated like any other email.
3123

3224
Notifications are a great way to maintain contact and establish a relationship with your recipients. Like any relationship, communication is the key to success. Just make sure that when you do communicate, it is to the benefit of both the sender and the recipient.

source/User_Guide/Transactional_Templates/create_edit.md

+65-31
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,7 @@ navigation:
88
show: true
99
---
1010

11-
12-
Creating email templates involves a mix of content writing, HTML, and CSS expertise. Email templates should look good on
13-
different email clients and be responsive for mobile devices. Many non-technical customers will hire a front end or email
14-
template developer to build their templates. We also suggest testing your templates with rendering applications like [Litmus](http://litmus.com)
15-
before sending them to your customers.
11+
Creating email templates involves a mix of content writing, HTML, and CSS expertise. Email templates should look good on different email clients and be responsive for mobile devices. Many non-technical customers will hire a front end or email template developer to build their templates. We also suggest testing your templates with rendering applications like [Litmus](http://litmus.com) before sending them to your customers.
1612

1713
{% info %}
1814
There is currently a limit of 300 templates and 300 versions that may be created per account.
@@ -28,13 +24,21 @@ Create a Template
2824

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

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

3329
Click “Create Template” and you’ll be asked to add a Template Name.
3430

35-
![](/images/template_engine_7.png "Template Name")
31+
![](/images/template_engine_6.png "Template Name")
32+
33+
When you hit save, your new template group will be created.
34+
35+
![](/images/template_engine_7.png "Template Group")
36+
37+
You can then open the actions dropdown menu to create a new version.
38+
39+
![](/images/template_engine_8.png "Create Template Version")
3640

37-
When you hit save, you will be taken to the editor. From here, you can change the subject and the body of your email template.
41+
When you click Add Version, you will be taken to the editor. From here, you can change the subject and the body of your email template.
3842

3943
The easiest way to get started with a new template is to use one of your previous email templates or a free template from the internet, and then modify it to fit your needs.
4044

@@ -48,53 +52,83 @@ Email templates are table-based HTML with inline or header styles, because some
4852

4953
To add a template, click the “Code” button in the header. Copy and paste your HTML code into the dark-background code editor, like so:
5054

51-
![](/images/template_engine_8.png "Editing your Template")
52-
53-
{% warning %}
54-
You MUST have a <%subject%> tag in the subject and a <%body%> tag in your template.
55-
{% endwarning %}
56-
57-
If you paste in an email template, it is likely that you will overwrite the default and very basic email HTML that is provided in the code editor. When you do this, you will remove the body placeholder tag <%body%>. When you do this, the editor will show the following notification.
55+
![](/images/template_engine_9.png "Editing your Template")
5856

59-
![](/images/template_engine_4.png "required tags for templates")
57+
If you paste in an email template, it is likely that you will overwrite the default and very basic email HTML that is provided in the code editor.
6058

61-
As soon as you add <%body%> back into the content, the warning will go away.
59+
![](/images/template_engine_10.png)
6260

63-
![](/images/template_engine_15.png "The Code Editor for transactional templates")
64-
65-
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.
61+
When you’re done editing, just hit the save button to keep all your changes. Please double check that the content is formatted correctly before you send an email using this template.
6662

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

69-
![](/images/template_engine_10.png "Design/Code Switch")
65+
![](/images/template_engine_11.png "Design/Code Switch")
7066

7167
{% anchor h2 %}
72-
Send a Test
68+
Preview and Test Your Template
7369
{% endanchor %}
7470

75-
We suggest that when you’re done making changes with your template and before you activate your template, you should send a test.
71+
We suggest that when you’re done making changes to your template, you preview and test it to ensure that the format and layout look the way you expect. We recommend that you always test your template before activating it.
72+
73+
<div class="row">
74+
75+
<div class="clearfix col-md-6">
76+
When you select the “Preview” option, a sidebar window will pop out with a preview of the email that you’re going to test, with the option to view the template formatted for both mobile and desktop platforms.
77+
<br>
78+
<br>
79+
You may send a test email using your new template from this window.
80+
</div>
81+
<div class="col-md-6">
82+
<img src="{{root_url}}/images/template_engine_12.png" class="img-responsive pull-right"/>
83+
</div>
84+
<br>
85+
</div>
86+
87+
![](/images/template_engine_13.png "Preview and Test")
7688

77-
![](/images/template_engine_12.png "Send a Test Menu")
89+
If you click the Send Test button, you will be given the option of specifying the recipient, and subject line, of your test email.
7890

79-
When you select the “Send a Test” option, a sidebar window will pop out with a preview of the email that you’re going to test. The test email will be sent to the admin email on your account. Your substitution tags will not be replaced in this test, but you will be able to see the layout and format of your template email in your own email program.
91+
![](/images/template_engine_14.png "Send Test")
92+
93+
Your substitution tags will not be replaced in this test, but you will be able to confirm the layout and format of your template.
8094

8195
{% anchor h2 %}
8296
Activate Your Template
8397
{% endanchor %}
8498

85-
![](/images/template_engine_11.png "Make Your Template Active")
86-
87-
A template can only have one active version at a time. If you’ve created a new version with different HTML that you want your customers to start receiving, you’ll need to make that Version “Active.”
99+
<div class="row">
88100

89-
Select the “Make Active” option from the gear icon menu next to the save button.
101+
<div class="clearfix col-md-6">
102+
A template can only have one active version at a time. If you’ve created a new version with different HTML that you want your customers to start receiving, you’ll need to make that Version “Active.”
103+
<br>
104+
<br>
105+
Select the “Make Active” option from the gear icon menu.
106+
</div>
107+
<div class="col-md-6">
108+
<img src="{{root_url}}/images/template_make_active.png" class="img-responsive pull-right"/>
109+
</div>
110+
<br>
111+
</div>
90112

91113
{% anchor h2 %}
92114
Duplicate a Template
93115
{% endanchor %}
94116

95-
![](/images/template_engine_13.png "Duplicate your template")
117+
<div class="row">
118+
119+
<div class="col-md-6">
120+
<img src="{{root_url}}/images/templates_duplicate_version.png" class="img-responsive pull-left"/>
121+
</div>
122+
123+
<div class="clearfix col-md-6">
124+
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.
125+
<br>
126+
<br>
127+
This creates a clone, giving it a name including the original version name, the word “clone,” and today’s date. This duplicate version will not be active until you activate it.
128+
</div>
96129

97-
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. This creates a clone, giving it a name including the original version name, the word “clone,” and today’s date. This duplicate version will not be active until you activate it.
130+
<br>
131+
</div>
98132

99133
{% anchor h2 %}
100134
Unsubscribe Substitution Tags

source/User_Guide/Transactional_Templates/index.html

+12-26
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,8 @@
88
show: true
99
---
1010

11-
<iframe src="https://player.vimeo.com/video/130480159" width="500" height="312" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
12-
1311
<p>
14-
SendGrid's <a href="{{site.app_url}}/templates">transactional templates</a> give you unmatched simplicity, flexibility, and
15-
control in the management of your email content and design. Get your templates out of your app and instead let your app
16-
leverage our transactional templates! Transactional templates enable seamless collaboration between marketers, developers, and designers,
17-
allowing each to work within SendGrid's user interface to edit and create email templates for transactional emails.
12+
SendGrid’s <a href="https://app.sendgrid.com/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 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.
1813
</p>
1914

2015
{% info %}
@@ -31,30 +26,22 @@ <h3>
3126
<a href="{{root_url}}/User_Guide/Transactional_Templates/create_edit.html">Create and Edit Your Templates</a>
3227
</h3>
3328

34-
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.
35-
36-
</div>
37-
<div class="col-md-6">
38-
<img src="{{root_url}}/images/template_engine_9.png" class="img-responsive pull-left"/>
39-
</div>
40-
</div>
41-
29+
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.
4230

43-
<div class="row">
44-
<div class="clearfix col-md-6">
45-
<img src="{{root_url}}/images/template_engine_2.png" class="img-responsive"/>
4631
</div>
4732
<div class="col-md-6">
48-
<h3>
49-
<a href="{{root_url}}/User_Guide/Transactional_Templates/manage.html">Manage Your Templates</a>
50-
</h3>
51-
52-
Update, add versions, and manage your templates in an easy to use interface. Keep your most recent template versions
53-
active and work on your new versions until they’re ready.
33+
<img src="{{root_url}}/images/template_engine_1.png" class="img-responsive pull-right"/>
5434
</div>
5535
</div>
5636

37+
<h3>
38+
<a href="{{root_url}}/User_Guide/Transactional_Templates/manage.html">Manage Your Templates</a>
39+
</h3>
40+
<p>
41+
Update, add versions, and manage your templates in an easy to use interface. Keep your most recent template versions active and work on your new versions until they’re ready.
5742

43+
<img src="{{root_url}}/images/transactional_templates_2.png" />
44+
</p>
5845

5946
<div class="row">
6047
<div class="clearfix col-md-6">
@@ -67,7 +54,7 @@ <h3>
6754
and our <a href="{{root_url}}/API_Reference/SMTP_API/apps.html#templates">SMTP API docs</a>.
6855
</div>
6956
<div class="col-md-6">
70-
<img src="{{root_url}}/images/template_engine_3.png" class="img-responsive pull-left"/>
57+
<img src="{{root_url}}/images/template_engine_3.png" class="img-responsive pull-right"/>
7158
</div>
7259
</div>
7360

@@ -79,6 +66,5 @@ <h3>
7966
Start Now!
8067
{% endanchor %}
8168

82-
Start using our Transactional Templates now by creating your first Template!
83-
<a href="https://sendgrid.com/templates"><img src="{{root_url}}/images/template_engine_6.png" class="img-responsive center-block"/></a>
69+
<a href="https://sendgrid.com/templates"><img src="{{root_url}}/images/template_engine_4.png" class="img-responsive center-block"/></a>
8470
</div>

source/User_Guide/Transactional_Templates/manage.md

+20-10
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,35 @@ navigation:
88
show: true
99
---
1010

11-
Each template you create will have a grouping of versions for this template. This allows you to see where you’ve been and create new versions without using them until you make them active. Only one version can be active per template.
11+
Each template you create will have a grouping of versions for this template. This allows you to see where you’ve been and create new versions without using them until you make them active.
1212

13-
{% anchor h2 %}
14-
Changing Your Templates View
15-
{% endanchor %}
13+
Only one version can be active per template.
14+
15+
When viewing your transactional templates, you may choose to display, or hide, any inactive template versions.
1616

17-
![](/images/template_engine_18.png "Changing your template list view")
17+
![]({{root_url}}/images/transactional_templates_show_versions.png "Show inactive template versions.")
18+
19+
![]({{root_url}}/images/transactional_templates_hide_versions.png "Hide inactive template versions.")
1820

19-
As you create new templates, you may find that a list view might be more suitable to scrolling through your templates. To switch the view, find the view options next to the “Create Template” button and select the list or box view option.
2021

2122
{% anchor h2 %}
2223
Managing Templates
2324
{% endanchor %}
2425

25-
![](/images/template_engine_14.png "Managing your Templates")
26+
<div class="row">
27+
<div class="col-md-6">
28+
From the main template view on each template group, you will see an actions menu. From this menu, you can choose to edit the name of your template, add a version, preview and test, or delete the template.
29+
</div>
30+
<div class="col-md-6">
31+
<img src="{{root_url}}/images/template_engine_18.png" class="img-responsive pull-right"/>
32+
</div>
33+
<br>
34+
</div>
35+
36+
You will also see a gear icon for each template version. Clicking this presents a menu allowing you to preview and test, edit, duplicate, and delete the template version. You can also use the preview modal to send a test.
2637

27-
From the main template view on each template group, you will see a gear icon menu. From this menu, you can choose to edit
28-
the name of your template, [add a version]({{root_url}}/User_Guide/Transactional_Templates/create_edit.html), or delete the template.
38+
![]({{root_url}}/images/template_engine_19.png)
2939

3040
{% info %}
3141
To delete a template, you must first delete all the versions of your template.
32-
{% endinfo %}
42+
{% endinfo %}

source/images/template_engine_1.png

-61.6 KB
Loading

source/images/template_engine_10.png

168 KB
Loading

source/images/template_engine_11.png

-27.8 KB
Loading

source/images/template_engine_12.png

-14.3 KB
Loading

source/images/template_engine_13.png

18.9 KB
Loading

source/images/template_engine_14.png

57.2 KB
Loading

source/images/template_engine_15.png

-344 KB
Loading

source/images/template_engine_16.png

13.5 KB
Loading

source/images/template_engine_18.png

15.1 KB
Loading

source/images/template_engine_19.png

85.1 KB
Loading

source/images/template_engine_4.png

-23.2 KB
Loading

source/images/template_engine_5.png

-140 KB
Loading

source/images/template_engine_6.png

59.5 KB
Loading

source/images/template_engine_7.png

64.9 KB
Loading

source/images/template_engine_8.png

37.7 KB
Loading

source/images/template_engine_9.png

-118 KB
Loading
13.6 KB
Loading
13.5 KB
Loading

source/images/templates_edit.png

234 KB
Loading
15.3 KB
Loading
47.5 KB
Loading
Loading
Loading

0 commit comments

Comments
 (0)