Merge pull request #987 from sendgrid/develop

Apps settings and whitelabel content ☁️

Author: Matt Bernier

source/API_Reference/Web_API/filter_settings.md

@@ -26,7 +26,7 @@ When using this call, you must define all emails & domains here. Using this call
 {% parameters addresswhitelist %} 
 
   {% parameter name yes 'addresswhitelist' 'The name of the app for which to apply settings.' %}  
-  {% parameter list no 'A list of email addresses or domains.' 'list[]=[email protected]&list[]=[email protected]' %}
+  {% parameter list yes 'A list of email addresses or domains.' 'list[]=[email protected]&list[]=[email protected]' %}
 {% endparameters %}
 
 {% apiexample addresswhitelist POST https://api.sendgrid.com/api/filter.setup api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=addresswhitelist&list[]=[email protected]&list[]=[email protected] %}
@@ -243,6 +243,7 @@ Footer
 
 *API App Name - `footer`*
 
+You must provide either text/html or text/plain, or both, to avoid receiving a "missing parameters" error.
 
 {% parameters footer %}
  {% parameter 'name' 'Yes' 'footer' 'The app for which to set or retrieve settings.' %}
@@ -273,6 +274,7 @@ Google Analytics
 
 *API App Name - `ganalytics`*
 
+At least one of the optional parameters needs to be passed to avoid a "missing parameters" error.
 
 {% parameters ganalytics %}
  {% parameter 'name' 'Yes' 'ganalytics' 'The app for which to set or retrieve settings.' %}
@@ -300,22 +302,6 @@ Google Analytics
 
 * * * * *
 
-{% anchor h2 %}
-Gravatar 
-{% endanchor %}
-
-*API App Name - `gravatar`*
-
-* * * * *
-
-{% anchor h2 %}
-Open Tracking 
-{% endanchor %}
-
-*API App Name - `opentrack`*
-
-* * * * *
-
 {% anchor h2 %}
 SPAM Filter Checker 
 {% endanchor %}
@@ -325,12 +311,12 @@ SPAM Filter Checker
 
 {% parameters spamcheck %}
  {% parameter 'name' 'Yes' 'spamcheck' 'The app for which to set or retrieve settings.' %}
- {% parameter 'maxscore' 'Yes' 'Emails with a spam score over this value will be considered spam and will not be delivered to the recipient. The default spam threshold is 5.0, but you can set this to any value you wish. We use SpamAssassin to process the spam checks for this filter, so you can base your maxscore setting on values typically used with SpamAssassin' '1.2' %}
+ {% parameter 'max_score' 'Yes' 'Emails with a spam score over this value will be considered spam and will not be delivered to the recipient. The default spam threshold is 5.0, but you can set this to any value you wish. We use SpamAssassin to process the spam checks for this filter, so you can base your maxscore setting on values typically used with SpamAssassin' '1.2' %}
  {% parameter 'url' 'Yes' 'URL to post the email and a copy of the detailed SpamAssassin report describing why the email was designated as spam' 'https://www.example.com/spamcheck.php' %}
 {% endparameters %}
 
 
-{% apiexample spamcheck POST https://api.sendgrid.com/api/filter.setup api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=eventnotify&maxscore=1.2&url=https://www.example.com/spamcheck.php %}
+{% apiexample spamcheck POST https://api.sendgrid.com/api/filter.setup api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=eventnotify&max_score=1.2&url=https://www.example.com/spamcheck.php %}
   {% response json %}
 {
   "message": "success"
@@ -352,6 +338,7 @@ Subscription Tracking
 
 *API App Name - `subscriptiontrack`*
 
+You must pass at least one of the optional params in order to avoid the "missing parameter" error.
 
 {% parameters subscriptiontrack %}
  {% parameter 'name' 'Yes' 'subscriptiontrack' 'The app for which to set or retrieve settings.' %}
@@ -388,8 +375,8 @@ SendGrid for New Relic
 
 {% parameters newrelic %}
  {% parameter 'name' 'Yes' 'newrelic' 'The app for which to set or retrieve settings.' %}
- {% parameter 'license_key' 'YES' 'Can be found in New Relic Settings page' %}
- {% parameter 'enable_subusers' 'YES' 'false to disable, true to enable' %}
+ {% parameter 'license_key' 'Yes' 'Can be found in New Relic Settings page' %}
+ {% parameter 'enable_subusers' 'Yes' 'false to disable, true to enable' %}
 {% endparameters %}
 
 
@@ -416,7 +403,7 @@ Sendwithus
 
 {% parameters sendwithus %}
  {% parameter 'name' 'Yes' 'sendwithus' 'The app for which to set or retrieve settings.' %}
- {% parameter 'license_key' 'YES' 'Can be found in Sendwithus Settings page' %}
+ {% parameter 'license_key' 'Yes' 'Can be found in Sendwithus Settings page' %}
 {% endparameters %}
 
 

source/Glossary/7_bit_encoding.md

@@ -0,0 +1,22 @@
+---
+seo:
+  title: ASCII Encoding
+  description: 7 bit encoding is the same as ASCII encoding, which is used for storing letters in binary.
+  keywords:
+title: 7 Bit Encoding
+weight: 0
+layout: page
+navigation:
+  show: true
+---
+
+7 bit encoding is a reference to the ASCII character set, which is a set of 128 English alphabet characters and is used to store letters in binary. The set includes
+all the English lowercase letters, uppercase letters, and numbers from 0 to 9.
+
+The reason for the characters to be encoded to 7-bits, is because early computers handled data in bytes, or 8 bits. The extra bit was originally reserved for error checking.
+
+In this encoding we get 7 digit representations in 0s and 1s for each of the English letters we are trying to transmit.
+
+SendGrid requires 7 bit encoding in our [SMTPAPI categories header]({{root_url}}/API_Reference/SMTP_API/categories.html).
+
+For more information, visit Wikipedia for the entire [history of ASCII](http://en.wikipedia.org/wiki/ASCII).

source/Glossary/index.html

@@ -15,6 +15,12 @@
 We have organized these alphabetically, but you can also check out our <a href="{{root_url}}/Glossary/subjects.html">subject list of Email Terms</a>.
 
 <div class="row">
+    <div class="col-md-4">
+        {% anchor h2 %}#{% endanchor %}
+        <ul>
+            <li><a href="{{root_url}}/Glossary/7_bit_encoding.html">7 bit (ASCII) Encoding</a></a></li>
+        </ul>
+    </div>
     <div class="col-md-4">
         {% anchor h2 %}A{% endanchor %}
         <ul>
@@ -33,6 +39,8 @@
             <li><a href="{{root_url}}/Glossary/bulk_sender_notification.html">Bulk Sender Notification</a></li>
         </ul>
     </div>
+</div>
+<div class="row">
     <div class="col-md-4">
         {% anchor h2 %}C{% endanchor %}
         <ul>
@@ -42,14 +50,13 @@
             <li><a href="{{root_url}}/Glossary/complaint.html">Complaint</a></li>
         </ul>
     </div>
-</div>
-<div class="row">
     <div class="col-md-4">
         {% anchor h2 %}D{% endanchor %}
         <ul>
             <li><a href="{{root_url}}/Glossary/deliveries.html">Deliveries</a></li>
             <li><a href="{{root_url}}/Glossary/dkim.html">DKIM</a></li>
             <li><a href="{{root_url}}/Glossary/dmarc.html">DMARC</a></li>
+            <li><a href="{{root_url}}/Glossary/dns.html">DNS</a></li>
             <li><a href="{{root_url}}/Glossary/domain.html">Domain</a></li>
         </ul>
     </div>
@@ -65,14 +72,14 @@
             <li><a href="{{root_url}}/Glossary/event_webhook.html">Event Webhook</a></li>
         </ul>
     </div>
+</div>
+<div class="row">
     <div class="col-md-4">
         {% anchor h2 %}F{% endanchor %}
         <ul>
             <li><a href="{{root_url}}/Glossary/feedback_loop.html">Feedback Loop</a></li>
         </ul>
     </div>
-</div>
-<div class="row">
     <div class="col-md-4">
         {% anchor h2 %}H{% endanchor %}
         <ul>
@@ -88,6 +95,8 @@
             <li><a href="{{root_url}}/Glossary/ip_whitelabeling.html">IP Whitelabeling</a></li>
         </ul>
     </div>
+</div>
+<div class="row">
     <div class="col-md-4">
         {% anchor h2 %}M{% endanchor %}
         <ul>
@@ -96,8 +105,6 @@
             <li><a href="{{root_url}}/Glossary/mx_record.html">MX Record</a></li>
         </ul>
     </div>
-</div>
-<div class="row">
     <div class="col-md-4">
         {% anchor h2 %}O{% endanchor %}
         <ul>
@@ -109,21 +116,23 @@
     <div class="col-md-4">
         {% anchor h2 %}P{% endanchor %}
         <ul>
+            <li><a href="{{root_url}}/Glossary/Email_Types/peer_invitations.html">Peer Initiated Invitation Campaign</a></li>
             <li><a href="{{root_url}}/Glossary/phishing.html">Phishing</a></li>
             <li><a href="{{root_url}}/Glossary/provisioning.html">Provisioning</a></li>
         </ul>
     </div>
+</div>
+<div class="row">
     <div class="col-md-4">
         {% anchor h2 %}R{% endanchor %}
         <ul>
+            <li><a href="{{root_url}}/Glossary/Email_Types/reconfirmation.html">Reconfirmation Campaign</a></li>
             <li><a href="{{root_url}}/Glossary/reputation_monitoring.html">Reputation Monitoring</a></li>
             <li><a href="{{root_url}}/Glossary/request.html">Request</a></li>
             <li><a href="{{root_url}}/Glossary/reseller_email_account.html">Reseller Email Account</a></li>
             <li><a href="{{root_url}}/Glossary/reverse_dns.html">Reverse DNS</a></li>
         </ul>
     </div>
-</div>
-<div class="row">
     <div class="col-md-4">
         {% anchor h2 %}S{% endanchor %}
         <ul>
@@ -153,7 +162,9 @@
             <li><a href="{{root_url}}/Glossary/two_factor_authentication.html">Two Factor Authentication</a></li>
         </ul>
     </div>
-    <div class="col-md-4">
+</div>
+<div class="row">
+   <div class="col-md-4">
         {% anchor h2 %}W{% endanchor %}
         <ul>
             <li><a href="{{root_url}}/Glossary/web_api.html">Web API</a></li>

source/Glossary/subjects.md

@@ -22,6 +22,7 @@ We have organized these by subject, but you can also look at our [alphabetical l
             <li><a href="{{root_url}}/Glossary/dkim.html">DKIM</a></li>
             <li><a href="{{root_url}}/Glossary/dmarc.html">DMARC</a></li>
             <li><a href="{{root_url}}/Glossary/domain.html">Domain</a></li>
+            <li><a href="{{root_url}}/Glossary/dns.html">DNS</a></li>
             <li><a href="{{root_url}}/Glossary/imap.html">IMAP</a></li>
             <li><a href="{{root_url}}/Glossary/ip_address.html">IP Address</a></li>
             <li><a href="{{root_url}}/Glossary/ip_warmup.html">IP Warmup</a></li>
@@ -52,6 +53,8 @@ We have organized these by subject, but you can also look at our [alphabetical l
         {% anchor h2 %}Email{% endanchor %}
         <ul>
             <li><a href="{{root_url}}/Glossary/header.html">Header</a></li>
+            <li><a href="{{root_url}}/Glossary/Email_Types/peer_invitations.html">Peer Initiated Invitation Campaign</a></li>
+            <li><a href="{{root_url}}/Glossary/Email_Types/reconfirmation.html">Reconfirmation Campaign</a></li>
         </ul>
     </div>
 </div>
@@ -97,13 +100,18 @@ We have organized these by subject, but you can also look at our [alphabetical l
             <li><a href="{{root_url}}/Glossary/smtp_server.html">SMTP Server</a></li>
             <li><a href="{{root_url}}/Glossary/smtp_service.html">SMTP Service</a></li>
             <li><a href="{{root_url}}/Glossary/subscriber_list_management.html">Subscriber List Management</a></li>
+            <li><a href="{{root_url}}/Glossary/tls.html">Transport Layer Security</a></li>
             <li><a href="{{root_url}}/Glossary/transactional_email.html">Transactional Email</a></li>
             <li><a href="{{root_url}}/Glossary/transactional_email_templates.html">Transactional Email Templates</a></li>
             <li><a href="{{root_url}}/Glossary/two_factor_authentication.html">Two Factor Authentication</a></li>
             <li><a href="{{root_url}}/Glossary/web_api.html">Web API</a></li>
         </ul>
     </div>
     <div class="col-md-4">
-
+        {% anchor h2 %}Other{% endanchor %}
+        <ul>
+          <li><a href="{{root_url}}/Glossary/7_bit_encoding.html">7 bit (ASCII) Encoding</a></li>
+        </ul>
+    
     </div>
-</div>
+</div>

source/User_Guide/Setting_Up_Your_Server/Whitelabeling/index.html

@@ -0,0 +1,38 @@
+---
+layout: page
+weight: 0
+title: Whitelabel Overview
+seo:
+  title: Whitelabel Overview
+  description: Whitelabeling your email server is important for email deliverability.
+navigation:
+  show: true
+---
+
+Whitelabeling your IP addresses to your domain is very important to making sure your email is received as legitimate mail. If you don't whitelabel, receiving servers
+may reject your emails because they don't know where the mail originated. <a href="{{root_url}}/Glossary/spf.html">SPF</a> and <a href="{{root_url}}/Glossary/dkim.html">DKIM</a> are both DNS entry standards for proper whitelabeling of IP addresses.
+
+<h3><a href="{{root_url}}/User_Guide/Setting_Up_Your_Server/Whitelabeling/dns_setup.html">Whitelabel DNS Setup</a></h3>
+Set up DNS at your host for Whitelabeling your IPs
+
+<h3><a href="{{root_url}}/User_Guide/Setting_Up_Your_Server/Whitelabeling/spf.html">SPF Records</a></h3>
+How to set up your SPF records, so that recipient mail servers can verify where the mail they received came from.
+
+<h3><a href="{{root_url}}/User_Guide/Setting_Up_Your_Server/Whitelabeling/whitelabel_wizard.html">Whitelabel Wizard</a></h3>
+All about SendGrid's whitelabel step by step tool
+
+Related Links:
+<ul>
+    <li><a href="https://sendgrid.zendesk.com/hc/en-us/articles/200181928">Creating & Whitelabeling A Subuser To A New Sending Domain</a></li>
+    <li><a href="https://sendgrid.zendesk.com/hc/en-us/articles/200181458">DKIM Settings for Whitelabel (Silver+)</a></li>
+    <li><a href="https://sendgrid.zendesk.com/hc/en-us/articles/200182958">Everything about DMARC</a></li>
+    <li><a href="https://sendgrid.zendesk.com/hc/en-us/articles/202395168">Segment Your Email Traffic with Subusers</a></li>
+    <li><a href="https://sendgrid.zendesk.com/hc/en-us/articles/200181978">What is my sending/originating IP address with Sendgrid?</a></li>
+</ul>
+
+
+
+
+
+
+

source/User_Guide/Setting_Up_Your_Server/Whitelabeling/spf.md

@@ -84,3 +84,10 @@ If you choose to use this functionality, we suggest that you test it extensively
 SPF Wizard
 {% endanchor %}
 [The SPF Wizard](http://www.spfwizard.net/) is a browser based SPF record generation tool. Fill out the form and the site generates an SPF record for you.
+
+
+Related Links:
+
+* <a href="https://sendgrid.zendesk.com/hc/en-us/articles/202517236">SPF Records Explained</a>
+* <a href="https://sendgrid.zendesk.com/hc/en-us/articles/200185168">SPF: Don't Exceed Ten DNS Lookups!</a>
+* <a href="https://sendgrid.zendesk.com/hc/en-us/articles/200181678">Internet Standards (SPF and DKIM) and Deliverability</a>