diff --git a/source/API_Reference/SMTP_API/scheduling_parameters.md b/source/API_Reference/SMTP_API/scheduling_parameters.md index 5d1fa4b5da..6e46a573d5 100644 --- a/source/API_Reference/SMTP_API/scheduling_parameters.md +++ b/source/API_Reference/SMTP_API/scheduling_parameters.md @@ -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 %} diff --git a/source/API_Reference/Web_API/Reseller_API/customer_management.md b/source/API_Reference/Web_API/Reseller_API/customer_management.md index 5132e759fa..0a3b946944 100644 --- a/source/API_Reference/Web_API/Reseller_API/customer_management.md +++ b/source/API_Reference/Web_API/Reseller_API/customer_management.md @@ -95,6 +95,8 @@ 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 %} @@ -102,6 +104,7 @@ Obtain a complete list of all customers. {% response json %} [ { + "id": "123", "username": "username", "email": "example1@example.com", "active": "true", @@ -116,6 +119,7 @@ Obtain a complete list of all customers. "website": "example.com" }, { + "id": "124", "username": "username", "email": "example2@example.com", "active": "false", @@ -134,14 +138,13 @@ Obtain a complete list of all customers. {% response xml %} + 123 user1 example1@example.com true john doe -
-555 any street -
+
555 any street
any city CA 91234 @@ -150,14 +153,13 @@ Obtain a complete list of all customers. example.com + 124 user2 example2@example.com false jane doe -
-555 any street -
+
555 any street
any city CA 91234 diff --git a/source/API_Reference/Web_API_v3/IP_Management/ip_addresses.md b/source/API_Reference/Web_API_v3/IP_Management/ip_addresses.md index 9970472772..1f5eb1a50c 100644 --- a/source/API_Reference/Web_API_v3/IP_Management/ip_addresses.md +++ b/source/API_Reference/Web_API_v3/IP_Management/ip_addresses.md @@ -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"], diff --git a/source/Glossary/Drip Campaign b/source/Glossary/Drip Campaign new file mode 100644 index 0000000000..353c2d28d4 --- /dev/null +++ b/source/Glossary/Drip Campaign @@ -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. diff --git a/source/Glossary/automated_email.md b/source/Glossary/automated_email.md new file mode 100644 index 0000000000..e2fcb7eb57 --- /dev/null +++ b/source/Glossary/automated_email.md @@ -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 %} diff --git a/source/Glossary/autoresponder.md b/source/Glossary/autoresponder.md new file mode 100644 index 0000000000..15c0896573 --- /dev/null +++ b/source/Glossary/autoresponder.md @@ -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). diff --git a/source/Glossary/bayesian_filter.md b/source/Glossary/bayesian_filter.md new file mode 100644 index 0000000000..d10a8ee4da --- /dev/null +++ b/source/Glossary/bayesian_filter.md @@ -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) diff --git a/source/Glossary/CAN-SPAM b/source/Glossary/can_spam.md similarity index 75% rename from source/Glossary/CAN-SPAM rename to source/Glossary/can_spam.md index 6fd0de4735..bd4c6fd684 100644 --- a/source/Glossary/CAN-SPAM +++ b/source/Glossary/can_spam.md @@ -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) diff --git a/source/Glossary/drip_campaign.md b/source/Glossary/drip_campaign.md new file mode 100644 index 0000000000..f982612aa6 --- /dev/null +++ b/source/Glossary/drip_campaign.md @@ -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 %} diff --git a/source/Glossary/opt_in_email.md b/source/Glossary/opt_in_email.md new file mode 100644 index 0000000000..a0bff4d5a8 --- /dev/null +++ b/source/Glossary/opt_in_email.md @@ -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 %} diff --git a/source/Glossary/triggered_actions.md b/source/Glossary/triggered_actions.md new file mode 100644 index 0000000000..ede433acf9 --- /dev/null +++ b/source/Glossary/triggered_actions.md @@ -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 %} diff --git a/source/Glossary/triggered_email.md b/source/Glossary/triggered_email.md new file mode 100644 index 0000000000..889e5ef445 --- /dev/null +++ b/source/Glossary/triggered_email.md @@ -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 %} diff --git a/source/Glossary/triggering_events.md b/source/Glossary/triggering_events.md new file mode 100644 index 0000000000..4b09f3c8c5 --- /dev/null +++ b/source/Glossary/triggering_events.md @@ -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 %} diff --git a/source/Integrate/Frameworks/laravel.md b/source/Integrate/Frameworks/laravel.md index fd6c7a82a6..0bd2626861 100644 --- a/source/Integrate/Frameworks/laravel.md +++ b/source/Integrate/Frameworks/laravel.md @@ -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 %} +asString($data); + + $message->getSwiftMessage()->getHeaders()->addTextHeader('X-SMTPAPI', $header); + + $message->to('jane@example.com', '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 %} + diff --git a/source/User_Guide/Settings/mail.md b/source/User_Guide/Settings/mail.md index 5c3c7e19e5..f033f89b50 100644 --- a/source/User_Guide/Settings/mail.md +++ b/source/User_Guide/Settings/mail.md @@ -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 diff --git a/source/User_Guide/dashboard.md b/source/User_Guide/dashboard.md index 71959f2cdb..22513e47c8 100644 --- a/source/User_Guide/dashboard.md +++ b/source/User_Guide/dashboard.md @@ -10,6 +10,8 @@ navigation: show: true --- + + 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 %}