Skip to content

Commit 0eff689

Browse files
updating version
1 parent a1755b6 commit 0eff689

File tree

1 file changed

+33
-32
lines changed

1 file changed

+33
-32
lines changed

README.md

Lines changed: 33 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![SocketLabs](https://static.socketlabs.com/logos/logo-dark-326x64.png)](https://www.socketlabs.com/developers)
1+
[![SocketLabs](https://static.socketlabs.com/logos/logo-dark-326x64.png)](https://www.socketlabs.com/developers)
22
# [![Twitter Follow](https://img.shields.io/twitter/follow/socketlabs.svg?style=social&label=Follow)](https://twitter.com/socketlabs) [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/socketlabs/socketlabs-csharp/blob/master/CONTRIBUTING.md)
33
<!--
44
[![GitHub contributors](https://img.shields.io/github/contributors/socketlabs/socketlabs-python.svg)](https://github.com/socketlabs/socketlabs-python/graphs/contributors)
@@ -28,12 +28,12 @@ pip install socketlabs-injectionapi
2828
```
2929
### From a local archive using pip
3030

31-
You can just download the package and install from a local archive file.
31+
You can just download the package and install from a local archive file.
3232

33-
> [socketlabs_injectionapi-1.2.1.tar.gz](https://github.com/socketlabs/socketlabs-python/releases/download/1.2python setup.py sdist bdist_wheel.1/socketlabs_injectionapi-1.2.1.tar.gz)
33+
> [socketlabs_injectionapi-1.4.0.tar.gz](https://github.com/socketlabs/socketlabs-python/releases/download/socketlabs_injectionapi-1.4.0.tar.gz)
3434
3535
```
36-
pip install <path>/socketlabs_injectionapi-1.2.1.tar.gz
36+
pip install <path>/socketlabs_injectionapi-1.4.0.tar.gz
3737
```
3838

3939
### From git using pip
@@ -45,21 +45,21 @@ For more information please see the [Installing Packages](https://packaging.pyth
4545
<a name="getting-started" id="getting-started"></a>
4646
# Getting Started
4747
## Obtaining your API Key and SocketLabs ServerId number
48-
In order to get started, you'll need to enable the Injection API feature in the [SocketLabs Control Panel](https://cp.socketlabs.com).
49-
Once logged in, navigate to your SocketLabs server's dashboard (if you only have one server on your account you'll be taken here immediately after logging in).
50-
Make note of your 4 or 5 digit ServerId number, as you'll need this along with
51-
your API key in order to use the Injection API.
48+
In order to get started, you'll need to enable the Injection API feature in the [SocketLabs Control Panel](https://cp.socketlabs.com).
49+
Once logged in, navigate to your SocketLabs server's dashboard (if you only have one server on your account you'll be taken here immediately after logging in).
50+
Make note of your 4 or 5 digit ServerId number, as you'll need this along with
51+
your API key in order to use the Injection API.
5252

53-
To enable the Injection API, click on the "For Developers" dropdown on the top-level navigation, then choose the "Configure HTTP Injection API" option.
53+
To enable the Injection API, click on the "For Developers" dropdown on the top-level navigation, then choose the "Configure HTTP Injection API" option.
5454
Once here, you can enable the feature by choosing the "Enabled" option in the
55-
dropdown. Enabling the feature will also generate your API key, which you'll
56-
need (along with your ServerId) to start using the API. Be sure to click the
55+
dropdown. Enabling the feature will also generate your API key, which you'll
56+
need (along with your ServerId) to start using the API. Be sure to click the
5757
"Update" button to save your changes once you are finished.
5858

5959

6060
## Basic Message
61-
A basic message is an email message like you'd send from a personal email client such as Outlook.
62-
A basic message can have many recipients, including multiple To addresses, CC addresses, and even BCC addresses.
61+
A basic message is an email message like you'd send from a personal email client such as Outlook.
62+
A basic message can have many recipients, including multiple To addresses, CC addresses, and even BCC addresses.
6363
You can also send a file attachment in a basic message.
6464

6565
```python
@@ -78,7 +78,7 @@ message.plain_text_body = "This is the Plain Text Body of my message.";
7878

7979
message.from_email_address = EmailAddress("[email protected]")
8080

81-
# A basic message supports up to 50 recipients
81+
# A basic message supports up to 50 recipients
8282
# and supports several different ways to add recipients
8383

8484
# Add a To address by passing the email address
@@ -98,9 +98,9 @@ response = client.send(message)
9898
```
9999

100100
## Bulk Message
101-
A bulk message usually contains a single recipient per message
102-
and is generally used to send the same content to many recipients,
103-
optionally customizing the message via the use of MergeData.
101+
A bulk message usually contains a single recipient per message
102+
and is generally used to send the same content to many recipients,
103+
optionally customizing the message via the use of MergeData.
104104
For more information about using Merge data, please see the [Injection API documentation](https://www.socketlabs.com/docs/inject/).
105105
```python
106106
from socketlabs.injectionapi import SocketLabsClient
@@ -131,28 +131,28 @@ response = client.send(message)
131131

132132
<a name="managing-api-keys" id="managing-api-keys"></a>
133133
## Managing API Keys
134-
For ease of demonstration, many of our examples include the ServerId (SOCKETLABS_SERVER_ID) and API key
135-
(SOCKETLABS_INJECTION_API_KEY) directly in our code sample. Generally it is not considered a good practice to store
136-
sensitive information like this directly in your code. Depending on your project type, we recommend either storing your
137-
credentials using Environment Variables. For more information please see:
134+
For ease of demonstration, many of our examples include the ServerId (SOCKETLABS_SERVER_ID) and API key
135+
(SOCKETLABS_INJECTION_API_KEY) directly in our code sample. Generally it is not considered a good practice to store
136+
sensitive information like this directly in your code. Depending on your project type, we recommend either storing your
137+
credentials using Environment Variables. For more information please see:
138138
[Using Environment Variables](https://docs.microsoft.com/en-us/dotnet/api/system.environment.getenvironmentvariable)
139139

140140

141141
<a name="examples-and-use-cases" id="examples-and-use-cases"></a>
142142
# Examples and Use Cases
143-
In order to demonstrate the many possible use cases for the SDK, we've provided
144-
an assortment of code examples. These examples demonstrate many different
145-
features available to the Injection API and SDK, including using templates
146-
created in the [SocketLabs Email Designer](https://www.socketlabs.com/blog/introducing-new-email-designer/), custom email headers, sending
147-
attachments, sending content that is stored in an HTML file, advanced bulk
143+
In order to demonstrate the many possible use cases for the SDK, we've provided
144+
an assortment of code examples. These examples demonstrate many different
145+
features available to the Injection API and SDK, including using templates
146+
created in the [SocketLabs Email Designer](https://www.socketlabs.com/blog/introducing-new-email-designer/), custom email headers, sending
147+
attachments, sending content that is stored in an HTML file, advanced bulk
148148
merging, and even pulling recipients from a datasource.
149149

150150
### [Basic send from SocketLabs Template](https://github.com/socketlabs/socketlabs-python/blob/master/python-examples/basic/basic_send_with_api_template.py)
151-
This example demonstrates the sending of a piece of content that was created in the
151+
This example demonstrates the sending of a piece of content that was created in the
152152
SocketLabs Email Designer. This is also known as the [API Templates](https://www.socketlabs.com/blog/introducing-api-templates/) feature.
153153

154154
### [Basic send from HTML file](https://github.com/socketlabs/socketlabs-python/blob/master/python-examples/basic/basic_send_from_html_file.py)
155-
This example demonstrates how to read in your HTML content from an HTML file
155+
This example demonstrates how to read in your HTML content from an HTML file
156156
rather than passing in a string directly.
157157

158158
### [Basic send with file attachment](https://github.com/socketlabs/socketlabs-python/blob/master/python-examples/basic/basic_send_with_attachment.py)
@@ -196,19 +196,19 @@ This example demonstrates the results of attempting to do a send with invalid re
196196
This example demonstrates how to send a bulk message to multiple recipients.
197197

198198
### [Bulk send with merge data](https://github.com/socketlabs/socketlabs-python/blob/master/python-examples/bulk/bulk_send_from_data_source_with_merge.py)
199-
This example demonstrates how to send a bulk message to multiple recipients with
199+
This example demonstrates how to send a bulk message to multiple recipients with
200200
unique merge data per recipient.
201201

202202
### [Bulk send with complex merge including attachments](https://github.com/socketlabs/socketlabs-python/blob/master/python-examples/bulk/bulk_send_complex.py)
203-
This example demonstrates many features of the `BulkMessage()`, including
203+
This example demonstrates many features of the `BulkMessage()`, including
204204
adding multiple recipients, merge data, and adding an attachment.
205205

206206
### [Bulk send with recipients pulled from a datasource](https://github.com/socketlabs/socketlabs-python/blob/master/python-examples/bulk/bulk_send_with_ascii_charset_merge_data.py)
207-
This example uses a mock repository class to demonstrate how you would pull
207+
This example uses a mock repository class to demonstrate how you would pull
208208
your recipients from a database and create a bulk mailing with merge data.
209209

210210
### [Bulk send with Ascii charset and special characters](https://github.com/socketlabs/socketlabs-python/blob/master/python-examples/bulk/bulk_send_with_ascii_charset_merge_data.py)
211-
This example demonstrates how to send a bulk message with a specified character
211+
This example demonstrates how to send a bulk message with a specified character
212212
set and special characters.
213213

214214
### [Bulk send with Amp ](https://github.com/socketlabs/socketlabs-python/blob/main/python-examples/bulk/bulk_send_with_amp_body.py)
@@ -217,6 +217,7 @@ For more information about AMP please see [AMP Project](https://amp.dev/document
217217

218218
<a name="version"></a>
219219
# Version
220+
* 1.4.0 - Adding Metadata and Tags
220221
* 1.2.1 - Adding optional retry logic for Http requests. If configured, the request will retry when certain 500 errors occur (500, 502, 503, 504)
221222
* 1.1.1 - Adding request timeout value on the client for Http requests
222223
* 1.1.0 - Adds Amp Html Support

0 commit comments

Comments
 (0)