emarsys-broadcast 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.md +12 -9
- data/emarsys-broadcast.gemspec +1 -1
- data/lib/emarsys/broadcast/version.rb +1 -1
- metadata +6 -6
data/README.md
CHANGED
@@ -79,7 +79,9 @@ Valid email, registed with Emarsys.
|
|
79
79
|
|
80
80
|
Emarsys maintains a list of allowed sender emails, and restricts
|
81
81
|
sending emails from arbitrary email. If you want to use an email as a
|
82
|
-
sender, refer to
|
82
|
+
sender, refer to (working with senders)[#working-with-senders]
|
83
|
+
|
84
|
+
_Can be set once via configuration_
|
83
85
|
|
84
86
|
#### Batch#body_html
|
85
87
|
|
@@ -116,6 +118,8 @@ it will be scheduled for immediate sending.
|
|
116
118
|
|
117
119
|
Time in hours which is allowed for import to be delayed after batch import. Defaults to 1 hour.
|
118
120
|
|
121
|
+
_Can be set once via configuration_
|
122
|
+
|
119
123
|
|
120
124
|
### Moving batch properties to configuration
|
121
125
|
|
@@ -148,13 +152,12 @@ batch.body_html = '<h1>Dear 朋友!</h1>'
|
|
148
152
|
* sender (required attribute)
|
149
153
|
* sender_domain (required attribute)
|
150
154
|
* recipients_path (required attribute)
|
151
|
-
* import_delay_hours (optional attribute) see more [here](#)
|
152
|
-
|
155
|
+
* import_delay_hours (optional attribute) see more [here](#batchimport-delay-hours)
|
153
156
|
|
154
157
|
|
155
158
|
### Batch validation
|
156
159
|
|
157
|
-
Emarsys::Broadcast uses ActiveModel for validating plain ruby objects, so you have all the methods for
|
160
|
+
`Emarsys::Broadcast` uses `ActiveModel` for validating plain ruby objects, so you have all the methods for
|
158
161
|
validation you're accustomed to:
|
159
162
|
|
160
163
|
```ruby
|
@@ -168,7 +171,7 @@ batch.errors.full_messages
|
|
168
171
|
|
169
172
|
You can always validate your batch before submitting it.
|
170
173
|
|
171
|
-
Note that calling
|
174
|
+
Note that calling `API#send_batch` on an invalid batch will throw `ValidationException`
|
172
175
|
|
173
176
|
```ruby
|
174
177
|
batch = get_invalid_batch
|
@@ -185,7 +188,7 @@ end
|
|
185
188
|
|
186
189
|
### Scheduling batches
|
187
190
|
|
188
|
-
By default a new batch is scheduled for immediate sending, but you can set the `send_time`
|
191
|
+
By default a new batch is scheduled for immediate sending, but you can set the `Batch#send_time`
|
189
192
|
|
190
193
|
```ruby
|
191
194
|
# Assuming using ActiveSupport and want to schedule a batch to be sent in 10 days
|
@@ -227,7 +230,7 @@ Having additional columns allows you to customize your body_html, for example:
|
|
227
230
|
|
228
231
|
#### Adding a new sender
|
229
232
|
|
230
|
-
Adding a sender is required before you can start using its email address as a Batch#sender
|
233
|
+
Adding a sender is required before you can start using its email address as a `Batch#sender`
|
231
234
|
|
232
235
|
```ruby
|
233
236
|
# assuming you have API configured already
|
@@ -237,7 +240,7 @@ sender = Emarsys::Broadcast::Sender.new('primary_newsletter_sender', 'My company
|
|
237
240
|
api.create_sender sender
|
238
241
|
```
|
239
242
|
|
240
|
-
Once you
|
243
|
+
Once you add a sender, you can use its email in any batch:
|
241
244
|
|
242
245
|
```ruby
|
243
246
|
batch.sender = 'news@company.com'
|
@@ -248,7 +251,7 @@ batch.sender = 'news@company.com'
|
|
248
251
|
|
249
252
|
```ruby
|
250
253
|
api.get_senders
|
251
|
-
# returns Sender
|
254
|
+
# returns array of `Emarsys::Broadcast::Sender`
|
252
255
|
```
|
253
256
|
|
254
257
|
#### Getting a single sender by email
|
data/emarsys-broadcast.gemspec
CHANGED
@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
|
|
19
19
|
spec.require_paths = ["lib"]
|
20
20
|
|
21
21
|
spec.add_dependency "net-sftp"
|
22
|
-
spec.add_dependency "nokogiri"
|
22
|
+
spec.add_dependency "nokogiri"
|
23
23
|
spec.add_dependency "activemodel", "~> 3.0"
|
24
24
|
|
25
25
|
spec.add_development_dependency "bundler", "~> 1.3"
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: emarsys-broadcast
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.2
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -9,7 +9,7 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2013-04-
|
12
|
+
date: 2013-04-12 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: net-sftp
|
@@ -32,17 +32,17 @@ dependencies:
|
|
32
32
|
requirement: !ruby/object:Gem::Requirement
|
33
33
|
none: false
|
34
34
|
requirements:
|
35
|
-
- - '
|
35
|
+
- - ! '>='
|
36
36
|
- !ruby/object:Gem::Version
|
37
|
-
version:
|
37
|
+
version: '0'
|
38
38
|
type: :runtime
|
39
39
|
prerelease: false
|
40
40
|
version_requirements: !ruby/object:Gem::Requirement
|
41
41
|
none: false
|
42
42
|
requirements:
|
43
|
-
- - '
|
43
|
+
- - ! '>='
|
44
44
|
- !ruby/object:Gem::Version
|
45
|
-
version:
|
45
|
+
version: '0'
|
46
46
|
- !ruby/object:Gem::Dependency
|
47
47
|
name: activemodel
|
48
48
|
requirement: !ruby/object:Gem::Requirement
|