gandi_v5 0.2.0 → 0.3.0

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.
Files changed (121) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/.rubocop.yml +1 -1
  4. data/.travis.yml +9 -0
  5. data/CHANGELOG.md +15 -0
  6. data/FUNDING.yml +10 -0
  7. data/README.md +7 -17
  8. data/gandi_v5.gemspec +3 -2
  9. data/lib/gandi_v5.rb +24 -10
  10. data/lib/gandi_v5/billing.rb +0 -2
  11. data/lib/gandi_v5/billing/info.rb +0 -2
  12. data/lib/gandi_v5/data.rb +0 -2
  13. data/lib/gandi_v5/data/converter.rb +0 -4
  14. data/lib/gandi_v5/domain.rb +159 -17
  15. data/lib/gandi_v5/domain/availability.rb +0 -3
  16. data/lib/gandi_v5/domain/availability/product.rb +0 -3
  17. data/lib/gandi_v5/domain/live_dns.rb +42 -0
  18. data/lib/gandi_v5/domain/renewal_information.rb +0 -3
  19. data/lib/gandi_v5/email.rb +0 -4
  20. data/lib/gandi_v5/email/forward.rb +108 -0
  21. data/lib/gandi_v5/email/mailbox.rb +0 -2
  22. data/lib/gandi_v5/error.rb +0 -2
  23. data/lib/gandi_v5/live_dns.rb +0 -4
  24. data/lib/gandi_v5/live_dns/domain.rb +1 -144
  25. data/lib/gandi_v5/live_dns/has_zone_records.rb +153 -0
  26. data/lib/gandi_v5/live_dns/zone.rb +1 -146
  27. data/lib/gandi_v5/organization.rb +28 -5
  28. data/lib/gandi_v5/version.rb +1 -1
  29. data/spec/.rubocop.yml +1 -1
  30. data/spec/features/domain_spec.rb +1 -1
  31. data/spec/fixtures/bodies/GandiV5_Billing/{info.yaml → info.yml} +0 -0
  32. data/spec/fixtures/bodies/GandiV5_Domain/{get.yaml → fetch.yml} +0 -0
  33. data/spec/fixtures/bodies/GandiV5_Domain/{fetch_contacts.yaml → fetch_contacts.yml} +0 -0
  34. data/spec/fixtures/bodies/GandiV5_Domain/fetch_glue_records.yml +7 -0
  35. data/spec/fixtures/bodies/GandiV5_Domain/fetch_livedns.yml +6 -0
  36. data/spec/fixtures/bodies/GandiV5_Domain/fetch_name_servers.yml +2 -0
  37. data/spec/fixtures/bodies/GandiV5_Domain/{renewal_info.yaml → fetch_renewal_info.yml} +0 -3
  38. data/spec/fixtures/bodies/GandiV5_Domain/{restore_info.yaml → fetch_restore_info.yml} +0 -0
  39. data/spec/fixtures/bodies/GandiV5_Domain/{list.yaml → list.yml} +1 -0
  40. data/spec/fixtures/bodies/GandiV5_Domain_Availability/{fetch.yaml → fetch.yml} +0 -0
  41. data/spec/fixtures/bodies/GandiV5_Domain_TLD/{fetch.yaml → fetch.yml} +0 -0
  42. data/spec/fixtures/bodies/GandiV5_Domain_TLD/{list.yaml → list.yml} +0 -0
  43. data/spec/fixtures/bodies/GandiV5_Email_Forward/list.yml +6 -0
  44. data/spec/fixtures/bodies/GandiV5_Email_Mailbox/{get.yaml → fetch.yml} +0 -0
  45. data/spec/fixtures/bodies/GandiV5_Email_Mailbox/{list.yaml → list.yml} +0 -0
  46. data/spec/fixtures/bodies/GandiV5_Email_Slot/{get.yaml → fetch.yml} +0 -0
  47. data/spec/fixtures/bodies/GandiV5_Email_Slot/{list.yaml → list.yml} +0 -0
  48. data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/{get.yaml → fetch.yml} +0 -0
  49. data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/{list.yaml → list.yml} +0 -0
  50. data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone/{get.yaml → fetch.yml} +0 -0
  51. data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone/{list.yaml → list.yml} +0 -0
  52. data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone_Snapshot/{fetch.yaml → fetch.yml} +0 -0
  53. data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone_Snapshot/{list.yaml → list.yml} +0 -0
  54. data/spec/fixtures/bodies/GandiV5_Organization/{get.yaml → fetch.yml} +0 -0
  55. data/spec/fixtures/bodies/GandiV5_Organization/list.yml +7 -0
  56. data/spec/fixtures/vcr/Domain_features/List_domains.yml +2 -1
  57. data/spec/spec_helper.rb +2 -2
  58. data/spec/units/gandi_v5/billing_spec.rb +2 -2
  59. data/spec/units/gandi_v5/domain/availability_spec.rb +1 -1
  60. data/spec/units/gandi_v5/domain/live_dns_spec.rb +45 -0
  61. data/spec/units/gandi_v5/domain/tld_spec.rb +2 -2
  62. data/spec/units/gandi_v5/domain_spec.rb +241 -22
  63. data/spec/units/gandi_v5/email/forward_spec.rb +121 -0
  64. data/spec/units/gandi_v5/email/mailbox_spec.rb +3 -3
  65. data/spec/units/gandi_v5/email/slot_spec.rb +3 -3
  66. data/spec/units/gandi_v5/live_dns/domain_spec.rb +3 -3
  67. data/spec/units/gandi_v5/live_dns/zone/snapshot_spec.rb +2 -2
  68. data/spec/units/gandi_v5/live_dns/zone_spec.rb +2 -2
  69. data/spec/units/gandi_v5/organization_spec.rb +38 -1
  70. metadata +51 -77
  71. data/doc/GandiV5.html +0 -1183
  72. data/doc/GandiV5/Billing.html +0 -293
  73. data/doc/GandiV5/Billing/Info.html +0 -641
  74. data/doc/GandiV5/Billing/Info/Prepaid.html +0 -817
  75. data/doc/GandiV5/Data.html +0 -785
  76. data/doc/GandiV5/Data/ClassMethods.html +0 -223
  77. data/doc/GandiV5/Data/Converter.html +0 -433
  78. data/doc/GandiV5/Data/Converter/ArrayOf.html +0 -413
  79. data/doc/GandiV5/Data/Converter/Symbol.html +0 -322
  80. data/doc/GandiV5/Data/Converter/Time.html +0 -330
  81. data/doc/GandiV5/Domain.html +0 -16847
  82. data/doc/GandiV5/Domain/AutoRenew.html +0 -1237
  83. data/doc/GandiV5/Domain/Availability.html +0 -1020
  84. data/doc/GandiV5/Domain/Availability/Product.html +0 -988
  85. data/doc/GandiV5/Domain/Availability/Product/Period.html +0 -220
  86. data/doc/GandiV5/Domain/Availability/Product/Price.html +0 -1031
  87. data/doc/GandiV5/Domain/Availability/Tax.html +0 -440
  88. data/doc/GandiV5/Domain/Contact.html +0 -4459
  89. data/doc/GandiV5/Domain/Contract.html +0 -520
  90. data/doc/GandiV5/Domain/Dates.html +0 -1313
  91. data/doc/GandiV5/Domain/RenewalInformation.html +0 -1147
  92. data/doc/GandiV5/Domain/RestoreInformation.html +0 -339
  93. data/doc/GandiV5/Domain/SharingSpace.html +0 -437
  94. data/doc/GandiV5/Domain/TLD.html +0 -1565
  95. data/doc/GandiV5/Email.html +0 -144
  96. data/doc/GandiV5/Email/Mailbox.html +0 -6307
  97. data/doc/GandiV5/Email/Mailbox/Responder.html +0 -1560
  98. data/doc/GandiV5/Email/Offer.html +0 -514
  99. data/doc/GandiV5/Email/Slot.html +0 -4244
  100. data/doc/GandiV5/Error.html +0 -151
  101. data/doc/GandiV5/Error/GandiError.html +0 -270
  102. data/doc/GandiV5/LiveDNS.html +0 -300
  103. data/doc/GandiV5/LiveDNS/Domain.html +0 -2984
  104. data/doc/GandiV5/LiveDNS/RecordSet.html +0 -1593
  105. data/doc/GandiV5/LiveDNS/Zone.html +0 -8891
  106. data/doc/GandiV5/LiveDNS/Zone/Snapshot.html +0 -1556
  107. data/doc/GandiV5/Organization.html +0 -2341
  108. data/doc/_index.html +0 -474
  109. data/doc/class_list.html +0 -51
  110. data/doc/css/common.css +0 -1
  111. data/doc/css/full_list.css +0 -58
  112. data/doc/css/style.css +0 -496
  113. data/doc/file.README.html +0 -175
  114. data/doc/file_list.html +0 -56
  115. data/doc/frames.html +0 -17
  116. data/doc/index.html +0 -175
  117. data/doc/js/app.js +0 -303
  118. data/doc/js/full_list.js +0 -216
  119. data/doc/js/jquery.js +0 -4
  120. data/doc/method_list.html +0 -2427
  121. data/doc/top-level-namespace.html +0 -110
@@ -1,1560 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8">
5
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <title>
7
- Class: GandiV5::Email::Mailbox::Responder
8
-
9
- &mdash; Documentation by YARD 0.9.19
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
14
-
15
- <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
16
-
17
- <script type="text/javascript" charset="utf-8">
18
- pathId = "GandiV5::Email::Mailbox::Responder";
19
- relpath = '../../../';
20
- </script>
21
-
22
-
23
- <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
24
-
25
- <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div class="nav_wrap">
31
- <iframe id="nav" src="../../../class_list.html?1"></iframe>
32
- <div id="resizer"></div>
33
- </div>
34
-
35
- <div id="main" tabindex="-1">
36
- <div id="header">
37
- <div id="menu">
38
-
39
- <a href="../../../_index.html">Index (R)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Email.html" title="GandiV5::Email (class)">Email</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Mailbox.html" title="GandiV5::Email::Mailbox (class)">Mailbox</a></span></span>
41
- &raquo;
42
- <span class="title">Responder</span>
43
-
44
- </div>
45
-
46
- <div id="search">
47
-
48
- <a class="full_list_link" id="class_list_link"
49
- href="../../../class_list.html">
50
-
51
- <svg width="24" height="24">
52
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
- </svg>
56
- </a>
57
-
58
- </div>
59
- <div class="clear"></div>
60
- </div>
61
-
62
- <div id="content"><h1>Class: GandiV5::Email::Mailbox::Responder
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
- <dl>
70
- <dt>Inherits:</dt>
71
- <dd>
72
- <span class="inheritName">Object</span>
73
-
74
- <ul class="fullTree">
75
- <li>Object</li>
76
-
77
- <li class="next">GandiV5::Email::Mailbox::Responder</li>
78
-
79
- </ul>
80
- <a href="#" class="inheritanceTree">show all</a>
81
-
82
- </dd>
83
- </dl>
84
-
85
-
86
-
87
-
88
-
89
-
90
- <dl>
91
- <dt>Includes:</dt>
92
- <dd><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></dd>
93
- </dl>
94
-
95
-
96
-
97
-
98
-
99
-
100
- <dl>
101
- <dt>Defined in:</dt>
102
- <dd>lib/gandi_v5/email/mailbox/responder.rb</dd>
103
- </dl>
104
-
105
- </div>
106
-
107
- <h2>Overview</h2><div class="docstring">
108
- <div class="discussion">
109
-
110
- <p>Status of a mailbox&#39;s auto responder.</p>
111
-
112
-
113
- </div>
114
- </div>
115
- <div class="tags">
116
-
117
-
118
- <p class="tag_title">See Also:</p>
119
- <ul class="see">
120
-
121
- <li><a href="https://api.gandi.net/docs/email#get-v5-email-mailboxes-domain-mailbox_id" target="_parent" title="https://api.gandi.net/docs/email#get-v5-email-mailboxes-domain-mailbox_id">https://api.gandi.net/docs/email#get-v5-email-mailboxes-domain-mailbox_id</a></li>
122
-
123
- </ul>
124
-
125
- </div>
126
-
127
-
128
-
129
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
130
- <ul class="summary">
131
-
132
- <li class="public ">
133
- <span class="summary_signature">
134
-
135
- <a href="#enabled-instance_method" title="#enabled (instance method)">#<strong>enabled</strong> &#x21d2; Boolean </a>
136
-
137
-
138
-
139
- </span>
140
-
141
-
142
-
143
-
144
- <span class="note title readonly">readonly</span>
145
-
146
-
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
- <span class="summary_desc"><div class='inline'></div></span>
155
-
156
- </li>
157
-
158
-
159
- <li class="public ">
160
- <span class="summary_signature">
161
-
162
- <a href="#ends_at-instance_method" title="#ends_at (instance method)">#<strong>ends_at</strong> &#x21d2; nil, Time </a>
163
-
164
-
165
-
166
- </span>
167
-
168
-
169
-
170
-
171
- <span class="note title readonly">readonly</span>
172
-
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
-
181
- <span class="summary_desc"><div class='inline'></div></span>
182
-
183
- </li>
184
-
185
-
186
- <li class="public ">
187
- <span class="summary_signature">
188
-
189
- <a href="#mailbox-instance_method" title="#mailbox (instance method)">#<strong>mailbox</strong> &#x21d2; GandiV5::Email::Mailbox </a>
190
-
191
-
192
-
193
- </span>
194
-
195
-
196
-
197
-
198
- <span class="note title readonly">readonly</span>
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
- <span class="summary_desc"><div class='inline'>
209
- <p>The mailbox this repsonder belongs to.</p>
210
- </div></span>
211
-
212
- </li>
213
-
214
-
215
- <li class="public ">
216
- <span class="summary_signature">
217
-
218
- <a href="#message-instance_method" title="#message (instance method)">#<strong>message</strong> &#x21d2; nil, String </a>
219
-
220
-
221
-
222
- </span>
223
-
224
-
225
-
226
-
227
- <span class="note title readonly">readonly</span>
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
-
236
-
237
- <span class="summary_desc"><div class='inline'></div></span>
238
-
239
- </li>
240
-
241
-
242
- <li class="public ">
243
- <span class="summary_signature">
244
-
245
- <a href="#starts_at-instance_method" title="#starts_at (instance method)">#<strong>starts_at</strong> &#x21d2; nil, Time </a>
246
-
247
-
248
-
249
- </span>
250
-
251
-
252
-
253
-
254
- <span class="note title readonly">readonly</span>
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
- <span class="summary_desc"><div class='inline'></div></span>
265
-
266
- </li>
267
-
268
-
269
- </ul>
270
-
271
-
272
-
273
-
274
-
275
- <h2>
276
- Instance Method Summary
277
- <small><a href="#" class="summary_toggle">collapse</a></small>
278
- </h2>
279
-
280
- <ul class="summary">
281
-
282
- <li class="public ">
283
- <span class="summary_signature">
284
-
285
- <a href="#active%3F-instance_method" title="#active? (instance method)">#<strong>active?</strong> &#x21d2; Boolean </a>
286
-
287
-
288
-
289
- </span>
290
-
291
-
292
-
293
-
294
-
295
-
296
-
297
-
298
-
299
- <span class="summary_desc"><div class='inline'>
300
- <p>Check if this responder is currently active.</p>
301
- </div></span>
302
-
303
- </li>
304
-
305
-
306
- <li class="public ">
307
- <span class="summary_signature">
308
-
309
- <a href="#disable-instance_method" title="#disable (instance method)">#<strong>disable</strong> &#x21d2; Object </a>
310
-
311
-
312
-
313
- </span>
314
-
315
-
316
-
317
-
318
-
319
-
320
-
321
-
322
-
323
- <span class="summary_desc"><div class='inline'>
324
- <p>Disable the auto responder in Gandi.</p>
325
- </div></span>
326
-
327
- </li>
328
-
329
-
330
- <li class="public ">
331
- <span class="summary_signature">
332
-
333
- <a href="#enable-instance_method" title="#enable (instance method)">#<strong>enable</strong>(message:, ends_at:, starts_at: Time.now) &#x21d2; Object </a>
334
-
335
-
336
-
337
- </span>
338
-
339
-
340
-
341
-
342
-
343
-
344
-
345
-
346
-
347
- <span class="summary_desc"><div class='inline'>
348
- <p>Enable the auto responder in Gandi.</p>
349
- </div></span>
350
-
351
- </li>
352
-
353
-
354
- <li class="public ">
355
- <span class="summary_signature">
356
-
357
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(mailbox: nil, **members) &#x21d2; GandiV5::Email::Slot </a>
358
-
359
-
360
-
361
- </span>
362
-
363
-
364
- <span class="note title constructor">constructor</span>
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
-
373
- <span class="summary_desc"><div class='inline'>
374
- <p>Create a new GandiV5::Email::Mailbox::Responder.</p>
375
- </div></span>
376
-
377
- </li>
378
-
379
-
380
- </ul>
381
-
382
-
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
-
392
- <h3 class="inherited">Methods included from <span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></h3>
393
- <p class="inherited"><span class='object_link'><a href="../../Data.html#from_gandi-instance_method" title="GandiV5::Data#from_gandi (method)">#from_gandi</a></span>, <span class='object_link'><a href="../../Data.html#included-class_method" title="GandiV5::Data.included (method)">included</a></span>, <span class='object_link'><a href="../../Data.html#to_gandi-instance_method" title="GandiV5::Data#to_gandi (method)">#to_gandi</a></span>, <span class='object_link'><a href="../../Data.html#to_h-instance_method" title="GandiV5::Data#to_h (method)">#to_h</a></span>, <span class='object_link'><a href="../../Data.html#values_at-instance_method" title="GandiV5::Data#values_at (method)">#values_at</a></span></p>
394
- <div id="constructor_details" class="method_details_list">
395
- <h2>Constructor Details</h2>
396
-
397
- <div class="method_details first">
398
- <h3 class="signature first" id="initialize-instance_method">
399
-
400
- #<strong>initialize</strong>(mailbox: nil, **members) &#x21d2; <tt><span class='object_link'><a href="../Slot.html" title="GandiV5::Email::Slot (class)">GandiV5::Email::Slot</a></span></tt>
401
-
402
-
403
-
404
-
405
-
406
- </h3><div class="docstring">
407
- <div class="discussion">
408
-
409
- <p>Create a new GandiV5::Email::Mailbox::Responder</p>
410
-
411
-
412
- </div>
413
- </div>
414
- <div class="tags">
415
- <p class="tag_title">Parameters:</p>
416
- <ul class="param">
417
-
418
- <li>
419
-
420
- <span class='name'>mailbox</span>
421
-
422
-
423
- <span class='type'>(<tt><span class='object_link'><a href="../Mailbox.html" title="GandiV5::Email::Mailbox (class)">GandiV5::Email::Mailbox</a></span></tt>)</span>
424
-
425
-
426
-
427
- &mdash;
428
- <div class='inline'>
429
- <p>the mailbox this responder belongs to.</p>
430
- </div>
431
-
432
- </li>
433
-
434
- <li>
435
-
436
- <span class='name'>members</span>
437
-
438
-
439
- <span class='type'>(<tt>Hash&lt;Symbol =&gt; Object&gt;</tt>)</span>
440
-
441
-
442
-
443
- </li>
444
-
445
- </ul>
446
-
447
-
448
- </div><table class="source_code">
449
- <tr>
450
- <td>
451
- <pre class="lines">
452
-
453
-
454
- 31
455
- 32
456
- 33
457
- 34</pre>
458
- </td>
459
- <td>
460
- <pre class="code"><span class="info file"># File 'lib/gandi_v5/email/mailbox/responder.rb', line 31</span>
461
-
462
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>mailbox:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
463
- <span class='kw'>super</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
464
- <span class='ivar'>@mailbox</span> <span class='op'>=</span> <span class='id identifier rubyid_mailbox'>mailbox</span>
465
- <span class='kw'>end</span></pre>
466
- </td>
467
- </tr>
468
- </table>
469
- </div>
470
-
471
- </div>
472
-
473
- <div id="instance_attr_details" class="attr_details">
474
- <h2>Instance Attribute Details</h2>
475
-
476
-
477
- <span id=""></span>
478
- <div class="method_details first">
479
- <h3 class="signature first" id="enabled-instance_method">
480
-
481
- #<strong>enabled</strong> &#x21d2; <tt>Boolean</tt> <span class="extras">(readonly)</span>
482
-
483
-
484
-
485
-
486
-
487
- </h3><div class="docstring">
488
- <div class="discussion">
489
-
490
-
491
- </div>
492
- </div>
493
- <div class="tags">
494
-
495
- <p class="tag_title">Returns:</p>
496
- <ul class="return">
497
-
498
- <li>
499
-
500
-
501
- <span class='type'>(<tt>Boolean</tt>)</span>
502
-
503
-
504
-
505
- </li>
506
-
507
- </ul>
508
-
509
- </div><table class="source_code">
510
- <tr>
511
- <td>
512
- <pre class="lines">
513
-
514
-
515
- 18
516
- 19
517
- 20
518
- 21
519
- 22
520
- 23
521
- 24
522
- 25
523
- 26
524
- 27
525
- 28
526
- 29
527
- 30
528
- 31
529
- 32
530
- 33
531
- 34
532
- 35
533
- 36
534
- 37
535
- 38
536
- 39
537
- 40
538
- 41
539
- 42
540
- 43
541
- 44
542
- 45
543
- 46
544
- 47
545
- 48
546
- 49
547
- 50
548
- 51
549
- 52
550
- 53
551
- 54
552
- 55
553
- 56
554
- 57
555
- 58
556
- 59
557
- 60
558
- 61
559
- 62
560
- 63
561
- 64
562
- 65
563
- 66
564
- 67
565
- 68
566
- 69
567
- 70
568
- 71
569
- 72
570
- 73
571
- 74</pre>
572
- </td>
573
- <td>
574
- <pre class="code"><span class="info file"># File 'lib/gandi_v5/email/mailbox/responder.rb', line 18</span>
575
-
576
- <span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="GandiV5::Email::Mailbox::Responder (class)">Responder</a></span></span>
577
- <span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span>
578
-
579
- <span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:mailbox</span>
580
-
581
- <span class='id identifier rubyid_members'>members</span> <span class='symbol'>:enabled</span><span class='comma'>,</span> <span class='symbol'>:message</span>
582
- <span class='id identifier rubyid_member'>member</span> <span class='symbol'>:starts_at</span><span class='comma'>,</span> <span class='label'>converter:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span>
583
- <span class='id identifier rubyid_member'>member</span> <span class='symbol'>:ends_at</span><span class='comma'>,</span> <span class='label'>converter:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span>
584
-
585
- <span class='comment'># Create a new GandiV5::Email::Mailbox::Responder
586
- </span> <span class='comment'># @param mailbox [GandiV5::Email::Mailbox] the mailbox this responder belongs to.
587
- </span> <span class='comment'># @param members [Hash&lt;Symbol =&gt; Object&gt;]
588
- </span> <span class='comment'># @return [GandiV5::Email::Slot]
589
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>mailbox:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
590
- <span class='kw'>super</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
591
- <span class='ivar'>@mailbox</span> <span class='op'>=</span> <span class='id identifier rubyid_mailbox'>mailbox</span>
592
- <span class='kw'>end</span>
593
-
594
- <span class='comment'># Check if this responder is currently active.
595
- </span> <span class='comment'># @return [Boolean] whether the responder is enabled,
596
- </span> <span class='comment'># started in the past and ends in the future.
597
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_active?'>active?</span>
598
- <span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>&amp;&amp;</span>
599
- <span class='lparen'>(</span><span class='id identifier rubyid_starts_at'>starts_at</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_starts_at'>starts_at</span> <span class='op'>&lt;</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span>
600
- <span class='lparen'>(</span><span class='id identifier rubyid_ends_at'>ends_at</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_ends_at'>ends_at</span> <span class='op'>&gt;</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span>
601
- <span class='kw'>end</span>
602
-
603
- <span class='comment'># Enable the auto responder in Gandi.
604
- </span> <span class='comment'># @param message [String]
605
- </span> <span class='comment'># @param starts_at [Time]
606
- </span> <span class='comment'># @param ends_at [Time]
607
- </span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
608
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_enable'>enable</span><span class='lparen'>(</span><span class='label'>message:</span><span class='comma'>,</span> <span class='label'>ends_at:</span><span class='comma'>,</span> <span class='label'>starts_at:</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span>
609
- <span class='id identifier rubyid_mailbox'>mailbox</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span> <span class='label'>responder:</span> <span class='lbrace'>{</span>
610
- <span class='label'>message:</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span>
611
- <span class='label'>starts_at:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span><span class='period'>.</span><span class='id identifier rubyid_to_gandi'><span class='object_link'><a href="../../Data/Converter/Time.html#to_gandi-class_method" title="GandiV5::Data::Converter::Time.to_gandi (method)">to_gandi</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_starts_at'>starts_at</span><span class='rparen'>)</span><span class='comma'>,</span>
612
- <span class='label'>ends_at:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span><span class='period'>.</span><span class='id identifier rubyid_to_gandi'><span class='object_link'><a href="../../Data/Converter/Time.html#to_gandi-class_method" title="GandiV5::Data::Converter::Time.to_gandi (method)">to_gandi</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_ends_at'>ends_at</span><span class='rparen'>)</span><span class='comma'>,</span>
613
- <span class='label'>enabled:</span> <span class='kw'>true</span>
614
- <span class='rbrace'>}</span>
615
-
616
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_starts_at'>starts_at</span> <span class='op'>=</span> <span class='id identifier rubyid_starts_at'>starts_at</span>
617
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_ends_at'>ends_at</span> <span class='op'>=</span> <span class='id identifier rubyid_ends_at'>ends_at</span>
618
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='id identifier rubyid_message'>message</span>
619
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>true</span>
620
- <span class='kw'>end</span>
621
-
622
- <span class='comment'># Disable the auto responder in Gandi.
623
- </span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
624
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_disable'>disable</span>
625
- <span class='id identifier rubyid_mailbox'>mailbox</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span> <span class='label'>responder:</span> <span class='lbrace'>{</span> <span class='label'>enabled:</span> <span class='kw'>false</span> <span class='rbrace'>}</span>
626
-
627
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_starts_at'>starts_at</span> <span class='op'>=</span> <span class='kw'>nil</span>
628
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_ends_at'>ends_at</span> <span class='op'>=</span> <span class='kw'>nil</span>
629
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='kw'>nil</span>
630
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>false</span>
631
- <span class='kw'>end</span>
632
- <span class='kw'>end</span></pre>
633
- </td>
634
- </tr>
635
- </table>
636
- </div>
637
-
638
-
639
- <span id=""></span>
640
- <div class="method_details ">
641
- <h3 class="signature " id="ends_at-instance_method">
642
-
643
- #<strong>ends_at</strong> &#x21d2; <tt>nil</tt>, <tt>Time</tt> <span class="extras">(readonly)</span>
644
-
645
-
646
-
647
-
648
-
649
- </h3><div class="docstring">
650
- <div class="discussion">
651
-
652
-
653
- </div>
654
- </div>
655
- <div class="tags">
656
-
657
- <p class="tag_title">Returns:</p>
658
- <ul class="return">
659
-
660
- <li>
661
-
662
-
663
- <span class='type'>(<tt>nil</tt>, <tt>Time</tt>)</span>
664
-
665
-
666
-
667
- </li>
668
-
669
- </ul>
670
-
671
- </div><table class="source_code">
672
- <tr>
673
- <td>
674
- <pre class="lines">
675
-
676
-
677
- 18
678
- 19
679
- 20
680
- 21
681
- 22
682
- 23
683
- 24
684
- 25
685
- 26
686
- 27
687
- 28
688
- 29
689
- 30
690
- 31
691
- 32
692
- 33
693
- 34
694
- 35
695
- 36
696
- 37
697
- 38
698
- 39
699
- 40
700
- 41
701
- 42
702
- 43
703
- 44
704
- 45
705
- 46
706
- 47
707
- 48
708
- 49
709
- 50
710
- 51
711
- 52
712
- 53
713
- 54
714
- 55
715
- 56
716
- 57
717
- 58
718
- 59
719
- 60
720
- 61
721
- 62
722
- 63
723
- 64
724
- 65
725
- 66
726
- 67
727
- 68
728
- 69
729
- 70
730
- 71
731
- 72
732
- 73
733
- 74</pre>
734
- </td>
735
- <td>
736
- <pre class="code"><span class="info file"># File 'lib/gandi_v5/email/mailbox/responder.rb', line 18</span>
737
-
738
- <span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="GandiV5::Email::Mailbox::Responder (class)">Responder</a></span></span>
739
- <span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span>
740
-
741
- <span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:mailbox</span>
742
-
743
- <span class='id identifier rubyid_members'>members</span> <span class='symbol'>:enabled</span><span class='comma'>,</span> <span class='symbol'>:message</span>
744
- <span class='id identifier rubyid_member'>member</span> <span class='symbol'>:starts_at</span><span class='comma'>,</span> <span class='label'>converter:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span>
745
- <span class='id identifier rubyid_member'>member</span> <span class='symbol'>:ends_at</span><span class='comma'>,</span> <span class='label'>converter:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span>
746
-
747
- <span class='comment'># Create a new GandiV5::Email::Mailbox::Responder
748
- </span> <span class='comment'># @param mailbox [GandiV5::Email::Mailbox] the mailbox this responder belongs to.
749
- </span> <span class='comment'># @param members [Hash&lt;Symbol =&gt; Object&gt;]
750
- </span> <span class='comment'># @return [GandiV5::Email::Slot]
751
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>mailbox:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
752
- <span class='kw'>super</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
753
- <span class='ivar'>@mailbox</span> <span class='op'>=</span> <span class='id identifier rubyid_mailbox'>mailbox</span>
754
- <span class='kw'>end</span>
755
-
756
- <span class='comment'># Check if this responder is currently active.
757
- </span> <span class='comment'># @return [Boolean] whether the responder is enabled,
758
- </span> <span class='comment'># started in the past and ends in the future.
759
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_active?'>active?</span>
760
- <span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>&amp;&amp;</span>
761
- <span class='lparen'>(</span><span class='id identifier rubyid_starts_at'>starts_at</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_starts_at'>starts_at</span> <span class='op'>&lt;</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span>
762
- <span class='lparen'>(</span><span class='id identifier rubyid_ends_at'>ends_at</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_ends_at'>ends_at</span> <span class='op'>&gt;</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span>
763
- <span class='kw'>end</span>
764
-
765
- <span class='comment'># Enable the auto responder in Gandi.
766
- </span> <span class='comment'># @param message [String]
767
- </span> <span class='comment'># @param starts_at [Time]
768
- </span> <span class='comment'># @param ends_at [Time]
769
- </span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
770
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_enable'>enable</span><span class='lparen'>(</span><span class='label'>message:</span><span class='comma'>,</span> <span class='label'>ends_at:</span><span class='comma'>,</span> <span class='label'>starts_at:</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span>
771
- <span class='id identifier rubyid_mailbox'>mailbox</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span> <span class='label'>responder:</span> <span class='lbrace'>{</span>
772
- <span class='label'>message:</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span>
773
- <span class='label'>starts_at:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span><span class='period'>.</span><span class='id identifier rubyid_to_gandi'><span class='object_link'><a href="../../Data/Converter/Time.html#to_gandi-class_method" title="GandiV5::Data::Converter::Time.to_gandi (method)">to_gandi</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_starts_at'>starts_at</span><span class='rparen'>)</span><span class='comma'>,</span>
774
- <span class='label'>ends_at:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span><span class='period'>.</span><span class='id identifier rubyid_to_gandi'><span class='object_link'><a href="../../Data/Converter/Time.html#to_gandi-class_method" title="GandiV5::Data::Converter::Time.to_gandi (method)">to_gandi</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_ends_at'>ends_at</span><span class='rparen'>)</span><span class='comma'>,</span>
775
- <span class='label'>enabled:</span> <span class='kw'>true</span>
776
- <span class='rbrace'>}</span>
777
-
778
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_starts_at'>starts_at</span> <span class='op'>=</span> <span class='id identifier rubyid_starts_at'>starts_at</span>
779
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_ends_at'>ends_at</span> <span class='op'>=</span> <span class='id identifier rubyid_ends_at'>ends_at</span>
780
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='id identifier rubyid_message'>message</span>
781
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>true</span>
782
- <span class='kw'>end</span>
783
-
784
- <span class='comment'># Disable the auto responder in Gandi.
785
- </span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
786
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_disable'>disable</span>
787
- <span class='id identifier rubyid_mailbox'>mailbox</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span> <span class='label'>responder:</span> <span class='lbrace'>{</span> <span class='label'>enabled:</span> <span class='kw'>false</span> <span class='rbrace'>}</span>
788
-
789
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_starts_at'>starts_at</span> <span class='op'>=</span> <span class='kw'>nil</span>
790
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_ends_at'>ends_at</span> <span class='op'>=</span> <span class='kw'>nil</span>
791
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='kw'>nil</span>
792
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>false</span>
793
- <span class='kw'>end</span>
794
- <span class='kw'>end</span></pre>
795
- </td>
796
- </tr>
797
- </table>
798
- </div>
799
-
800
-
801
- <span id=""></span>
802
- <div class="method_details ">
803
- <h3 class="signature " id="mailbox-instance_method">
804
-
805
- #<strong>mailbox</strong> &#x21d2; <tt><span class='object_link'><a href="../Mailbox.html" title="GandiV5::Email::Mailbox (class)">GandiV5::Email::Mailbox</a></span></tt> <span class="extras">(readonly)</span>
806
-
807
-
808
-
809
-
810
-
811
- </h3><div class="docstring">
812
- <div class="discussion">
813
-
814
- <p>Returns the mailbox this repsonder belongs to.</p>
815
-
816
-
817
- </div>
818
- </div>
819
- <div class="tags">
820
-
821
- <p class="tag_title">Returns:</p>
822
- <ul class="return">
823
-
824
- <li>
825
-
826
-
827
- <span class='type'>(<tt><span class='object_link'><a href="../Mailbox.html" title="GandiV5::Email::Mailbox (class)">GandiV5::Email::Mailbox</a></span></tt>)</span>
828
-
829
-
830
-
831
- &mdash;
832
- <div class='inline'>
833
- <p>the mailbox this repsonder belongs to.</p>
834
- </div>
835
-
836
- </li>
837
-
838
- </ul>
839
-
840
- </div><table class="source_code">
841
- <tr>
842
- <td>
843
- <pre class="lines">
844
-
845
-
846
- 18
847
- 19
848
- 20
849
- 21
850
- 22
851
- 23
852
- 24
853
- 25
854
- 26
855
- 27
856
- 28
857
- 29
858
- 30
859
- 31
860
- 32
861
- 33
862
- 34
863
- 35
864
- 36
865
- 37
866
- 38
867
- 39
868
- 40
869
- 41
870
- 42
871
- 43
872
- 44
873
- 45
874
- 46
875
- 47
876
- 48
877
- 49
878
- 50
879
- 51
880
- 52
881
- 53
882
- 54
883
- 55
884
- 56
885
- 57
886
- 58
887
- 59
888
- 60
889
- 61
890
- 62
891
- 63
892
- 64
893
- 65
894
- 66
895
- 67
896
- 68
897
- 69
898
- 70
899
- 71
900
- 72
901
- 73
902
- 74</pre>
903
- </td>
904
- <td>
905
- <pre class="code"><span class="info file"># File 'lib/gandi_v5/email/mailbox/responder.rb', line 18</span>
906
-
907
- <span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="GandiV5::Email::Mailbox::Responder (class)">Responder</a></span></span>
908
- <span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span>
909
-
910
- <span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:mailbox</span>
911
-
912
- <span class='id identifier rubyid_members'>members</span> <span class='symbol'>:enabled</span><span class='comma'>,</span> <span class='symbol'>:message</span>
913
- <span class='id identifier rubyid_member'>member</span> <span class='symbol'>:starts_at</span><span class='comma'>,</span> <span class='label'>converter:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span>
914
- <span class='id identifier rubyid_member'>member</span> <span class='symbol'>:ends_at</span><span class='comma'>,</span> <span class='label'>converter:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span>
915
-
916
- <span class='comment'># Create a new GandiV5::Email::Mailbox::Responder
917
- </span> <span class='comment'># @param mailbox [GandiV5::Email::Mailbox] the mailbox this responder belongs to.
918
- </span> <span class='comment'># @param members [Hash&lt;Symbol =&gt; Object&gt;]
919
- </span> <span class='comment'># @return [GandiV5::Email::Slot]
920
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>mailbox:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
921
- <span class='kw'>super</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
922
- <span class='ivar'>@mailbox</span> <span class='op'>=</span> <span class='id identifier rubyid_mailbox'>mailbox</span>
923
- <span class='kw'>end</span>
924
-
925
- <span class='comment'># Check if this responder is currently active.
926
- </span> <span class='comment'># @return [Boolean] whether the responder is enabled,
927
- </span> <span class='comment'># started in the past and ends in the future.
928
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_active?'>active?</span>
929
- <span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>&amp;&amp;</span>
930
- <span class='lparen'>(</span><span class='id identifier rubyid_starts_at'>starts_at</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_starts_at'>starts_at</span> <span class='op'>&lt;</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span>
931
- <span class='lparen'>(</span><span class='id identifier rubyid_ends_at'>ends_at</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_ends_at'>ends_at</span> <span class='op'>&gt;</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span>
932
- <span class='kw'>end</span>
933
-
934
- <span class='comment'># Enable the auto responder in Gandi.
935
- </span> <span class='comment'># @param message [String]
936
- </span> <span class='comment'># @param starts_at [Time]
937
- </span> <span class='comment'># @param ends_at [Time]
938
- </span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
939
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_enable'>enable</span><span class='lparen'>(</span><span class='label'>message:</span><span class='comma'>,</span> <span class='label'>ends_at:</span><span class='comma'>,</span> <span class='label'>starts_at:</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span>
940
- <span class='id identifier rubyid_mailbox'>mailbox</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span> <span class='label'>responder:</span> <span class='lbrace'>{</span>
941
- <span class='label'>message:</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span>
942
- <span class='label'>starts_at:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span><span class='period'>.</span><span class='id identifier rubyid_to_gandi'><span class='object_link'><a href="../../Data/Converter/Time.html#to_gandi-class_method" title="GandiV5::Data::Converter::Time.to_gandi (method)">to_gandi</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_starts_at'>starts_at</span><span class='rparen'>)</span><span class='comma'>,</span>
943
- <span class='label'>ends_at:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span><span class='period'>.</span><span class='id identifier rubyid_to_gandi'><span class='object_link'><a href="../../Data/Converter/Time.html#to_gandi-class_method" title="GandiV5::Data::Converter::Time.to_gandi (method)">to_gandi</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_ends_at'>ends_at</span><span class='rparen'>)</span><span class='comma'>,</span>
944
- <span class='label'>enabled:</span> <span class='kw'>true</span>
945
- <span class='rbrace'>}</span>
946
-
947
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_starts_at'>starts_at</span> <span class='op'>=</span> <span class='id identifier rubyid_starts_at'>starts_at</span>
948
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_ends_at'>ends_at</span> <span class='op'>=</span> <span class='id identifier rubyid_ends_at'>ends_at</span>
949
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='id identifier rubyid_message'>message</span>
950
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>true</span>
951
- <span class='kw'>end</span>
952
-
953
- <span class='comment'># Disable the auto responder in Gandi.
954
- </span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
955
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_disable'>disable</span>
956
- <span class='id identifier rubyid_mailbox'>mailbox</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span> <span class='label'>responder:</span> <span class='lbrace'>{</span> <span class='label'>enabled:</span> <span class='kw'>false</span> <span class='rbrace'>}</span>
957
-
958
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_starts_at'>starts_at</span> <span class='op'>=</span> <span class='kw'>nil</span>
959
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_ends_at'>ends_at</span> <span class='op'>=</span> <span class='kw'>nil</span>
960
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='kw'>nil</span>
961
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>false</span>
962
- <span class='kw'>end</span>
963
- <span class='kw'>end</span></pre>
964
- </td>
965
- </tr>
966
- </table>
967
- </div>
968
-
969
-
970
- <span id=""></span>
971
- <div class="method_details ">
972
- <h3 class="signature " id="message-instance_method">
973
-
974
- #<strong>message</strong> &#x21d2; <tt>nil</tt>, <tt>String</tt> <span class="extras">(readonly)</span>
975
-
976
-
977
-
978
-
979
-
980
- </h3><div class="docstring">
981
- <div class="discussion">
982
-
983
-
984
- </div>
985
- </div>
986
- <div class="tags">
987
-
988
- <p class="tag_title">Returns:</p>
989
- <ul class="return">
990
-
991
- <li>
992
-
993
-
994
- <span class='type'>(<tt>nil</tt>, <tt>String</tt>)</span>
995
-
996
-
997
-
998
- </li>
999
-
1000
- </ul>
1001
-
1002
- </div><table class="source_code">
1003
- <tr>
1004
- <td>
1005
- <pre class="lines">
1006
-
1007
-
1008
- 18
1009
- 19
1010
- 20
1011
- 21
1012
- 22
1013
- 23
1014
- 24
1015
- 25
1016
- 26
1017
- 27
1018
- 28
1019
- 29
1020
- 30
1021
- 31
1022
- 32
1023
- 33
1024
- 34
1025
- 35
1026
- 36
1027
- 37
1028
- 38
1029
- 39
1030
- 40
1031
- 41
1032
- 42
1033
- 43
1034
- 44
1035
- 45
1036
- 46
1037
- 47
1038
- 48
1039
- 49
1040
- 50
1041
- 51
1042
- 52
1043
- 53
1044
- 54
1045
- 55
1046
- 56
1047
- 57
1048
- 58
1049
- 59
1050
- 60
1051
- 61
1052
- 62
1053
- 63
1054
- 64
1055
- 65
1056
- 66
1057
- 67
1058
- 68
1059
- 69
1060
- 70
1061
- 71
1062
- 72
1063
- 73
1064
- 74</pre>
1065
- </td>
1066
- <td>
1067
- <pre class="code"><span class="info file"># File 'lib/gandi_v5/email/mailbox/responder.rb', line 18</span>
1068
-
1069
- <span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="GandiV5::Email::Mailbox::Responder (class)">Responder</a></span></span>
1070
- <span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span>
1071
-
1072
- <span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:mailbox</span>
1073
-
1074
- <span class='id identifier rubyid_members'>members</span> <span class='symbol'>:enabled</span><span class='comma'>,</span> <span class='symbol'>:message</span>
1075
- <span class='id identifier rubyid_member'>member</span> <span class='symbol'>:starts_at</span><span class='comma'>,</span> <span class='label'>converter:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span>
1076
- <span class='id identifier rubyid_member'>member</span> <span class='symbol'>:ends_at</span><span class='comma'>,</span> <span class='label'>converter:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span>
1077
-
1078
- <span class='comment'># Create a new GandiV5::Email::Mailbox::Responder
1079
- </span> <span class='comment'># @param mailbox [GandiV5::Email::Mailbox] the mailbox this responder belongs to.
1080
- </span> <span class='comment'># @param members [Hash&lt;Symbol =&gt; Object&gt;]
1081
- </span> <span class='comment'># @return [GandiV5::Email::Slot]
1082
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>mailbox:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
1083
- <span class='kw'>super</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
1084
- <span class='ivar'>@mailbox</span> <span class='op'>=</span> <span class='id identifier rubyid_mailbox'>mailbox</span>
1085
- <span class='kw'>end</span>
1086
-
1087
- <span class='comment'># Check if this responder is currently active.
1088
- </span> <span class='comment'># @return [Boolean] whether the responder is enabled,
1089
- </span> <span class='comment'># started in the past and ends in the future.
1090
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_active?'>active?</span>
1091
- <span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>&amp;&amp;</span>
1092
- <span class='lparen'>(</span><span class='id identifier rubyid_starts_at'>starts_at</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_starts_at'>starts_at</span> <span class='op'>&lt;</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span>
1093
- <span class='lparen'>(</span><span class='id identifier rubyid_ends_at'>ends_at</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_ends_at'>ends_at</span> <span class='op'>&gt;</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span>
1094
- <span class='kw'>end</span>
1095
-
1096
- <span class='comment'># Enable the auto responder in Gandi.
1097
- </span> <span class='comment'># @param message [String]
1098
- </span> <span class='comment'># @param starts_at [Time]
1099
- </span> <span class='comment'># @param ends_at [Time]
1100
- </span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
1101
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_enable'>enable</span><span class='lparen'>(</span><span class='label'>message:</span><span class='comma'>,</span> <span class='label'>ends_at:</span><span class='comma'>,</span> <span class='label'>starts_at:</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span>
1102
- <span class='id identifier rubyid_mailbox'>mailbox</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span> <span class='label'>responder:</span> <span class='lbrace'>{</span>
1103
- <span class='label'>message:</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span>
1104
- <span class='label'>starts_at:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span><span class='period'>.</span><span class='id identifier rubyid_to_gandi'><span class='object_link'><a href="../../Data/Converter/Time.html#to_gandi-class_method" title="GandiV5::Data::Converter::Time.to_gandi (method)">to_gandi</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_starts_at'>starts_at</span><span class='rparen'>)</span><span class='comma'>,</span>
1105
- <span class='label'>ends_at:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span><span class='period'>.</span><span class='id identifier rubyid_to_gandi'><span class='object_link'><a href="../../Data/Converter/Time.html#to_gandi-class_method" title="GandiV5::Data::Converter::Time.to_gandi (method)">to_gandi</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_ends_at'>ends_at</span><span class='rparen'>)</span><span class='comma'>,</span>
1106
- <span class='label'>enabled:</span> <span class='kw'>true</span>
1107
- <span class='rbrace'>}</span>
1108
-
1109
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_starts_at'>starts_at</span> <span class='op'>=</span> <span class='id identifier rubyid_starts_at'>starts_at</span>
1110
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_ends_at'>ends_at</span> <span class='op'>=</span> <span class='id identifier rubyid_ends_at'>ends_at</span>
1111
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='id identifier rubyid_message'>message</span>
1112
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>true</span>
1113
- <span class='kw'>end</span>
1114
-
1115
- <span class='comment'># Disable the auto responder in Gandi.
1116
- </span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
1117
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_disable'>disable</span>
1118
- <span class='id identifier rubyid_mailbox'>mailbox</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span> <span class='label'>responder:</span> <span class='lbrace'>{</span> <span class='label'>enabled:</span> <span class='kw'>false</span> <span class='rbrace'>}</span>
1119
-
1120
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_starts_at'>starts_at</span> <span class='op'>=</span> <span class='kw'>nil</span>
1121
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_ends_at'>ends_at</span> <span class='op'>=</span> <span class='kw'>nil</span>
1122
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='kw'>nil</span>
1123
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>false</span>
1124
- <span class='kw'>end</span>
1125
- <span class='kw'>end</span></pre>
1126
- </td>
1127
- </tr>
1128
- </table>
1129
- </div>
1130
-
1131
-
1132
- <span id=""></span>
1133
- <div class="method_details ">
1134
- <h3 class="signature " id="starts_at-instance_method">
1135
-
1136
- #<strong>starts_at</strong> &#x21d2; <tt>nil</tt>, <tt>Time</tt> <span class="extras">(readonly)</span>
1137
-
1138
-
1139
-
1140
-
1141
-
1142
- </h3><div class="docstring">
1143
- <div class="discussion">
1144
-
1145
-
1146
- </div>
1147
- </div>
1148
- <div class="tags">
1149
-
1150
- <p class="tag_title">Returns:</p>
1151
- <ul class="return">
1152
-
1153
- <li>
1154
-
1155
-
1156
- <span class='type'>(<tt>nil</tt>, <tt>Time</tt>)</span>
1157
-
1158
-
1159
-
1160
- </li>
1161
-
1162
- </ul>
1163
-
1164
- </div><table class="source_code">
1165
- <tr>
1166
- <td>
1167
- <pre class="lines">
1168
-
1169
-
1170
- 18
1171
- 19
1172
- 20
1173
- 21
1174
- 22
1175
- 23
1176
- 24
1177
- 25
1178
- 26
1179
- 27
1180
- 28
1181
- 29
1182
- 30
1183
- 31
1184
- 32
1185
- 33
1186
- 34
1187
- 35
1188
- 36
1189
- 37
1190
- 38
1191
- 39
1192
- 40
1193
- 41
1194
- 42
1195
- 43
1196
- 44
1197
- 45
1198
- 46
1199
- 47
1200
- 48
1201
- 49
1202
- 50
1203
- 51
1204
- 52
1205
- 53
1206
- 54
1207
- 55
1208
- 56
1209
- 57
1210
- 58
1211
- 59
1212
- 60
1213
- 61
1214
- 62
1215
- 63
1216
- 64
1217
- 65
1218
- 66
1219
- 67
1220
- 68
1221
- 69
1222
- 70
1223
- 71
1224
- 72
1225
- 73
1226
- 74</pre>
1227
- </td>
1228
- <td>
1229
- <pre class="code"><span class="info file"># File 'lib/gandi_v5/email/mailbox/responder.rb', line 18</span>
1230
-
1231
- <span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="GandiV5::Email::Mailbox::Responder (class)">Responder</a></span></span>
1232
- <span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span>
1233
-
1234
- <span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:mailbox</span>
1235
-
1236
- <span class='id identifier rubyid_members'>members</span> <span class='symbol'>:enabled</span><span class='comma'>,</span> <span class='symbol'>:message</span>
1237
- <span class='id identifier rubyid_member'>member</span> <span class='symbol'>:starts_at</span><span class='comma'>,</span> <span class='label'>converter:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span>
1238
- <span class='id identifier rubyid_member'>member</span> <span class='symbol'>:ends_at</span><span class='comma'>,</span> <span class='label'>converter:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span>
1239
-
1240
- <span class='comment'># Create a new GandiV5::Email::Mailbox::Responder
1241
- </span> <span class='comment'># @param mailbox [GandiV5::Email::Mailbox] the mailbox this responder belongs to.
1242
- </span> <span class='comment'># @param members [Hash&lt;Symbol =&gt; Object&gt;]
1243
- </span> <span class='comment'># @return [GandiV5::Email::Slot]
1244
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>mailbox:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
1245
- <span class='kw'>super</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
1246
- <span class='ivar'>@mailbox</span> <span class='op'>=</span> <span class='id identifier rubyid_mailbox'>mailbox</span>
1247
- <span class='kw'>end</span>
1248
-
1249
- <span class='comment'># Check if this responder is currently active.
1250
- </span> <span class='comment'># @return [Boolean] whether the responder is enabled,
1251
- </span> <span class='comment'># started in the past and ends in the future.
1252
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_active?'>active?</span>
1253
- <span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>&amp;&amp;</span>
1254
- <span class='lparen'>(</span><span class='id identifier rubyid_starts_at'>starts_at</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_starts_at'>starts_at</span> <span class='op'>&lt;</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span>
1255
- <span class='lparen'>(</span><span class='id identifier rubyid_ends_at'>ends_at</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_ends_at'>ends_at</span> <span class='op'>&gt;</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span>
1256
- <span class='kw'>end</span>
1257
-
1258
- <span class='comment'># Enable the auto responder in Gandi.
1259
- </span> <span class='comment'># @param message [String]
1260
- </span> <span class='comment'># @param starts_at [Time]
1261
- </span> <span class='comment'># @param ends_at [Time]
1262
- </span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
1263
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_enable'>enable</span><span class='lparen'>(</span><span class='label'>message:</span><span class='comma'>,</span> <span class='label'>ends_at:</span><span class='comma'>,</span> <span class='label'>starts_at:</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span>
1264
- <span class='id identifier rubyid_mailbox'>mailbox</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span> <span class='label'>responder:</span> <span class='lbrace'>{</span>
1265
- <span class='label'>message:</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span>
1266
- <span class='label'>starts_at:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span><span class='period'>.</span><span class='id identifier rubyid_to_gandi'><span class='object_link'><a href="../../Data/Converter/Time.html#to_gandi-class_method" title="GandiV5::Data::Converter::Time.to_gandi (method)">to_gandi</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_starts_at'>starts_at</span><span class='rparen'>)</span><span class='comma'>,</span>
1267
- <span class='label'>ends_at:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span><span class='period'>.</span><span class='id identifier rubyid_to_gandi'><span class='object_link'><a href="../../Data/Converter/Time.html#to_gandi-class_method" title="GandiV5::Data::Converter::Time.to_gandi (method)">to_gandi</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_ends_at'>ends_at</span><span class='rparen'>)</span><span class='comma'>,</span>
1268
- <span class='label'>enabled:</span> <span class='kw'>true</span>
1269
- <span class='rbrace'>}</span>
1270
-
1271
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_starts_at'>starts_at</span> <span class='op'>=</span> <span class='id identifier rubyid_starts_at'>starts_at</span>
1272
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_ends_at'>ends_at</span> <span class='op'>=</span> <span class='id identifier rubyid_ends_at'>ends_at</span>
1273
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='id identifier rubyid_message'>message</span>
1274
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>true</span>
1275
- <span class='kw'>end</span>
1276
-
1277
- <span class='comment'># Disable the auto responder in Gandi.
1278
- </span> <span class='comment'># @raise [GandiV5::Error::GandiError] if Gandi returns an error.
1279
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_disable'>disable</span>
1280
- <span class='id identifier rubyid_mailbox'>mailbox</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span> <span class='label'>responder:</span> <span class='lbrace'>{</span> <span class='label'>enabled:</span> <span class='kw'>false</span> <span class='rbrace'>}</span>
1281
-
1282
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_starts_at'>starts_at</span> <span class='op'>=</span> <span class='kw'>nil</span>
1283
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_ends_at'>ends_at</span> <span class='op'>=</span> <span class='kw'>nil</span>
1284
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='kw'>nil</span>
1285
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>false</span>
1286
- <span class='kw'>end</span>
1287
- <span class='kw'>end</span></pre>
1288
- </td>
1289
- </tr>
1290
- </table>
1291
- </div>
1292
-
1293
- </div>
1294
-
1295
-
1296
- <div id="instance_method_details" class="method_details_list">
1297
- <h2>Instance Method Details</h2>
1298
-
1299
-
1300
- <div class="method_details first">
1301
- <h3 class="signature first" id="active?-instance_method">
1302
-
1303
- #<strong>active?</strong> &#x21d2; <tt>Boolean</tt>
1304
-
1305
-
1306
-
1307
-
1308
-
1309
- </h3><div class="docstring">
1310
- <div class="discussion">
1311
-
1312
- <p>Check if this responder is currently active.</p>
1313
-
1314
-
1315
- </div>
1316
- </div>
1317
- <div class="tags">
1318
-
1319
- <p class="tag_title">Returns:</p>
1320
- <ul class="return">
1321
-
1322
- <li>
1323
-
1324
-
1325
- <span class='type'>(<tt>Boolean</tt>)</span>
1326
-
1327
-
1328
-
1329
- &mdash;
1330
- <div class='inline'>
1331
- <p>whether the responder is enabled, started in the past and ends in the future.</p>
1332
- </div>
1333
-
1334
- </li>
1335
-
1336
- </ul>
1337
-
1338
- </div><table class="source_code">
1339
- <tr>
1340
- <td>
1341
- <pre class="lines">
1342
-
1343
-
1344
- 39
1345
- 40
1346
- 41
1347
- 42
1348
- 43</pre>
1349
- </td>
1350
- <td>
1351
- <pre class="code"><span class="info file"># File 'lib/gandi_v5/email/mailbox/responder.rb', line 39</span>
1352
-
1353
- <span class='kw'>def</span> <span class='id identifier rubyid_active?'>active?</span>
1354
- <span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>&amp;&amp;</span>
1355
- <span class='lparen'>(</span><span class='id identifier rubyid_starts_at'>starts_at</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_starts_at'>starts_at</span> <span class='op'>&lt;</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span>
1356
- <span class='lparen'>(</span><span class='id identifier rubyid_ends_at'>ends_at</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_ends_at'>ends_at</span> <span class='op'>&gt;</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span>
1357
- <span class='kw'>end</span></pre>
1358
- </td>
1359
- </tr>
1360
- </table>
1361
- </div>
1362
-
1363
- <div class="method_details ">
1364
- <h3 class="signature " id="disable-instance_method">
1365
-
1366
- #<strong>disable</strong> &#x21d2; <tt>Object</tt>
1367
-
1368
-
1369
-
1370
-
1371
-
1372
- </h3><div class="docstring">
1373
- <div class="discussion">
1374
-
1375
- <p>Disable the auto responder in Gandi.</p>
1376
-
1377
-
1378
- </div>
1379
- </div>
1380
- <div class="tags">
1381
-
1382
- <p class="tag_title">Raises:</p>
1383
- <ul class="raise">
1384
-
1385
- <li>
1386
-
1387
-
1388
- <span class='type'>(<tt><span class='object_link'><a href="../../Error/GandiError.html" title="GandiV5::Error::GandiError (class)">GandiV5::Error::GandiError</a></span></tt>)</span>
1389
-
1390
-
1391
-
1392
- &mdash;
1393
- <div class='inline'>
1394
- <p>if Gandi returns an error.</p>
1395
- </div>
1396
-
1397
- </li>
1398
-
1399
- </ul>
1400
-
1401
- </div><table class="source_code">
1402
- <tr>
1403
- <td>
1404
- <pre class="lines">
1405
-
1406
-
1407
- 66
1408
- 67
1409
- 68
1410
- 69
1411
- 70
1412
- 71
1413
- 72
1414
- 73</pre>
1415
- </td>
1416
- <td>
1417
- <pre class="code"><span class="info file"># File 'lib/gandi_v5/email/mailbox/responder.rb', line 66</span>
1418
-
1419
- <span class='kw'>def</span> <span class='id identifier rubyid_disable'>disable</span>
1420
- <span class='id identifier rubyid_mailbox'>mailbox</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span> <span class='label'>responder:</span> <span class='lbrace'>{</span> <span class='label'>enabled:</span> <span class='kw'>false</span> <span class='rbrace'>}</span>
1421
-
1422
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_starts_at'>starts_at</span> <span class='op'>=</span> <span class='kw'>nil</span>
1423
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_ends_at'>ends_at</span> <span class='op'>=</span> <span class='kw'>nil</span>
1424
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='kw'>nil</span>
1425
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>false</span>
1426
- <span class='kw'>end</span></pre>
1427
- </td>
1428
- </tr>
1429
- </table>
1430
- </div>
1431
-
1432
- <div class="method_details ">
1433
- <h3 class="signature " id="enable-instance_method">
1434
-
1435
- #<strong>enable</strong>(message:, ends_at:, starts_at: Time.now) &#x21d2; <tt>Object</tt>
1436
-
1437
-
1438
-
1439
-
1440
-
1441
- </h3><div class="docstring">
1442
- <div class="discussion">
1443
-
1444
- <p>Enable the auto responder in Gandi.</p>
1445
-
1446
-
1447
- </div>
1448
- </div>
1449
- <div class="tags">
1450
- <p class="tag_title">Parameters:</p>
1451
- <ul class="param">
1452
-
1453
- <li>
1454
-
1455
- <span class='name'>message</span>
1456
-
1457
-
1458
- <span class='type'>(<tt>String</tt>)</span>
1459
-
1460
-
1461
-
1462
- </li>
1463
-
1464
- <li>
1465
-
1466
- <span class='name'>starts_at</span>
1467
-
1468
-
1469
- <span class='type'>(<tt>Time</tt>)</span>
1470
-
1471
-
1472
-
1473
- </li>
1474
-
1475
- <li>
1476
-
1477
- <span class='name'>ends_at</span>
1478
-
1479
-
1480
- <span class='type'>(<tt>Time</tt>)</span>
1481
-
1482
-
1483
-
1484
- </li>
1485
-
1486
- </ul>
1487
-
1488
- <p class="tag_title">Raises:</p>
1489
- <ul class="raise">
1490
-
1491
- <li>
1492
-
1493
-
1494
- <span class='type'>(<tt><span class='object_link'><a href="../../Error/GandiError.html" title="GandiV5::Error::GandiError (class)">GandiV5::Error::GandiError</a></span></tt>)</span>
1495
-
1496
-
1497
-
1498
- &mdash;
1499
- <div class='inline'>
1500
- <p>if Gandi returns an error.</p>
1501
- </div>
1502
-
1503
- </li>
1504
-
1505
- </ul>
1506
-
1507
- </div><table class="source_code">
1508
- <tr>
1509
- <td>
1510
- <pre class="lines">
1511
-
1512
-
1513
- 50
1514
- 51
1515
- 52
1516
- 53
1517
- 54
1518
- 55
1519
- 56
1520
- 57
1521
- 58
1522
- 59
1523
- 60
1524
- 61
1525
- 62</pre>
1526
- </td>
1527
- <td>
1528
- <pre class="code"><span class="info file"># File 'lib/gandi_v5/email/mailbox/responder.rb', line 50</span>
1529
-
1530
- <span class='kw'>def</span> <span class='id identifier rubyid_enable'>enable</span><span class='lparen'>(</span><span class='label'>message:</span><span class='comma'>,</span> <span class='label'>ends_at:</span><span class='comma'>,</span> <span class='label'>starts_at:</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='rparen'>)</span>
1531
- <span class='id identifier rubyid_mailbox'>mailbox</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span> <span class='label'>responder:</span> <span class='lbrace'>{</span>
1532
- <span class='label'>message:</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span>
1533
- <span class='label'>starts_at:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span><span class='period'>.</span><span class='id identifier rubyid_to_gandi'><span class='object_link'><a href="../../Data/Converter/Time.html#to_gandi-class_method" title="GandiV5::Data::Converter::Time.to_gandi (method)">to_gandi</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_starts_at'>starts_at</span><span class='rparen'>)</span><span class='comma'>,</span>
1534
- <span class='label'>ends_at:</span> <span class='const'><span class='object_link'><a href="../../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data.html" title="GandiV5::Data (module)">Data</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter.html" title="GandiV5::Data::Converter (class)">Converter</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Data/Converter/Time.html" title="GandiV5::Data::Converter::Time (class)">Time</a></span></span><span class='period'>.</span><span class='id identifier rubyid_to_gandi'><span class='object_link'><a href="../../Data/Converter/Time.html#to_gandi-class_method" title="GandiV5::Data::Converter::Time.to_gandi (method)">to_gandi</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_ends_at'>ends_at</span><span class='rparen'>)</span><span class='comma'>,</span>
1535
- <span class='label'>enabled:</span> <span class='kw'>true</span>
1536
- <span class='rbrace'>}</span>
1537
-
1538
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_starts_at'>starts_at</span> <span class='op'>=</span> <span class='id identifier rubyid_starts_at'>starts_at</span>
1539
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_ends_at'>ends_at</span> <span class='op'>=</span> <span class='id identifier rubyid_ends_at'>ends_at</span>
1540
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='id identifier rubyid_message'>message</span>
1541
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enabled'>enabled</span> <span class='op'>=</span> <span class='kw'>true</span>
1542
- <span class='kw'>end</span></pre>
1543
- </td>
1544
- </tr>
1545
- </table>
1546
- </div>
1547
-
1548
- </div>
1549
-
1550
- </div>
1551
-
1552
- <div id="footer">
1553
- Generated on Mon Jul 22 16:44:34 2019 by
1554
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1555
- 0.9.19 (ruby-2.6.3).
1556
- </div>
1557
-
1558
- </div>
1559
- </body>
1560
- </html>