mailgun-ruby 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +20 -0
- data/Gemfile +4 -0
- data/LICENSE +191 -0
- data/MessageBuilder.md +85 -0
- data/Messages.md +77 -0
- data/OptInHandler.md +103 -0
- data/README.md +150 -0
- data/Rakefile +33 -0
- data/Snippets.md +506 -0
- data/lib/mailgun.rb +227 -0
- data/lib/mailgun/exceptions/exceptions.rb +27 -0
- data/lib/mailgun/lists/opt_in_handler.rb +46 -0
- data/lib/mailgun/messages/batch_message.rb +139 -0
- data/lib/mailgun/messages/message_builder.rb +321 -0
- data/lib/mailgun/version.rb +5 -0
- data/mailgun.gemspec +42 -0
- data/spec/integration/mailgun_spec.rb +598 -0
- data/spec/integration/messages/sample_data/mime.txt +38 -0
- data/spec/spec_helper.rb +15 -0
- data/spec/unit/connection/test_client.rb +143 -0
- data/spec/unit/lists/opt_in_handler_spec.rb +22 -0
- data/spec/unit/mailgun_spec.rb +131 -0
- data/spec/unit/messages/batch_message_spec.rb +130 -0
- data/spec/unit/messages/message_builder_spec.rb +359 -0
- data/spec/unit/messages/sample_data/mailgun_icon.png +0 -0
- data/spec/unit/messages/sample_data/mime.txt +38 -0
- data/spec/unit/messages/sample_data/rackspace_logo.jpg +0 -0
- metadata +171 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: d0af97ef09388ef5e354ea330f46da241d89528a
|
4
|
+
data.tar.gz: 9c79b5dda98783d6a783e280323f7cd2b7026519
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 4c908d5931b2b65655ee7138497c0aece18773c4c7b9d278ed69fc2ae72fd23ebd2b3ab1ddb2645767bc2a4a89bdf6bd9a2624904a7a8411598ef4675234fc55
|
7
|
+
data.tar.gz: 6beb9e890aeaf563521d2c341e86eaead15d25939243a2de33aa01ff76ea1c430fb4f7e45b95f27f29a557777f8595f746cb2cbf0fa5cc38a983f9d39c75d908
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,191 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction, and
|
10
|
+
distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by the copyright
|
13
|
+
owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all other entities
|
16
|
+
that control, are controlled by, or are under common control with that entity.
|
17
|
+
For the purposes of this definition, "control" means (i) the power, direct or
|
18
|
+
indirect, to cause the direction or management of such entity, whether by
|
19
|
+
contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
20
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
21
|
+
|
22
|
+
"You" (or "Your") shall mean an individual or Legal Entity exercising
|
23
|
+
permissions granted by this License.
|
24
|
+
|
25
|
+
"Source" form shall mean the preferred form for making modifications, including
|
26
|
+
but not limited to software source code, documentation source, and configuration
|
27
|
+
files.
|
28
|
+
|
29
|
+
"Object" form shall mean any form resulting from mechanical transformation or
|
30
|
+
translation of a Source form, including but not limited to compiled object code,
|
31
|
+
generated documentation, and conversions to other media types.
|
32
|
+
|
33
|
+
"Work" shall mean the work of authorship, whether in Source or Object form, made
|
34
|
+
available under the License, as indicated by a copyright notice that is included
|
35
|
+
in or attached to the work (an example is provided in the Appendix below).
|
36
|
+
|
37
|
+
"Derivative Works" shall mean any work, whether in Source or Object form, that
|
38
|
+
is based on (or derived from) the Work and for which the editorial revisions,
|
39
|
+
annotations, elaborations, or other modifications represent, as a whole, an
|
40
|
+
original work of authorship. For the purposes of this License, Derivative Works
|
41
|
+
shall not include works that remain separable from, or merely link (or bind by
|
42
|
+
name) to the interfaces of, the Work and Derivative Works thereof.
|
43
|
+
|
44
|
+
"Contribution" shall mean any work of authorship, including the original version
|
45
|
+
of the Work and any modifications or additions to that Work or Derivative Works
|
46
|
+
thereof, that is intentionally submitted to Licensor for inclusion in the Work
|
47
|
+
by the copyright owner or by an individual or Legal Entity authorized to submit
|
48
|
+
on behalf of the copyright owner. For the purposes of this definition,
|
49
|
+
"submitted" means any form of electronic, verbal, or written communication sent
|
50
|
+
to the Licensor or its representatives, including but not limited to
|
51
|
+
communication on electronic mailing lists, source code control systems, and
|
52
|
+
issue tracking systems that are managed by, or on behalf of, the Licensor for
|
53
|
+
the purpose of discussing and improving the Work, but excluding communication
|
54
|
+
that is conspicuously marked or otherwise designated in writing by the copyright
|
55
|
+
owner as "Not a Contribution."
|
56
|
+
|
57
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
|
58
|
+
of whom a Contribution has been received by Licensor and subsequently
|
59
|
+
incorporated within the Work.
|
60
|
+
|
61
|
+
2. Grant of Copyright License.
|
62
|
+
|
63
|
+
Subject to the terms and conditions of this License, each Contributor hereby
|
64
|
+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
|
65
|
+
irrevocable copyright license to reproduce, prepare Derivative Works of,
|
66
|
+
publicly display, publicly perform, sublicense, and distribute the Work and such
|
67
|
+
Derivative Works in Source or Object form.
|
68
|
+
|
69
|
+
3. Grant of Patent License.
|
70
|
+
|
71
|
+
Subject to the terms and conditions of this License, each Contributor hereby
|
72
|
+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
|
73
|
+
irrevocable (except as stated in this section) patent license to make, have
|
74
|
+
made, use, offer to sell, sell, import, and otherwise transfer the Work, where
|
75
|
+
such license applies only to those patent claims licensable by such Contributor
|
76
|
+
that are necessarily infringed by their Contribution(s) alone or by combination
|
77
|
+
of their Contribution(s) with the Work to which such Contribution(s) was
|
78
|
+
submitted. If You institute patent litigation against any entity (including a
|
79
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work or a
|
80
|
+
Contribution incorporated within the Work constitutes direct or contributory
|
81
|
+
patent infringement, then any patent licenses granted to You under this License
|
82
|
+
for that Work shall terminate as of the date such litigation is filed.
|
83
|
+
|
84
|
+
4. Redistribution.
|
85
|
+
|
86
|
+
You may reproduce and distribute copies of the Work or Derivative Works thereof
|
87
|
+
in any medium, with or without modifications, and in Source or Object form,
|
88
|
+
provided that You meet the following conditions:
|
89
|
+
|
90
|
+
You must give any other recipients of the Work or Derivative Works a copy of
|
91
|
+
this License; and
|
92
|
+
You must cause any modified files to carry prominent notices stating that You
|
93
|
+
changed the files; and
|
94
|
+
You must retain, in the Source form of any Derivative Works that You distribute,
|
95
|
+
all copyright, patent, trademark, and attribution notices from the Source form
|
96
|
+
of the Work, excluding those notices that do not pertain to any part of the
|
97
|
+
Derivative Works; and
|
98
|
+
If the Work includes a "NOTICE" text file as part of its distribution, then any
|
99
|
+
Derivative Works that You distribute must include a readable copy of the
|
100
|
+
attribution notices contained within such NOTICE file, excluding those notices
|
101
|
+
that do not pertain to any part of the Derivative Works, in at least one of the
|
102
|
+
following places: within a NOTICE text file distributed as part of the
|
103
|
+
Derivative Works; within the Source form or documentation, if provided along
|
104
|
+
with the Derivative Works; or, within a display generated by the Derivative
|
105
|
+
Works, if and wherever such third-party notices normally appear. The contents of
|
106
|
+
the NOTICE file are for informational purposes only and do not modify the
|
107
|
+
License. You may add Your own attribution notices within Derivative Works that
|
108
|
+
You distribute, alongside or as an addendum to the NOTICE text from the Work,
|
109
|
+
provided that such additional attribution notices cannot be construed as
|
110
|
+
modifying the License.
|
111
|
+
You may add Your own copyright statement to Your modifications and may provide
|
112
|
+
additional or different license terms and conditions for use, reproduction, or
|
113
|
+
distribution of Your modifications, or for any such Derivative Works as a whole,
|
114
|
+
provided Your use, reproduction, and distribution of the Work otherwise complies
|
115
|
+
with the conditions stated in this License.
|
116
|
+
|
117
|
+
5. Submission of Contributions.
|
118
|
+
|
119
|
+
Unless You explicitly state otherwise, any Contribution intentionally submitted
|
120
|
+
for inclusion in the Work by You to the Licensor shall be under the terms and
|
121
|
+
conditions of this License, without any additional terms or conditions.
|
122
|
+
Notwithstanding the above, nothing herein shall supersede or modify the terms of
|
123
|
+
any separate license agreement you may have executed with Licensor regarding
|
124
|
+
such Contributions.
|
125
|
+
|
126
|
+
6. Trademarks.
|
127
|
+
|
128
|
+
This License does not grant permission to use the trade names, trademarks,
|
129
|
+
service marks, or product names of the Licensor, except as required for
|
130
|
+
reasonable and customary use in describing the origin of the Work and
|
131
|
+
reproducing the content of the NOTICE file.
|
132
|
+
|
133
|
+
7. Disclaimer of Warranty.
|
134
|
+
|
135
|
+
Unless required by applicable law or agreed to in writing, Licensor provides the
|
136
|
+
Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
|
137
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
|
138
|
+
including, without limitation, any warranties or conditions of TITLE,
|
139
|
+
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
|
140
|
+
solely responsible for determining the appropriateness of using or
|
141
|
+
redistributing the Work and assume any risks associated with Your exercise of
|
142
|
+
permissions under this License.
|
143
|
+
|
144
|
+
8. Limitation of Liability.
|
145
|
+
|
146
|
+
In no event and under no legal theory, whether in tort (including negligence),
|
147
|
+
contract, or otherwise, unless required by applicable law (such as deliberate
|
148
|
+
and grossly negligent acts) or agreed to in writing, shall any Contributor be
|
149
|
+
liable to You for damages, including any direct, indirect, special, incidental,
|
150
|
+
or consequential damages of any character arising as a result of this License or
|
151
|
+
out of the use or inability to use the Work (including but not limited to
|
152
|
+
damages for loss of goodwill, work stoppage, computer failure or malfunction, or
|
153
|
+
any and all other commercial damages or losses), even if such Contributor has
|
154
|
+
been advised of the possibility of such damages.
|
155
|
+
|
156
|
+
9. Accepting Warranty or Additional Liability.
|
157
|
+
|
158
|
+
While redistributing the Work or Derivative Works thereof, You may choose to
|
159
|
+
offer, and charge a fee for, acceptance of support, warranty, indemnity, or
|
160
|
+
other liability obligations and/or rights consistent with this License. However,
|
161
|
+
in accepting such obligations, You may act only on Your own behalf and on Your
|
162
|
+
sole responsibility, not on behalf of any other Contributor, and only if You
|
163
|
+
agree to indemnify, defend, and hold each Contributor harmless for any liability
|
164
|
+
incurred by, or claims asserted against, such Contributor by reason of your
|
165
|
+
accepting any such warranty or additional liability.
|
166
|
+
|
167
|
+
END OF TERMS AND CONDITIONS
|
168
|
+
|
169
|
+
APPENDIX: How to apply the Apache License to your work
|
170
|
+
|
171
|
+
To apply the Apache License to your work, attach the following boilerplate
|
172
|
+
notice, with the fields enclosed by brackets "[]" replaced with your own
|
173
|
+
identifying information. (Don't include the brackets!) The text should be
|
174
|
+
enclosed in the appropriate comment syntax for the file format. We also
|
175
|
+
recommend that a file or class name and description of purpose be included on
|
176
|
+
the same "printed page" as the copyright notice for easier identification within
|
177
|
+
third-party archives.
|
178
|
+
|
179
|
+
Copyright [2013] [Rackpace]
|
180
|
+
|
181
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
182
|
+
you may not use this file except in compliance with the License.
|
183
|
+
You may obtain a copy of the License at
|
184
|
+
|
185
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
186
|
+
|
187
|
+
Unless required by applicable law or agreed to in writing, software
|
188
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
189
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
190
|
+
See the License for the specific language governing permissions and
|
191
|
+
limitations under the License.
|
data/MessageBuilder.md
ADDED
@@ -0,0 +1,85 @@
|
|
1
|
+
Mailgun - Messages
|
2
|
+
====================
|
3
|
+
|
4
|
+
This is the Mailgun Ruby *Message* utilities.
|
5
|
+
|
6
|
+
The below assumes you've already installed the Mailgun Gem. If not, go back to the master README for instructions.
|
7
|
+
|
8
|
+
There are two utilities included, Message Builder and Batch Message.
|
9
|
+
|
10
|
+
Message Builder: Allows you to build a message object by calling methods for
|
11
|
+
each attribute.
|
12
|
+
Batch Message: Inherits Message Builder and allows you to iterate through
|
13
|
+
recipients from a list. Messages will fire after the 1,000th recipient has been
|
14
|
+
added.
|
15
|
+
|
16
|
+
Usage - Message Builder
|
17
|
+
-----------------------
|
18
|
+
Here's how to use Message Builder to build your Message.
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
# First, instantiate the Mailgun Client with your API key
|
22
|
+
mg_client = Mailgun::Client.new("your-api-key")
|
23
|
+
mb_obj = Mailgun::MessageBuilder.new()
|
24
|
+
|
25
|
+
# Define the from address.
|
26
|
+
mb_obj.set_from_address("me@example.com", {"first"=>"Ruby", "last" => "SDK"});
|
27
|
+
# Define a to recipient.
|
28
|
+
mb_obj.add_recipient(:to, "john.doe@example.com", {"first" => "John", "last" => "Doe"});
|
29
|
+
# Define a cc recipient.
|
30
|
+
mb_obj.add_recipient(:cc, "sally.doe@example.com", {"first" => "Sally", "last" => "Doe"});
|
31
|
+
# Define the subject.
|
32
|
+
mb_obj.set_subject("A message from the Ruby SDK using Message Builder!");
|
33
|
+
# Define the body of the message.
|
34
|
+
mb_obj.set_text_body("This is the text body of the message!");
|
35
|
+
|
36
|
+
# Campaign and other headers.
|
37
|
+
mb_obj.add_campaign_id("My-Awesome-Campaign");
|
38
|
+
mb_obj.add_custom_parameter("h:Customer-Id", "12345");
|
39
|
+
|
40
|
+
# Attach a file and rename it.
|
41
|
+
mb_obj.add_attachment("/path/to/file/receipt_123491820.pdf", "Receipt.pdf");
|
42
|
+
|
43
|
+
# Schedule message in the future
|
44
|
+
mb_obj.set_delivery_time("tomorrow 8:00AM", "PST");
|
45
|
+
|
46
|
+
# Finally, send your message using the client
|
47
|
+
result = mg_client.send_message("sending_domain.com", mb_obj)
|
48
|
+
|
49
|
+
puts result.body.to_s
|
50
|
+
```
|
51
|
+
|
52
|
+
Usage - Batch Message
|
53
|
+
---------------------
|
54
|
+
Here's how to use Batch Message to easily handle batch sending jobs.
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
# First, instantiate the Mailgun Client with your API key
|
58
|
+
mg_client = Mailgun::Client.new("your-api-key")
|
59
|
+
# Create a Batch Message object, pass in the client and your domain.
|
60
|
+
mb_obj = Mailgun::BatchMessage.new(@mb_client, "example.com")
|
61
|
+
|
62
|
+
# Define the from address.
|
63
|
+
mb_obj.set_from_address("me@example.com", {"first"=>"Ruby", "last" => "SDK"});
|
64
|
+
# Define the subject.
|
65
|
+
mb_obj.set_subject("A message from the Ruby SDK using Message Builder!");
|
66
|
+
# Define the body of the message.
|
67
|
+
mb_obj.set_text_body("This is the text body of the message!");
|
68
|
+
|
69
|
+
|
70
|
+
# Loop through all of your recipients
|
71
|
+
mb_obj.add_recipient(:to, "john.doe@example.com", {"first" => "John", "last" => "Doe"});
|
72
|
+
mb_obj.add_recipient(:to, "jane.doe@example.com", {"first" => "Jane", "last" => "Doe"});
|
73
|
+
mb_obj.add_recipient(:to, "bob.doe@example.com", {"first" => "Bob", "last" => "Doe"});
|
74
|
+
...
|
75
|
+
mb_obj.add_recipient(:to, "sally.doe@example.com", {"first" => "Sally", "last" => "Doe"});
|
76
|
+
|
77
|
+
# Call finalize to get a list of message ids and totals.
|
78
|
+
message_ids = mg_client.finalize
|
79
|
+
# {'id1234@example.com' => 1000, 'id5678@example.com' => 15}
|
80
|
+
```
|
81
|
+
|
82
|
+
More Documentation
|
83
|
+
------------------
|
84
|
+
See the official [Mailgun Docs](http://documentation.mailgun.com/api-sending.html)
|
85
|
+
for more information.
|
data/Messages.md
ADDED
@@ -0,0 +1,77 @@
|
|
1
|
+
Mailgun - Messages
|
2
|
+
====================
|
3
|
+
|
4
|
+
This is the Mailgun Ruby *Message* utilities.
|
5
|
+
|
6
|
+
The below assumes you've already installed the Mailgun Ruby SDK in to your
|
7
|
+
project. If not, go back to the master README for instructions.
|
8
|
+
|
9
|
+
There are two utilities included, Message Builder and Batch Message.
|
10
|
+
|
11
|
+
Message Builder: Allows you to build a message object by calling methods for
|
12
|
+
each MIME attribute.
|
13
|
+
Batch Message: Inherits Message Builder and allows you to iterate through
|
14
|
+
recipients from a list. Messages will fire after the 1,000th recipient has been
|
15
|
+
added.
|
16
|
+
|
17
|
+
Usage - Message Builder
|
18
|
+
-----------------------
|
19
|
+
Here's how to use Message Builder to build your Message.
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
# First, instantiate the Mailgun Client with your API key
|
23
|
+
mg_client = Mailgun::Client.new("your-api-key")
|
24
|
+
mb_obj = Mailgun::BatchMessage.new(@mb_client, "example.com")
|
25
|
+
|
26
|
+
# Define the from address.
|
27
|
+
mb_obj.set_from_address("me@example.com", {"first"=>"Ruby", "last" => "SDK"});
|
28
|
+
# Define a to recipient.
|
29
|
+
mb_obj.add_recipient(:to, "john.doe@example.com", {"first" => "John", "last" => "Doe"});
|
30
|
+
# Define a cc recipient.
|
31
|
+
mb_obj.add_recipient(:cc, "sally.doe@example.com", {"first" => "Sally", "last" => "Doe"});
|
32
|
+
# Define the subject.
|
33
|
+
mb_obj.set_subject("A message from the Ruby SDK using Message Builder!");
|
34
|
+
# Define the body of the message.
|
35
|
+
mb_obj.set_text_body("This is the text body of the message!");
|
36
|
+
|
37
|
+
# Other Optional Parameters.
|
38
|
+
mb_obj.add_campaign_id("My-Awesome-Campaign");
|
39
|
+
mb_obj.add_custom_parameter("h:Customer-Id", "12345");
|
40
|
+
mb_obj.add_attachment("@/tron.jpg");
|
41
|
+
mb_obj.set_delivery_time("tomorrow 8:00AM", "PST");
|
42
|
+
mb_obj.set_click_tracking(true);
|
43
|
+
|
44
|
+
# Send your message through the client
|
45
|
+
mg_client.send_message("sending_domain.com", mb_obj)
|
46
|
+
```
|
47
|
+
|
48
|
+
Usage - Batch Message
|
49
|
+
---------------------
|
50
|
+
Here's how to use Batch Message to easily handle batch sending jobs.
|
51
|
+
|
52
|
+
```ruby
|
53
|
+
# First, instantiate the Mailgun Client with your API key
|
54
|
+
mg_client = Mailgun::Client.new("your-api-key")
|
55
|
+
mb_obj = Mailgun::BatchMessage.new(@mb_client, "example.com")
|
56
|
+
|
57
|
+
# Define the from address.
|
58
|
+
mb_obj.set_from_address("me@example.com", {"first"=>"Ruby", "last" => "SDK"});
|
59
|
+
# Define the subject.
|
60
|
+
mb_obj.set_subject("A message from the Ruby SDK using Message Builder!");
|
61
|
+
# Define the body of the message.
|
62
|
+
mb_obj.set_text_body("This is the text body of the message!");
|
63
|
+
|
64
|
+
mb_obj.add_recipient(:to, "john.doe@example.com", {"first" => "John", "last" => "Doe"});
|
65
|
+
mb_obj.add_recipient(:to, "jane.doe@example.com", {"first" => "Jane", "last" => "Doe"});
|
66
|
+
mb_obj.add_recipient(:to, "bob.doe@example.com", {"first" => "Bob", "last" => "Doe"});
|
67
|
+
...
|
68
|
+
mb_obj.add_recipient(:to, "sally.doe@example.com", {"first" => "Sally", "last" => "Doe"});
|
69
|
+
|
70
|
+
# Send your message through the client
|
71
|
+
message_ids = mg_client.finalize
|
72
|
+
```
|
73
|
+
|
74
|
+
More Documentation
|
75
|
+
------------------
|
76
|
+
See the official [Mailgun Docs](http://documentation.mailgun.com/api-sending.html)
|
77
|
+
for more information.
|
data/OptInHandler.md
ADDED
@@ -0,0 +1,103 @@
|
|
1
|
+
Mailgun - Lists
|
2
|
+
====================
|
3
|
+
|
4
|
+
This is the Mailgun Ruby *Lists* utilities.
|
5
|
+
|
6
|
+
The below assumes you've already installed the Mailgun Ruby SDK in your project.
|
7
|
+
If not, go back to the master README for a few quick install steps.
|
8
|
+
|
9
|
+
OptInHandler: Provides methods for authenticating an Opt-In Request.
|
10
|
+
|
11
|
+
The typical flow for using this utility would be as follows:
|
12
|
+
**Recipient Requests Subscribe** -> [Validate Recipient Address] -> [Generate Opt-In Link] -> [Email Recipient Opt-In Link]
|
13
|
+
**Recipient Clicks Opt-In Link** -> [Validate Opt-In Link] -> [Subscribe User] -> [Send final confirmation]
|
14
|
+
|
15
|
+
The above flow is modeled below.
|
16
|
+
|
17
|
+
Usage - Opt-In Handler (Recipient Requests Subscribe)
|
18
|
+
-----------------------------------------------------
|
19
|
+
Here's how to use Opt-In Handler to validate Opt-In requests.
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
# First, instantiate the SDK with your API credentials, domain, and required parameters for example.
|
23
|
+
mg_client = Mailgun::Client.new("your-api-key")
|
24
|
+
mg_validate = Mailgun::Client.new("your-pub-api-key")
|
25
|
+
|
26
|
+
domain = 'example.com';
|
27
|
+
|
28
|
+
mailing_list = 'youlist@example.com';
|
29
|
+
secret_app_id = 'a_secret_passphrase';
|
30
|
+
recipient_address = 'recipient@example.com';
|
31
|
+
|
32
|
+
# Let's validate the customer's email address, using Mailgun's validation endpoint.
|
33
|
+
result = mg_validate.get('address/validate', {:address => recipient_address});
|
34
|
+
|
35
|
+
if result[:body]["is_valid"] == true
|
36
|
+
# Next, generate a hash.
|
37
|
+
generated_hash = Mailgun::OptInHandler.generate_hash(mailing_list, secret_app_id, recipient_address);
|
38
|
+
|
39
|
+
# Now, let's send a confirmation to the recipient with our link.
|
40
|
+
mg_client.send_message(domain, {:from => 'bob@example.com',
|
41
|
+
:to => recipient_address,
|
42
|
+
:subject => 'Please Confirm!',
|
43
|
+
:html => "<html><body>Hello,<br><br>You have requested to be subscribed
|
44
|
+
to the mailing list #{mailing_list}. Please <a
|
45
|
+
href=\"http://yourdomain.com/subscribe.php?hash=#{generated_hash}\">
|
46
|
+
confirm</a> your subscription.<br><br>Thank you!</body></html>"});
|
47
|
+
|
48
|
+
# Finally, let's add the subscriber to a Mailing List, as unsubscribed, so we can track non-conversions.
|
49
|
+
mg_client.post("lists/#{mailing_list}/members", {:address => recipient_address,
|
50
|
+
:subscribed => 'no',
|
51
|
+
:upsert => 'yes'});
|
52
|
+
end
|
53
|
+
```
|
54
|
+
|
55
|
+
Usage - Opt-In Handler (Recipient Clicks Opt In Link)
|
56
|
+
-----------------------------------------------------
|
57
|
+
Here's how to use Opt-In Handler to validate an Opt-In Hash.
|
58
|
+
|
59
|
+
```ruby
|
60
|
+
# First, instantiate the SDK with your API credentials and domain.
|
61
|
+
mg_client = Mailgun::Client.new("your-api-key")
|
62
|
+
domain = 'example.com';
|
63
|
+
|
64
|
+
# Now, validate the captured hash.
|
65
|
+
hash_validation = Mailgun::OptInHandler.validate_hash(secret_app_id, inbound_hash);
|
66
|
+
|
67
|
+
# Lastly, check to see if we have results, parse, subscribe, and send confirmation.
|
68
|
+
if !hash_validation.nil?
|
69
|
+
validated_list = hash_validation['mailing_list'];
|
70
|
+
validated_recipient = hash_validation['recipient_address'];
|
71
|
+
|
72
|
+
mg_client.put("lists/#{validated_list}/members/#{validated_recipient}",
|
73
|
+
{:address => validated_recipient,
|
74
|
+
:subscribed => 'yes'})
|
75
|
+
|
76
|
+
mg_client.send_message(domain, {:from => 'bob@example.com',
|
77
|
+
:to => validated_recipient,
|
78
|
+
:subject => 'Confirmation Received!',
|
79
|
+
:html => "<html><body>Hello,<br><br>We've successfully subscribed you to the list, #{validated_list}!<br><br>Thank you!
|
80
|
+
</body></html>"));
|
81
|
+
end
|
82
|
+
```
|
83
|
+
|
84
|
+
A few notes:
|
85
|
+
1. 'secret_app_id' can be anything. It's used as the *key* in hashing,
|
86
|
+
since your email address will vary. It should be secured like a password.
|
87
|
+
2. validateHash will return an array containing the recipient address and list
|
88
|
+
address.
|
89
|
+
3. You should *always* send an email confirmation before and after the
|
90
|
+
subscription request. This is what double-opt in means.
|
91
|
+
|
92
|
+
|
93
|
+
Available Functions
|
94
|
+
-----------------------------------------------------
|
95
|
+
|
96
|
+
`string generate_hash(string mailing_list, string secret_app_id, string recipient_address)`
|
97
|
+
|
98
|
+
`array validate_hash(string secret_app_id, string unique_hash)`
|
99
|
+
|
100
|
+
More Documentation
|
101
|
+
------------------
|
102
|
+
See the official [Mailgun Docs](http://documentation.mailgun.com/api-sending.html)
|
103
|
+
for more information.
|