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
The SocketLabs Email Delivery Ruby library allows you to easily send email messages via the [SocketLabs Injection API](https://www.socketlabs.com/docs/inject/). The library makes it easy to build and send any type of message supported by the API, from a simple message to a single recipient all the way to a complex bulk message sent to a group of recipients with unique merge data per recipient.
@@ -41,21 +41,21 @@ For more information please see the [Installing Gems](https://guides.rubygems.or
41
41
<aname="getting-started"id="getting-started"></a>
42
42
# Getting Started
43
43
## Obtaining your API Key and SocketLabs ServerId number
44
-
In order to get started, you'll need to enable the Injection API feature in the [SocketLabs Control Panel](https://cp.socketlabs.com).
45
-
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).
46
-
Make note of your 4 or 5 digit ServerId number, as you'll need this along with
47
-
your API key in order to use the Injection API.
44
+
In order to get started, you'll need to enable the Injection API feature in the [SocketLabs Control Panel](https://cp.socketlabs.com).
45
+
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).
46
+
Make note of your 4 or 5 digit ServerId number, as you'll need this along with
47
+
your API key in order to use the Injection API.
48
48
49
-
To enable the Injection API, click on the "For Developers" dropdown on the top-level navigation, then choose the "Configure HTTP Injection API" option.
49
+
To enable the Injection API, click on the "For Developers" dropdown on the top-level navigation, then choose the "Configure HTTP Injection API" option.
50
50
Once here, you can enable the feature by choosing the "Enabled" option in the
51
-
dropdown. Enabling the feature will also generate your API key, which you'll
52
-
need (along with your ServerId) to start using the API. Be sure to click the
51
+
dropdown. Enabling the feature will also generate your API key, which you'll
52
+
need (along with your ServerId) to start using the API. Be sure to click the
53
53
"Update" button to save your changes once you are finished.
54
54
55
55
56
56
## Basic Message
57
-
A basic message is an email message like you'd send from a personal email client such as Outlook.
58
-
A basic message can have many recipients, including multiple To addresses, CC addresses, and even BCC addresses.
57
+
A basic message is an email message like you'd send from a personal email client such as Outlook.
58
+
A basic message can have many recipients, including multiple To addresses, CC addresses, and even BCC addresses.
59
59
You can also send a file attachment in a basic message.
60
60
61
61
```ruby
@@ -72,7 +72,7 @@ message.plain_text_body = "This is the Plain Text Body of my message."
@@ -153,11 +153,11 @@ This example demonstrates a Basic Send.
153
153
This example demonstrates many features of the Basic Send, including adding multiple recipients, adding message and mailing id's, and adding an embedded image.
154
154
155
155
### [Basic send from HTML file](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/basic/basic_send_from_html_file.rb)
156
-
This example demonstrates how to read in your HTML content from an HTML file
156
+
This example demonstrates how to read in your HTML content from an HTML file
157
157
rather than passing in a string directly.
158
158
159
159
### [Basic send from SocketLabs Template](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/basic/basic_send_with_api_template.rb)
160
-
This example demonstrates the sending of a piece of content that was created in the
160
+
This example demonstrates the sending of a piece of content that was created in the
161
161
SocketLabs Email Designer. This is also known as the [API Templates](https://www.socketlabs.com/blog/introducing-api-templates/) feature.
162
162
163
163
### [Basic send with specified character set](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/basic/basic_send_with_ascii_charset.rb)
@@ -195,19 +195,19 @@ This example demonstrates the results of attempting to do a send with invalid re
195
195
This example demonstrates how to send a bulk message to multiple recipients.
196
196
197
197
### [Bulk send with merge data](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/bulk/bulk_send_with_merge_data.rb)
198
-
This example demonstrates how to send a bulk message to multiple recipients with
198
+
This example demonstrates how to send a bulk message to multiple recipients with
199
199
unique merge data per recipient.
200
200
201
201
### [Bulk send with complex merge including attachments](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/bulk/bulk_send_complex.rb)
202
-
This example demonstrates many features of the `BulkMessage()`, including
202
+
This example demonstrates many features of the `BulkMessage()`, including
203
203
adding multiple recipients, merge data, and adding an attachment.
204
204
205
205
### [Bulk send with recipients pulled from a datasource](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/bulk/bulk_send_from_data_source_with_merge_data.rb)
206
-
This example uses a mock repository class to demonstrate how you would pull
206
+
This example uses a mock repository class to demonstrate how you would pull
207
207
your recipients from a database and create a bulk mailing with merge data.
208
208
209
209
### [Bulk send with Ascii charset and special characters](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/bulk/bulk_send_with_ascii_charset_merge_data.rb)
210
-
This example demonstrates how to send a bulk message with a specified character
210
+
This example demonstrates how to send a bulk message with a specified character
211
211
set and special characters.
212
212
213
213
### [Bulk send with Amp ](https://github.com/socketlabs/socketlabs-ruby/blob/master/examples/bulk/bulk_send_with_amp_body.rb)
@@ -216,7 +216,8 @@ For more information about AMP please see [AMP Project](https://amp.dev/document
0 commit comments