forked from sendgrid/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
52 lines (42 loc) · 3.22 KB
/
Copy pathindex.html
File metadata and controls
52 lines (42 loc) · 3.22 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
---
layout: page
weight: 100
title: API Reference Index
navigation:
show: true
---
{% anchor h2 %}
Send Email
{% endanchor %}
<p>There are three different technical concepts you should know about SendGrid related to sending email:</p>
<h3>SMTP</h3>
<p>This is a protocol rather than an API. SMTP is widely supported by applications and is usually the fastest way to integrate with SendGrid. <a href="{{root_url}}/Integrate/index.html">Learn how to integrate using SMTP</a>.</p>
<h3>Web Email API</h3>
<p>If SMTP is not used, we also offer a simple <a href="{{root_url}}/API_Reference/Web_API/mail.html">Web API mail method</a> to send email. </p>
<h3>SMTPAPI</h3>
<p>This is an API that allows you to tag your emails to get detailed statistics on each tag, send multiple customized emails in one request via mail merge, and configure each app on a per email basis. This is done by passing a JSON string in the X-SMTPAPI header if using SMTP or in the x-smtpapi HTTP parameter if using the web API. <a href="{{root_url}}/API_Reference/SMTP_API/index.html">Using the SMTP API</a></p>
{% anchor h2 %}
Configure Service or Retrieve Information
{% endanchor %}
<p>SendGrid has a Web API that allows customers to retrieve information about their account such as statistics, bounces, spam reports, unsubscribes, and other information. In addition, the Web API allows customers to create sub-accounts and control the settings of these accounts for an OEM setup. See the <a href="{{root_url}}/API_Reference/Web_API/index.html">list of Web API calls</a>.</p>
{% anchor h2 %}
Receive Email
{% endanchor %}
<p>SendGrid can parse the email bodies and attachments from incoming emails and post them to your web application. For details on how to integrate your application to start receiving emails please refer to our <a href="{{root_url}}/API_Reference/Webhooks/parse.html">Parse Webhook</a>. Application examples include:</p>
<ul>
<li>Posting blog articles via email</li>
<li>Processing email replies in a mailing list</li>
<li>Allowing users to upload pictures to their profile via email</li>
<li>Submit support requests via email</li>
</ul>
{% anchor h2 %}
Real-time Event Notification Webhook
{% endanchor %}
<p>SendGrid can send real-time notifications about events that happen on the SendGrid system to a URL. These events include clicks, opens, unsubscribe, bounces, and many others. These events include more data than what SendGrid records and allow customers to customize their own reporting. What makes this API even more powerful is the ability to include user-defined parameters in each event. Through our SMTP API, customers can embed unique parameters in each email they send. These parameters are then passed to each event notification so your application can associate these events with your customers. Read more about the <a href="{{root_url}}/API_Reference/Webhooks/event.html">Event Webhook</a>. Examples of applications include:</p>
<ul>
<li>Associate a spam report with a specific campaign and user in your application</li>
<li>Know real-time when a user has clicked on a confirmation email</li>
<li>Get the specific link clicked on an email</li>
<li>Get the browser version used by a customer</li>
<li>Know the specific MTA response for a customer</li>
</ul>