Skip to content
This repository was archived by the owner on Aug 27, 2021. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
56 commits
Select commit Hold shift + click to select a range
b5c9d2c
Create Confirmed_Opt_In
leormanelis Jan 14, 2015
2da2089
Create Autoresponder
leormanelis Jan 14, 2015
d596326
Create Bayesian Filter
leormanelis Jan 14, 2015
3bbfed4
Create Drip Campaign
leormanelis Jan 19, 2015
2484256
Update mail.md
VictorAcatrinei Nov 9, 2015
36e8a35
Merge branch 'patch-29' of https://github.com/leormanelis/docs into l…
eschallock Nov 9, 2015
4c73645
Edited drip_campaign glossary entry
eschallock Nov 9, 2015
dd20084
Merge branch 'leormanelis-patch-29' into develop
eschallock Nov 9, 2015
65313cd
renamed drip_campaign to drip_campaign.md
eschallock Nov 9, 2015
638f8f5
Merge pull request #1389 from sendgrid/eschallock-patch-1
eschallock Nov 9, 2015
5c18918
Update scheduling_parameters.md
Nov 9, 2015
1c9fcee
Merge pull request #1390 from sendgrid/mbernier-patch-1
Nov 9, 2015
8224759
Merge branch 'patch-24' of https://github.com/leormanelis/docs into l…
eschallock Nov 9, 2015
8e0f791
Removes duplicated fields in Get example
Nov 9, 2015
acf0aca
Edited Autoresponder Glossary entry
eschallock Nov 9, 2015
2e391cd
Merge branch 'leormanelis-patch-24' into develop
eschallock Nov 9, 2015
94da34a
Merge branch 'develop' of https://github.com/sendgrid/docs into develop
eschallock Nov 9, 2015
51c0963
copy edits and renamed CAN-SPAM to can_spam.md
eschallock Nov 9, 2015
66d4613
Merge pull request #1392 from sendgrid/eschallock-patch-1
eschallock Nov 9, 2015
906cc46
Merge branch 'patch-25' of https://github.com/leormanelis/docs into l…
eschallock Nov 9, 2015
f258515
Copy edited and renamed Bayesian Filtering Glossary entry
eschallock Nov 9, 2015
6c96523
Merge branch 'leormanelis-patch-25' into develop
eschallock Nov 9, 2015
9fc024f
fixed bulleted list
eschallock Nov 9, 2015
e6a5de5
fixed bulleted list
eschallock Nov 9, 2015
f9d1cd3
Merge branch 'patch-22' of https://github.com/leormanelis/docs into l…
eschallock Nov 9, 2015
261fbd6
Edited Opt-In Email Glossary entry
eschallock Nov 9, 2015
dc743c6
Merge branch 'leormanelis-patch-22' into develop
eschallock Nov 9, 2015
569eded
Update doc for reseller customer management
Nov 10, 2015
53103c8
Merge branch 'develop' of github.com:sendgrid/docs into UpdateReselle…
Nov 10, 2015
cf627de
fix /Glossary/sender_reputation.html link
Nov 10, 2015
39413e4
Update to laravel docs
Nov 10, 2015
667187d
fixed broken link
eschallock Nov 10, 2015
1f4e4de
Merge pull request #1395 from sendgrid/eschallock-patch-1
eschallock Nov 10, 2015
7da9da5
Merge pull request #1388 from VictorAcatrinei/patch-2
Nov 10, 2015
191d148
Merge pull request #1391 from nandosousafr/develop
Nov 10, 2015
ec3cd6f
Merge pull request #1393 from sendgrid/UpdateResellerGetCustomerProfile
Nov 10, 2015
14b128c
Merge pull request #1394 from adulion/patch-1
eschallock Nov 10, 2015
651cb14
New video!
Nov 10, 2015
51b6e7d
Created glossary entry for Automated Email
eschallock Nov 10, 2015
25044e3
Created glossary entry for Triggered Email
eschallock Nov 10, 2015
a50512c
Created glossary entry for Triggering Events
eschallock Nov 10, 2015
34e3844
Created glossary entry for Triggered Actions
eschallock Nov 10, 2015
24abf52
Update triggered_email.md
eschallock Nov 10, 2015
7e2018d
Update automated_email.md
eschallock Nov 10, 2015
72e3e83
Update triggering_events.md
eschallock Nov 10, 2015
639c469
Merge pull request #1397 from sendgrid/eschallock-patch-1
eschallock Nov 10, 2015
849563a
Merge pull request #1398 from sendgrid/eschallock-patch-2
eschallock Nov 10, 2015
18cc79b
Merge pull request #1399 from sendgrid/eschallock-patch-4
eschallock Nov 10, 2015
31979cc
Merge pull request #1400 from sendgrid/eschallock-patch-5
eschallock Nov 10, 2015
d0b2483
Merge pull request #1396 from sendgrid/mbernier-patch-1
Nov 10, 2015
d09221a
forcing a change
Nov 10, 2015
26df002
Merge pull request #1401 from sendgrid/fix_trigger
Nov 10, 2015
6aa1f0a
Edited as per Molly's suggestions
eschallock Nov 10, 2015
dfe198c
Removed content and linked to Automated Email page
eschallock Nov 10, 2015
8eb7844
Merge pull request #1402 from sendgrid/eschallock-patch-1
eschallock Nov 10, 2015
4f500dd
Merge pull request #1403 from sendgrid/eschallock-patch-2
eschallock Nov 10, 2015
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/API_Reference/SMTP_API/scheduling_parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ performance. This functionality:
* Is available for free to all SendGrid customers.

{% info %}
Once you send SendGrid a request with a scheduling parameter, that email request cannot be cancelled and we currently only accept time stamps no greater than 72 hours in advance.
Scheduled sends can be cancelled, if you include a batch ID with your send. For more information, check out [Cancel Scheduled Sends]({{root_url}}/API_Reference/Web_API_v3/cancel_schedule_send.html)!
{% endinfo %}

{% warning %}
Expand Down
14 changes: 8 additions & 6 deletions source/API_Reference/Web_API/Reseller_API/customer_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,13 +95,16 @@ Obtain a complete list of all customers.
{% parameter 'phone' 'No' 'Search filter, phone number of customer' %}
{% parameter 'website' 'No' 'Search filter, website of customer' %}
{% parameter 'method' 'Yes' 'Must be set to *profile*' %}
{% parameter 'limit' 'No' 'Optional field to limit the number of results returned.' %}
{% parameter 'offset' 'No' 'Optional beginning point in the list to retrieve from.' %}
{% endparameters %}


{% apiexample get POST https://api.sendgrid.com/apiv2/reseller.manage api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=profile&task=get %}
{% response json %}
[
{
"id": "123",
"username": "username",
"email": "[email protected]",
"active": "true",
Expand All @@ -116,6 +119,7 @@ Obtain a complete list of all customers.
"website": "example.com"
},
{
"id": "124",
"username": "username",
"email": "[email protected]",
"active": "false",
Expand All @@ -134,14 +138,13 @@ Obtain a complete list of all customers.
{% response xml %}
<users>
<user>
<id>123</id>
<username>user1</username>
<email>[email protected]</email>
<active>true</active>
<first_name>john</first_name>
<last_name>doe</last_name>
<address>
555 any street
</address>
<address>555 any street</address>
<city>any city</city>
<state>CA</state>
<zip>91234</zip>
Expand All @@ -150,14 +153,13 @@ Obtain a complete list of all customers.
<website>example.com</website>
</user>
<user>
<id>124</id>
<username>user2</username>
<email>[email protected]</email>
<active>false</active>
<first_name>jane</first_name>
<last_name>doe</last_name>
<address>
555 any street
</address>
<address>555 any street</address>
<city>any city</city>
<state>CA</state>
<zip>91234</zip>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ HTTP/1.1 200 OK
[
{
"ip":"000.00.00.0",
"pools":["new_test5"],
"warmup":true,
"start_date":1409616000,
"subusers": ["username1", "username2"],
Expand Down
3 changes: 3 additions & 0 deletions source/Glossary/Drip Campaign
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Drip Campaign - is a communication strategy that sends, or "drips," a pre-written set of messages to customers or prospects over time. These messages often take the form of email marketing, although other media can also be used. Drip marketing is distinct from other database marketing in two ways: (1) the timing of the messages follow a pre-determined course; (2) the messages are dripped in a series applicable to a specific behavior or status of the recipient. It is also typically automated.

This feature is not yet available.
24 changes: 24 additions & 0 deletions source/Glossary/automated_email.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
layout: page
weight: 0
title: Automated Email
navigation:
show: true
seo:
title: Automated Email
override: true
description: Automated Email allows you to dynamically send relevant content to individual recipients.
keywords: triggered email, automated email, Threads, behavior-driven email
---

Automated email, also known as [triggered email]({{root_url}}/Glossary/triggered_email.html) or behavior-driven email, is sent when a specific [triggering event]({{root_url}}/Glossary/triggering_events.html) occurs or a specific user takes an action that prompts the delivery of the email. While traditional [marketing email]({{root_url}}/Glossary/Email_Types/index.html) involves sender-initiated promotional messages sent to a list of recipients, automated email is initiated by user behavior, allowing you to dynamically send targeted, real-time promotional content that is uniquely relevant to an individual recipient.

Examples of automated email include a welcome series [drip campaign]({{root_url}}/Glossary/drip_campaign.html) that is initiated by a new user sign-up or a win-back campaign to re-engage a lapsed user.

The ability to send very relevant, timely emails directed to individual recipients makes automated email a uniquely powerful tool for building and nurturing customer relationships, enhancing the image of your brand, and increasing customer engagement.

You can use SendGrid’s automated, behavior driven email platform, [Threads](http://threads.io/), to track individual users and the actions that they take when interacting with your application or website. This information can then be used to dynamically create and send automated email.

{% info %}
Visit the [Threads Support Page](https://support.threads.io/hc/en-us) to learn more about how you can integrate Threads with your SendGrid account.
{% endinfo %}
23 changes: 23 additions & 0 deletions source/Glossary/autoresponder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
seo:
title: Autoresponder
description: Autoresponders generate email responses to actions and events.
keywords: automated email
title: Autoresponder
weight: 0
layout: page
navigation:
show: true
---

An autoresponder is a computer program that generates a response to an email, request, or action. Autoresponders were initially used to notify a sender of an undeliverable email, but now they are often used in email marketing. Autoresponders can give you the ability to send a customer a pre-written email when a specified event takes place, such as a customer creating an account or purchasing a product.

- Autoresponders can be outsourced to an **Application Service Provider** that provides the infrastructure and support for the autoresponder.

- Autoresponders can also be **installed server-side**, giving you complete control while requiring you to provide the infrastructure and technical skill to maintain the autoresponder.

{% info %}
You can set up an autoresponder with SendGrid, by utilizing the [Inbound Parse Webhook]({{root_url}}/API_Reference/Webhooks/parse.html) and the [Mail Send endpoint]({{root_url}}/API_Reference/Web_API/mail.html).
{% endinfo %}

More information about autoresponders can be found [here](https://en.wikipedia.org/wiki/Autoresponder).
24 changes: 24 additions & 0 deletions source/Glossary/bayesian_filter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
seo:
title: Bayesian Filter
description: Bayesian Filtering is a technique for detecting spam.
keywords: Bayesian Filter, spam
title: Bayesian Filter
weight: 0
layout: page
navigation:
show: true
---

This is a statistical method for determining the probability that an email is spam by looking for the use of words or phrases commonly associated with spam email.

A Bayesian filter detects spam by comparing the words or phrases within the questionable email to a set of known words or phrases associated with spam. Bayesian filtering has a very low rate of false positives and is a tried and true method for filtering spam.

More information about Bayesian filtering can be found [here](https://en.wikipedia.org/wiki/Naive_Bayes_spam_filtering).

Related Articles:

- [Spam]({{root_url}}/Glossary/spam.html)
- [Spam Filter]({{root_url}}/Glossary/spam_filter.html)
- [Spam Reports]({{root_url}}/Glossary/spam_reports.html)
- [Spam Trap]({{root_url}}/Glossary/spam_traps.html)
5 changes: 5 additions & 0 deletions source/Glossary/CAN-SPAM → source/Glossary/can_spam.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,14 @@ The [CAN-SPAM Act of 2003](https://www.ftc.gov/tips-advice/business-center/guida

This is by no means a complete description of CAN-SPAM, please visit the [CAN-SPAM Act Compliance Guide](https://www.ftc.gov/tips-advice/business-center/guidance/can-spam-act-compliance-guide-business) for more information.

{% info %}
The guidelines laid out in CAN-SPAM represent the “bare-minimum” regarding sending practices. Following these guidelines does not guarantee delivery to your recipients’ inboxes: CAN-SPAM leaves a considerable amount of room for improvement. Please visit [SendGrid Deliverability Tips and Tricks]({{root_url}}/Classroom/Deliver/index.html) for a more detailed discussion of how you can improve your sending practices.
{% endinfo %}

{% warning %}
CAN-SPAM is not limited to bulk email. Any commercial email communication, including business-to-business and business-to-customer email, is covered by the CAN-SPAM Act.
{% endwarning %}

Related Articles:

- [SendGrid Deliverability Tips and Tricks]({{root_url}}/Classroom/Deliver/index.html)
28 changes: 28 additions & 0 deletions source/Glossary/drip_campaign.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
layout: page
weight: 0
title: Drip Campaign
navigation:
show: true
seo:
title: Drip Campaign
override: true
description: Drip Campaigns are a type of automated email marketing strategy.
---

A drip campaign is a type of automated [email marketing strategy]({{root_url}}/Glossary/email_marketing.html) that involves sending a recipient
a series of pre-written messages according to a predetermined schedule. This schedule is often
initiated by certain events in the recipient’s lifecycle as a customer, such as registering for
a service or purchasing a product. Drip campaigns revolve around the idea of slowly “dripping”
specific emails to a recipient in an effort to generate or increase customer engagement over a finite
period of time.

Drip campaigns help you to send relevant and well timed emails that your customers are likely interested in
seeing. Striving to send emails that are relevant to your recipients can help to improve your [sender
reputation]({{root_url}}/Glossary/sender_reputation.html), cultivate customer satisfaction, and increase customer retention.

{% info %}
It is important to avoid initiating a series of messages that your customer doesn’t want to receive. Make sure
that you give your recipient the option of opting out of the drip campaign by including an [unsubscribe link]({{root_url}}/User_Guide/Suppressions/group_unsubscribes.html) in
every email you send.
{% endinfo %}
29 changes: 29 additions & 0 deletions source/Glossary/opt_in_email.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
seo:
title: Opt-In Email
description: Obtaining permission to send recipients email.
keywords: opt-in, opt-out, bulk email, CAN-SPAM
title: Opt-In Email
weight: 0
layout: page
navigation:
show: true
---

**Opt-in email** refers to bulk email, such as a newsletter or advertisement, that is sent out to a mailing list where every member of that list has actively given you permission to send them email. Without obtaining this permission, your email is likely unwanted or unsolicited, and is liable to be marked as [spam]({{root_url}}/Glossary/spam.html) by the recipient or be “bulked” by the receiving mailbox provider (i.e. delivered directly to the spam folder).

There are several variations of opt-in email:

- **Single Opt-in** refers to the practice of requesting your recipient’s permission to send them email during, and only during, registration.

- **Double Opt-in** refers to the practice of requesting your recipient's permission to send them email twice. For example, you could ask them if they want to receive your email at registration, and then send another email asking them to confirm their permission again.

- **Confirmed Opt-in** refers to the practice of sending confirmation emails to your recipients asking them to confirm their continued interest in receiving your future emails.

Giving your recipients the option to opt-in to receive your email will help to improve your [sender reputation]({{root_url}}/Glossary/sender_reputation.html) and will prevent your emails from ending up in your recipients’ [spam folders]({{root_url}}/Glossary/bulk_mail_folder.html).

Regardless of your method of obtaining a recipient's permission, it is important to give them the option of **opting-out** of receiving your future emails by including an [unsubscribe link]({{root_url}}/User_Guide/Suppressions/index.html).

{% info %}
[CAN-SPAM]({{root_url}}/Glossary/can_spam.html) requires an opt-out option in all commercial emails, but it’s good practice to provide it in any email to your recipients. CAN-SPAM requires all senders to immediately honor an opt-out request submitted by a recipient.
{% endinfo %}
19 changes: 19 additions & 0 deletions source/Glossary/triggered_actions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
seo:
title: Triggered Actions
description: Triggered Actions are initiated by a triggering event.
keywords: automated email, triggered actions, triggering events, Threads
title: Triggered Actions
weight: 0
layout: page
navigation:
show: true
---

Triggered actions are automatically completed when a specific [triggering event]({{root_url}}/Glossary/triggering_events.html) that you are tracking takes place. These actions must be defined in advance, and they must be associated with a predetermined user and event.

SendGrid’s automated email platform, [Threads](http://threads.io/), makes it possible for you to take several different actions depending on the ways in which a specified user interacts with your website or application. An example of a triggered action might be a purchase confirmation or receipt.

{% info %}
To learn more about the different actions that Threads makes possible, please visit our [Threads FAQ](https://support.threads.io/hc/en-us/articles/206049497-What-types-of-Workflow-Actions-are-supported-).
{% endinfo %}
15 changes: 15 additions & 0 deletions source/Glossary/triggered_email.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
seo:
title: Triggered Email
description: Triggered emails are another name for automated emails that are triggered by specific events or actions.
keywords: automated email, triggered email, Threads, triggering event, event
title: Triggered Email
weight: 0
layout: page
navigation:
show: true
---

{% info %}
Triggered email is another term for [automated email]({{root_url}}/Glossary/automated_email.html).
{% endinfo %}
21 changes: 21 additions & 0 deletions source/Glossary/triggering_events.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
seo:
title: Triggering Events
description: Triggering events are the events or actions which prompt the delivery of an automated email.
keywords: automated email, triggered email, Threads, triggering event, event
title: Triggering Events
weight: 0
layout: page
navigation:
show: true
---

Not to be confused with the post-send email events like [clicks]({{root_url}}/Glossary/clicks.html), [drops]({{root_url}}/Glossary/drops.html), or [bounces]({{root_url}}/Glossary/bounces.html) that SendGrid tracks: in terms of [automated email]({{root_url}}/Glossary/automated_email.html), **triggering events** are events that you specify based on the ways that your users interact with your website or application. These events can be tracked and used to prompt a [triggered action]({{root_url}}/Glossary/triggered_actions.html), such as the delivery of an email.

Viewing a webpage, using a feature, clicking a button, or buying a product are all examples of events that can be used to determine when an email should be sent and what the content of that email should be.

Events that are tracked through [Threads](http://threads.io/) may also have properties that can tell you more about what happened: the address of the webpage that your user visited, the exact button that they clicked, or the SKU (stock keeping unit) of the product they purchased.

{% info %}
More information about how events can be tracked in [Threads](http://threads.io/) can be found [here](https://support.threads.io/hc/en-us).
{% endinfo %}
42 changes: 42 additions & 0 deletions source/Integrate/Frameworks/laravel.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,45 @@ Mail::send('emails.demo', $data, function($message)

?>
{% endcodeblock %}

## Adding a category or custom field

Categories in sendgrid allow you to split your statistics into categories. An example would be if you have a white labeled service you can split your statistics by the user login.

Another useful feature of sendgrid is the notifications. If you want to complete the feedback loop for your product you can pass identifiers as a header which relate to a record in your database which you can then parse the notifications against that record to track deliveries/opens/clicks/bounces.


{% codeblock lang:php %}
<?php

Mail::send('emails.demo', $data, function($message)
{
$data['category'] = 'category;
$data['unique_args']['variable_1'] = 'abc';

$header = $this->asString($data);

$message->getSwiftMessage()->getHeaders()->addTextHeader('X-SMTPAPI', $header);

$message->to('[email protected]', 'Jane Doe')->subject('This is a demo!');
});

private function asJSON($data) // set as private with the expectation of being a class method
{
$json = json_encode($data);

$json = preg_replace('/(["\]}])([,:])(["\[{])/', '$1$2 $3', $json);

return $json;
}

private function asString($data) // set as private with the expectation of being a class method
{
$json = $this->asJSON($data);
$str = wordwrap($json, 76, "\n ");

return $str;
}
?>
{% endcodeblock %}

2 changes: 1 addition & 1 deletion source/User_Guide/Settings/mail.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ The Spam Checker setting, is useful when your web application allows your end us
The default threshold is 5.0 and can range between 1 and 10. The lower the number, the more strict the filtering. For example, a value of 2 will drop all but the most flawless emails, whereas 9 will only drop the spammiest of spam emails.
{% endwarning %}

We use [SpamAssassin](http://spamassassin.apache.org/full/3.4.x/doc/Mail_SpamAssassin_Conf.html#scoring_options) to process the spam checks for this filter. The default threshold is 5.0, but you can set this to any value between 1 and 10. If you provide a URL, we will post the message to that URL, but this field is optional. If a message is flagged as spam using this filter, it will automatically be dropped by our system and will not be delivered to the recipient.
We use [SpamAssassin](http://spamassassin.apache.org/full/3.4.x/doc/Mail_SpamAssassin_Conf.html#scoring_options) to process the spam checks for this filter. The default threshold is 5.0, but you can set this to any value between 1 and 10. You must provide an URL, so we will post the message to that URL. If a message is flagged as spam using this filter, it will automatically be dropped by our system and will not be delivered to the recipient.

{% anchor h3 %}
Settings
Expand Down
2 changes: 2 additions & 0 deletions source/User_Guide/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ navigation:
show: true
---

<iframe src="https://player.vimeo.com/video/144782741?title=0&byline=0&portrait=0" width="700" height="400" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>

The SendGrid dashboard is designed to give you an at-a-glance view of your current email activity. You can view the stats about all of the emails you have sent through your SendGrid account.

{% anchor h2 %}
Expand Down