You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ All notable changes to this project will be documented in this file.
41
41
### BREAKING CHANGE
42
42
- Pull #244[refactor helpers using property getter/setter](https://github.com/sendgrid/sendgrid-python/pull/244/files)
43
43
- Big thanks to [Denis Vlasov](https://github.com/denis90) for the pull request!
44
-
- The changes break the impelmentation of the [Mail Helper](https://github.com/sendgrid/sendgrid-python/tree/master/sendgrid/helpers/mail)`Mail()` class
44
+
- The changes break the implementation of the [Mail Helper](https://github.com/sendgrid/sendgrid-python/tree/master/sendgrid/helpers/mail)`Mail()` class
45
45
-`set_from()` is now the property `from_email`
46
46
-`set_subject()` is now the property `subject`
47
47
-`set_template_id()` is now the property `template_id`
@@ -299,7 +299,7 @@ All notable changes to this project will be documented in this file.
299
299
## [1.5.9] - 2015-10-26 ##
300
300
301
301
### Added ###
302
-
-Supression Unsubscribes [GET]
302
+
-Suppression Unsubscribes [GET]
303
303
304
304
## [1.5.8] - 2015-10-21 ##
305
305
@@ -332,7 +332,7 @@ All notable changes to this project will be documented in this file.
332
332
### Added ###
333
333
- Refactored tests and added Tox support
334
334
- Framework for Web API v3 endpoints
335
-
- Web API v3 endpionts: apikeys, ASM groups and ASM suppressions
335
+
- Web API v3 endpoints: apikeys, ASM groups and ASM suppressions
Copy file name to clipboardExpand all lines: USAGE.md
+25-25Lines changed: 25 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -137,7 +137,7 @@ print response.headers
137
137
```
138
138
## Retrieve a specific whitelisted IP
139
139
140
-
**This endpoint allows you to retreive a specific IP address that has been whitelisted.**
140
+
**This endpoint allows you to retrieve a specific IP address that has been whitelisted.**
141
141
142
142
You must include the ID for the specific IP address you want to retrieve in your call.
143
143
@@ -204,7 +204,7 @@ print response.headers
204
204
```
205
205
## Retrieve all alerts
206
206
207
-
**This endpoint allows you to retieve all of your alerts.**
207
+
**This endpoint allows you to retrieve all of your alerts.**
208
208
209
209
Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics.
210
210
* Usage alerts allow you to set the threshold at which an alert will be sent.
@@ -289,7 +289,7 @@ print response.headers
289
289
290
290
## Create API keys
291
291
292
-
**This enpoint allows you to create a new random API Key for the user.**
292
+
**This endpoint allows you to create a new random API Key for the user.**
293
293
294
294
A JSON request body containing a "name" property is required. If number of maximum keys is reached, HTTP 403 will be returned.
295
295
@@ -407,7 +407,7 @@ print response.headers
407
407
408
408
**This endpoint allows you to revoke an existing API Key.**
409
409
410
-
Authentications using this API Key will fail after this request is made, with some small propogation delay.If the API Key ID does not exist an HTTP 404 will be returned.
410
+
Authentications using this API Key will fail after this request is made, with some small propagation delay.If the API Key ID does not exist an HTTP 404 will be returned.
411
411
412
412
The API Keys feature allows customers to be able to generate an API Key credential which can be used for authentication with the SendGrid v3 Web API or the [Mail API Endpoint](https://sendgrid.com/docs/API_Reference/Web_API/mail.html).
413
413
@@ -462,7 +462,7 @@ This endpoint will return information for each group ID that you include in your
462
462
463
463
Suppressions are a list of email addresses that will not receive content sent under a given [group](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html).
464
464
465
-
Suppression groups, or [unsubscribe groups](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html), allow you to label a category of content that you regularly send. This gives your recipients the ability to opt out of a specific set of your email. For example, you might define a group for your transactional email, and one for your marketing email so that your users can continue recieving your transactional email witout having to receive your marketing content.
465
+
Suppression groups, or [unsubscribe groups](https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/groups.html), allow you to label a category of content that you regularly send. This gives your recipients the ability to opt out of a specific set of your email. For example, you might define a group for your transactional email, and one for your marketing email so that your users can continue receiving your transactional email without having to receive your marketing content.
466
466
467
467
### GET /asm/groups
468
468
@@ -661,9 +661,9 @@ print response.headers
661
661
```
662
662
## Retrieve a Global Suppression
663
663
664
-
**This endpoint allows you to retrieve a global suppression. You can also use this endpoint to confirm if an email address is already globally suppresed.**
664
+
**This endpoint allows you to retrieve a global suppression. You can also use this endpoint to confirm if an email address is already globally suppressed.**
665
665
666
-
If the email address you include in the URL path parameter `{email}` is alreayd globally suppressed, the response will include that email address. If the address you enter for `{email}` is not globally suppressed, an empty JSON object `{}` will be returned.
666
+
If the email address you include in the URL path parameter `{email}` is already globally suppressed, the response will include that email address. If the address you enter for `{email}` is not globally suppressed, an empty JSON object `{}` will be returned.
667
667
668
668
A global suppression (or global unsubscribe) is an email address of a recipient who does not want to receive any of your messages. A globally suppressed recipient will be removed from any email you send. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Suppressions/global_unsubscribes.html).
669
669
@@ -1579,7 +1579,7 @@ Valid operators for create and update depend on the type of the field you are se
1579
1579
1580
1580
Segment conditions using "eq" or "ne" for email clicks and opens should provide a "field" of either *clicks.campaign_identifier* or *opens.campaign_identifier*. The condition value should be a string containing the id of a completed campaign.
1581
1581
1582
-
Segments may contain multiple condtions, joined by an "and" or "or" in the "and_or" field. The first condition in the conditions list must have an empty "and_or", and subsequent conditions must all specify an "and_or".
1582
+
Segments may contain multiple conditions, joined by an "and" or "or" in the "and_or" field. The first condition in the conditions list must have an empty "and_or", and subsequent conditions must all specify an "and_or".
1583
1583
1584
1584
The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.
1585
1585
@@ -1838,7 +1838,7 @@ print response.headers
1838
1838
```
1839
1839
## Retrieve all IP pools.
1840
1840
1841
-
**This endpoint allows you to retreive all of your IP pools.**
1841
+
**This endpoint allows you to retrieve all of your IP pools.**
1842
1842
1843
1843
IP Pools allow you to group your dedicated SendGrid IP addresses together. For example, you could create separate pools for your transactional and marketing email. When sending marketing emails, specify that you want to use the marketing IP pool. This allows you to maintain separate reputations for your different email traffic.
1844
1844
@@ -2241,7 +2241,7 @@ data = {
2241
2241
"enable": True,
2242
2242
"html": "If you would like to unsubscribe and stop receiving these emails <% clickhere %>.",
2243
2243
"substitution_tag": "<%click here%>",
2244
-
"text": "If you would like to unsubscribe and stop receiveing these emails <% click here %>."
2244
+
"text": "If you would like to unsubscribe and stop receiving these emails <% click here %>."
2245
2245
}
2246
2246
}
2247
2247
}
@@ -2706,7 +2706,7 @@ print response.headers
2706
2706
2707
2707
**This endpoint returns a list of all scopes that this user has access to.**
2708
2708
2709
-
API Keys can be used to authenticate the use of [SendGrids v3 Web API](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html), or the [Mail API Endpoint](https://sendgrid.com/docs/API_Reference/Web_API/mail.html). API Keys may be assigned certain permissions, or scopes, that limit which API endpoints they are able to access. For a more detailed explanation of how you can use API Key permissios, please visit our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/api_keys.html#-API-Key-Permissions) or [Classroom](https://sendgrid.com/docs/Classroom/Basics/API/api_key_permissions.html).
2709
+
API Keys can be used to authenticate the use of [SendGrids v3 Web API](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html), or the [Mail API Endpoint](https://sendgrid.com/docs/API_Reference/Web_API/mail.html). API Keys may be assigned certain permissions, or scopes, that limit which API endpoints they are able to access. For a more detailed explanation of how you can use API Key permissions, please visit our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/api_keys.html#-API-Key-Permissions) or [Classroom](https://sendgrid.com/docs/Classroom/Basics/API/api_key_permissions.html).
2710
2710
2711
2711
### GET /scopes
2712
2712
@@ -2822,7 +2822,7 @@ print response.headers
2822
2822
```
2823
2823
## Delete a Sender Identity
2824
2824
2825
-
**This endoint allows you to delete one of your sender identities.**
2825
+
**This endpoint allows you to delete one of your sender identities.**
2826
2826
2827
2827
Sender Identities are required to be verified before use. If your domain has been whitelabeled it will auto verify on creation. Otherwise an email will be sent to the `from.email`.
2828
2828
@@ -2838,7 +2838,7 @@ print response.headers
2838
2838
```
2839
2839
## Resend Sender Identity Verification
2840
2840
2841
-
**This enpdoint allows you to resend a sender identity verification email.**
2841
+
**This endpoint allows you to resend a sender identity verification email.**
2842
2842
2843
2843
Sender Identities are required to be verified before use. If your domain has been whitelabeled it will auto verify on creation. Otherwise an email will be sent to the `from.email`.
2844
2844
@@ -3125,7 +3125,7 @@ print response.headers
3125
3125
```
3126
3126
## Retrieve the monthly email statistics for a single subuser
3127
3127
3128
-
**This endpoint allows you to retrive the monthly email statistics for a specific subuser.**
3128
+
**This endpoint allows you to retrieve the monthly email statistics for a specific subuser.**
3129
3129
3130
3130
While you can always view the statistics for all email activity on your account, subuser statistics enable you to view specific segments of your stats for your subusers. Emails sent, bounces, and spam reports are always tracked for subusers. Unsubscribes, clicks, and opens are tracked if you have enabled the required settings.
3131
3131
@@ -3975,7 +3975,7 @@ print response.headers
3975
3975
3976
3976
**This endpoint allows you to retrieve the current credit balance for your account.**
3977
3977
3978
-
Your monthly credit allotment limits the number of emails you may send before incurring overage charges. For more information about credits and billing, please visit our [Clssroom](https://sendgrid.com/docs/Classroom/Basics/Billing/billing_info_and_faqs.html).
3978
+
Your monthly credit allotment limits the number of emails you may send before incurring overage charges. For more information about credits and billing, please visit our [Classroom](https://sendgrid.com/docs/Classroom/Basics/Billing/billing_info_and_faqs.html).
3979
3979
3980
3980
### GET /user/credits
3981
3981
@@ -4358,7 +4358,7 @@ print response.headers
4358
4358
4359
4359
**This endpoint allows you to retrieve all of your current inbound parse settings.**
4360
4360
4361
-
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the contnet, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
4361
+
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the content, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
4362
4362
4363
4363
### GET /user/webhooks/parse/settings
4364
4364
@@ -4373,7 +4373,7 @@ print response.headers
4373
4373
4374
4374
**This endpoint allows you to update a specific inbound parse setting.**
4375
4375
4376
-
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the contnet, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
4376
+
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the content, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
**This endpoint allows you to retrieve a specific inbound parse setting.**
4396
4396
4397
-
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the contnet, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
4397
+
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the content, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
4398
4398
4399
4399
### GET /user/webhooks/parse/settings/{hostname}
4400
4400
@@ -4410,7 +4410,7 @@ print response.headers
4410
4410
4411
4411
**This endpoint allows you to delete a specific inbound parse setting.**
4412
4412
4413
-
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the contnet, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
4413
+
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the content, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
**This endpoint allows you to retrieve the statistics for your Parse Webhook useage.**
4427
+
**This endpoint allows you to retrieve the statistics for your Parse Webhook usage.**
4428
4428
4429
-
SendGrid's Inbound Parse Webhook allows you to parse the contents and attachments of incomming emails. The Parse API can then POST the parsed emails to a URL that you specify. The Inbound Parse Webhook cannot parse messages greater than 20MB in size, including all attachments.
4429
+
SendGrid's Inbound Parse Webhook allows you to parse the contents and attachments of incoming emails. The Parse API can then POST the parsed emails to a URL that you specify. The Inbound Parse Webhook cannot parse messages greater than 20MB in size, including all attachments.
4430
4430
4431
4431
There are a number of pre-made integrations for the SendGrid Parse Webhook which make processing events easy. You can find these integrations in the [Library Index](https://sendgrid.com/docs/Integrate/libraries.html#-Webhook-Libraries).
4432
4432
@@ -4752,7 +4752,7 @@ print response.headers
4752
4752
```
4753
4753
## Retrieve all IP whitelabels
4754
4754
4755
-
**This endpoint allows you to retrieve all of the IP whitelabels that have been createdy by this account.**
4755
+
**This endpoint allows you to retrieve all of the IP whitelabels that have been created by this account.**
4756
4756
4757
4757
You may include a search key by using the "ip" parameter. This enables you to perform a prefix search for a given IP segment (e.g. "192.").
4758
4758
@@ -4895,7 +4895,7 @@ print response.headers
4895
4895
**This endpoint allows you to retrieve the associated link whitelabel for a subuser.**
4896
4896
4897
4897
Link whitelables can be associated with subusers from the parent account. This functionality allows
4898
-
subusers to send mail using their parent's linke whitelabels. To associate a link whitelabel, the parent account
4898
+
subusers to send mail using their parent's link whitelabels. To associate a link whitelabel, the parent account
4899
4899
must first create a whitelabel and validate it. The parent may then associate that whitelabel with a subuser via the API or the Subuser Management page in the user interface.
4900
4900
4901
4901
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.
@@ -4917,7 +4917,7 @@ print response.headers
4917
4917
**This endpoint allows you to disassociate a link whitelabel from a subuser.**
4918
4918
4919
4919
Link whitelables can be associated with subusers from the parent account. This functionality allows
4920
-
subusers to send mail using their parent's linke whitelabels. To associate a link whitelabel, the parent account
4920
+
subusers to send mail using their parent's link whitelabels. To associate a link whitelabel, the parent account
4921
4921
must first create a whitelabel and validate it. The parent may then associate that whitelabel with a subuser via the API or the Subuser Management page in the user interface.
4922
4922
4923
4923
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.
@@ -5014,7 +5014,7 @@ print response.headers
5014
5014
**This endpoint allows you to associate a link whitelabel with a subuser account.**
5015
5015
5016
5016
Link whitelables can be associated with subusers from the parent account. This functionality allows
5017
-
subusers to send mail using their parent's linke whitelabels. To associate a link whitelabel, the parent account
5017
+
subusers to send mail using their parent's link whitelabels. To associate a link whitelabel, the parent account
5018
5018
must first create a whitelabel and validate it. The parent may then associate that whitelabel with a subuser via the API or the Subuser Management page in the user interface.
5019
5019
5020
5020
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.
0 commit comments