---

layout: page

weight: 0

title: Apps (Filters)

navigation:

show: true

---

<p>Following are the apps that can be specified in the filters section of the X-SMTPAPI header. All filters and setting names must be lowercase.</p>

<p>Please note that if a filter is not specified as being either disabled or enabled in the X-SMTPAPI header, it will default to the state of the app in the "Apps" tab on the website.</p>

{% warning %}

If you're enabling an App, also called a filter, via SMTPAPI, you are required to define all the parameters for the App. If you have the App disabled on the web interface, our system will not pull the settings for the disabled app when you dynamically enable it. For instance, if you have a footer designed but disabled, you can't just enable it via the API; you need to define the footer in the API call itself.

{% endwarning %}

<p>For more information on the utility of these apps, please check out

the <a href="{{root_url}}/Apps/">Apps</a> section.</p>

{% info %}

Some Apps are not listed here, because they cannot be defined on a per-message basis. To update these other Apps, please refer to the

<a href="{{root_url}}/API_Reference/Web_API/filter_settings.html">Web API Filter Settings</a> commands.

{% endinfo %}

{% anchor h3 bcc %}

Filter: <code>bcc</code>

{% endanchor %}

<p>Sends a BCC copy of the email created in this transaction to the address specified.</p>

<table class="table table-striped table-bordered">

<th>Parameter Name</th>

<th>Parameter Value</th>

<th>Parameter Description</th>

<td>enable</td>

<td><code>0</code> | <code>1</code></td>

<td>Disable or enable this App</td>

<td>email</td>

<td><code>email</code></td>

<td>email address destination for the bcc message</td>

{% codeblock lang:json %}

{

"filters" : {

"bcc" : {

"settings" : {

"enable" : 1,

"email" : "[email protected]"

}

}

}

}

{% endcodeblock %}

{% anchor h3 bypass_list_management %}

Filter: <code>bypass_list_management</code>

{% endanchor %}

<p>Some emails are too important to do normal list management checks, such as password resets or critical alerts. Enabling this filter will bypass the normal unsubscribe / bounce / spam report checks and queue the e-mail for delivery.</p>

<table class="table table-striped table-bordered">

<th>Parameter Name</th>

<th>Parameter Value</th>

<th>Parameter Description</th>

<td>enable</td>

<td><code>0</code> | <code>1</code></td>

<td>Disable or enable this App</td>

{% codeblock lang:json %}

{

"filters" : {

"bypass_list_management" : {

"settings" : {

"enable" : 1

}

}

}

}

{% endcodeblock %}

<hr />

{% anchor h3 clicktrack %}

Filter: <code>clicktrack</code>

{% endanchor %}

<p>Rewrites links in e-mail text and html bodies to go through our webservers, allowing for tracking when a link is clicked on.</p>

<table class="table table-striped table-bordered">

<th>Parameter Name</th>

<th>Parameter Value</th>

<th>Parameter Description</th>

<td>enable</td>

<td><code>0</code> | <code>1</code></td>

<td>Disable or enable this App</td>

<h4>Example X-SMTPAPI Header Value</h4>

{% codeblock lang:json %}

{

"filters" : {

"clicktrack" : {

"settings" : {

"enable" : 1

}

}

}

}

{% endcodeblock %}

{% anchor h3 dkim %}

Filter: <code>dkim</code>

{% endanchor %}

<p>Allows you to specify the domain to use to sign messages with DKIM

certification. This domain should match the domain in the From address

of your e-mail. For more info, check out these <a href="{{root_url}}/Apps/dkim.html">details on DKIM.</a></p>

<table class="table table-striped table-bordered">

<th>Parameter Name</th>

<th>Parameter Value</th>

<th>Parameter Description</th>

<td>domain</td>

<td><code>domain</code></td>

<td>The domain you would like your DKIM certification signed with</td>

<td>use_from</td>

<td><code>0</code> | <code>1</code></td>

<td>If enabled, the domain in the From: header of the email will be used to sign your DKIM</td>

<h4>Example X-SMTPAPI Header Value</h4>

{% codeblock lang:json %}

{

"filters" : {

"dkim" : {

"settings" : {

"domain" : "example.com",

"use_from" : false

}

}

}

}

{% endcodeblock %}

{% anchor h3 domainkeys %}

Filter: <code>domainkeys</code>

{% endanchor %}

<p>Allows you to specify the domain to use to sign messages with Domain

Keys. This domain should match the domain in the From address of your

e-mail. For more info, check out these <a href="{{root_url}}/Apps/domain_keys.html">details on Domain Keys.</a></p>

<table class="table table-striped table-bordered">

<th>Parameter Name</th>

<th>Parameter Value</th>

<th>Parameter Description</th>

<td>enable</td>

<td><code>0</code> | <code>1</code></td>

<td>Disable or enable this App</td>

<td>domain</td>

<td><code>domain</code></td>

<td>The domain to sign messages as</td>

<td>sender</td>

<td><code>0</code> | <code>1</code></td>

<td>1 - Insert a Sender header if the domain specified does not match the From address. 0 - never insert a Sender header</td>

<h4>Example X-SMTPAPI Header Value</h4>

{% codeblock lang:json %}

{

"filters" : {

"domainkeys" : {

"settings" : {

"enable" : 1,

"domain" : "example.com",

"sender" : 1

}

}

}

}

{% endcodeblock %}

{% anchor h3 footer %}

Filter: <code>footer</code>

{% endanchor %}

<p>Inserts a footer at the bottom of the text and HTML bodies.</p>

<table class="table table-striped table-bordered">

<th>Parameter Name</th>

<th>Parameter Value</th>

<th>Parameter Description</th>

<td>enable</td>

<td><code>0</code> | <code>1</code></td>

<td>Disable or enable this App</td>

<td>text/html</td>

<td><code>string</code></td>

<td>String containing html body</td>

<td>text/plain</td>

<td><code>string</code></td>

<td>String containing text body</td>

<h4>Example X-SMTPAPI Header Value</h4>

{% codeblock lang:json %}

{

"filters" : {

"footer" : {

"settings" : {

"enable" : 1,

"text/html" : "<p>Thanks,<br />The SendGrid Team<p>",

"text/plain" : "Thanks,\n The SendGrid Team"

}

}

}

}

{% endcodeblock %}

{% anchor h3 forwardspam %}

Filter: <code>forwardspam</code>

{% endanchor %}

<p>Allows for a copy of spam reports to be forwarded to an email address.</p>

<table class="table table-striped table-bordered">

<th>Parameter Name</th>

<th>Parameter Value</th>

<th>Parameter Description</th>

<td>enable</td>

<td><code>0</code> | <code>1</code></td>

<td>Disable or enable this App</td>

<td>email</td>

<td><code>email</code></td>l</code></td>

<td>email address destination for spam report to go to</td>

{% codeblock lang:json %}

{

"filters" : {

"forwardspam" : {

"settings" : {

"enable" : 1,

"email" : "[email protected]"

}

}

}

}

{% endcodeblock %}

{% anchor h3 ganalytics %}

Filter: <code>ganalytics</code>

{% endanchor %}

<p>Re-writes links to integrate with Google Analytics.</p>

<table class="table table-striped table-bordered">

<th>Parameter Name</th>

<th>Parameter Value</th>

<th>Parameter Description</th>

<td>enable</td>

<td><code>0</code> | <code>1</code></td>

<td>Disable or enable this App</td>

<td>utm_source</td>

<td><code>string</code></td>

<td>Value for the utm_source field</td>

<td>utm_medium</td>

<td><code>string</code></td>

<td>Value for the utm_medium field</td>

<td>utm_term</td>

<td><code>string</code></td>

<td>Value for the utm_term field</td>

<td>utm_content</td>

<td><code>string</code></td>

<td>Value for the utm_content field</td>

<td>utm_campaign</td>

<td><code>string</code></td>

<td>Value for the utm_campaign field</td>

<h4>Example X-SMTPAPI Header Value</h4>

{% codeblock lang:json %}

{

"filters" : {

"ganalytics" : {

"settings" : {

"enable" : 1,

"utm_source" : "Transactional Email",

"utm_medium" : "email",

"utm_content" : "Reset Your Password",

"utm_campaign" : "Redesigned Transactional Messaging"

}

}

}

}

{% endcodeblock %}

{% anchor h3 gravatar %}

Filter: <code>gravatar</code>

{% endanchor %}

<p>Inserts an img tag at the bottom of the html section of an e-mail to display the gravatar associated with the mail sender.</p>

<table class="table table-striped table-bordered">

<th>Parameter Name</th>

<th>Parameter Value</th>

<th>Parameter Description</th>

<td>enable</td>

<td><code>0</code> | <code>1</code></td>

<td>Disable or enable this App</td>

<h4>Example X-SMTPAPI Header Value</h4>

{% codeblock lang:json %}

{

"filters" : {

"gravatar" : {

"settings" : {

"enable" : 1

}

}

}

}

{% endcodeblock %}

{% anchor h3 opentrack %}

Filter: <code>opentrack</code>

{% endanchor %}

<p>Inserts an <code>&lt;img&gt;</code> tag at the bottom of the html section of an e-mail which will be used to track if an e-mail is opened.</p>

<table class="table table-striped table-bordered">

<th>Parameter Name</th>

<th>Parameter Value</th>

<th>Parameter Description</th>

<td>enable</td>

<td><code>0</code> | <code>1</code></td>

<td>Disable or enable this App</td>

<h4>Example X-SMTPAPI Header Value</h4>

{% codeblock lang:json %}

{

"filters" : {

"opentrack" : {

"settings" : {

"enable" : 1

}

}

}

}

{% endcodeblock %}

{% anchor h3 spamcheck %}

Filter: <code>spamcheck</code>

{% endanchor %}

<p>Tests message with <a href="http://spamassassin.apache.org/">SpamAssassin</a> to determine if it is spam, and drop it if it is.</p>

<table class="table table-striped table-bordered">

<th>Parameter Name</th>

<th>Parameter Value</th>

<th>Parameter Description</th>

<td>enable</td>

<td><code>0</code> | <code>1</code></td>

<td>Disable or enable this App</td>

<td>maxscore</td>

<td><code>-10.0</code> to <code>10.0</code></td>

<td>Score after which the message will be dropped (default is 5.0, higher scores indicate higher likelihood of spam)</td>

<td>url</td>

<td><code>url</code></td>

<td>an optional url to POST the email and a copy of the report to</td>

<h4>Example X-SMTPAPI Header Value</h4>

{% codeblock lang:json %}

{

"filters" : {

"spamcheck" : {

"settings" : {

"enable" : 1,

"maxscore" : 3.5,

"url" : "http://example.com/compliance"

}

}

}

}

{% endcodeblock %}

{% anchor h3 subscriptiontrack %}

Filter: <code>subscriptiontrack</code>

{% endanchor %}

<p>Inserts a subscription management link at the bottom of the text and html bodies or insert the link anywhere in the email.</p>

<p>If you wish to append an unsubscription link, use the <code>text/html</code> and <code>text/plain</code> paremeters. However, if you wish to have the link replace a tag (such as <code>[unsubscribe]</code>), use the <code>replace</code> parameter.</p>

<table class="table table-striped table-bordered">

<th>Parameter Name</th>

<th>Parameter Value</th>

<th>Parameter Description</th>

<td>enable</td>

<td><code>0</code> | <code>1</code></td>

<td>Disable or enable this App</td>

<td>text/html</td>

<td><code>string</code></td>

<td>HTML to be appended to the email, with the subscription tracking link. You may control where the link is by using a tag like so: <code><% link text %></code></td>

<td>text/plain</td>

<td><code>string</code></td>

<td>Text to be appended to the email, with the subscription tracking link. You may control where the link is by using a tag like so: <code><% %></code></td>

<td>replace</td>

<td><code>string</code></td>

<td>A tag that will be replaced with the unsubscribe URL (e.g. <code>-unsubscribe_link-</code>). If this parameter is included, it will override <code>text/html</code> and <code>text/plain</code>.</td>

<h4>Example X-SMTPAPI Header Value</h4>

{% codeblock lang:json %}

{

"filters": {

"subscriptiontrack": {

"settings": {

"text/html": "If you would like to unsubscribe and stop receiving these emails <% click here %>.",

"text/plain": "If you would like to unsubscribe and stop receiving these emails click here: <% %>.",

"enable": 1

}

}

}

}

{% endcodeblock %}

{% anchor h3 templates %}

Filter: <code>templates</code>

{% endanchor %}

{% info %}

This app is our new <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>.

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

<table class="table table-striped table-bordered">

<th>Parameter Name</th>

<th>Parameter Value</th>

<th>Parameter Description</th>

<td>enable</td>

<td><code>0</code> | <code>1</code></td>

<td>Disable or enable this App</td>

<td>template_id</td>

<td><code>string</code></td>

<td>The ID of the template to use when sending a message, represented by a string.</td>

<h4>Example X-SMTPAPI Header Value</h4>

{% codeblock lang:json %}

{

"filters": {

"templates": {

"settings": {

"enable": 1,

"template_id": "5997fcf6-2b9f-484d-acd5-7e9a99f0dc1f"

}

}

}

}

{% endcodeblock %}

{% anchor h3 template %}

Filter: <code>template</code>

{% endanchor %}

{% warning %}

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

{% endwarning %}

<p>Wraps a template around your email content. Useful for sending out marketing email and other nicely formatted messages.</p>

<table class="table table-striped table-bordered">

<th>Parameter Name</th>

<th>Parameter Value</th>

<th>Parameter Description</th>

<td>enable</td>

<td><code>0</code> | <code>1</code></td>

<td>Disable or enable this App</td>

<td>text/html</td>

<td><code>string</code></td>

<td>String containing html content for the template (must contain a <code>&lt;% body %&gt;</code> tag)</td>

<h4>Example X-SMTPAPI Header Value</h4>

{% codeblock lang:json %}

{

"filters" : {

"template" : {

"settings" : {

"enable" : 1,

"text/html" : "<html><head></head><body bgcolor='pink'><div style='width:200px' bgcolor='#FFF'><% body %></div></body></html>"

}

}

}

}

{% endcodeblock %}