Class: Email::Mxplan

Inherits:
Object
  • Object
show all
Defined in:
lib/ovh-api/api/email/mxplan.rb

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Mxplan

Returns a new instance of Mxplan.



6
7
8
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 6

def initialize(connection)
  @connection = connection
end

Instance Method Details

#get(iam_tags: nil) ⇒ Object 



10
11
12
13
14
15
16
17
18
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 10

def get(iam_tags: nil)
  @connection.call(
    :GET,
    '/email/mxplan',
    type: nil,
    auth: [],
    query: { 'iamTags' => iam_tags }
  )
end

#service_account_email_alias_alias_delete(alias_:, email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 20

def (alias_:, email:, service:)
  raise ArgumentError, 'alias_ is required' if alias_.nil?
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :DELETE,
    '/email/mxplan/{service}/account/{email}/alias/{alias}'
      .gsub('{alias}', ERB::Util.url_encode(alias_.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_alias_alias_get(alias_:, email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 36

def (alias_:, email:, service:)
  raise ArgumentError, 'alias_ is required' if alias_.nil?
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/account/{email}/alias/{alias}'
      .gsub('{alias}', ERB::Util.url_encode(alias_.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_alias_get(email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 52

def (email:, service:)
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/account/{email}/alias'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_alias_post(email:, service:, body:) ⇒ Object

Raises:

  • (ArgumentError) 


66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 66

def (email:, service:, body:)
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'body is required' if body.nil?

  @connection.call(
    :POST,
    '/email/mxplan/{service}/account/{email}/alias'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: body
  )
end

#service_account_email_capabilities_get(email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 82

def (email:, service:)
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/account/{email}/capabilities'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_change_password_post(email:, service:, body:) ⇒ Object

Raises:

  • (ArgumentError) 


96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 96

def (email:, service:, body:)
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'body is required' if body.nil?

  @connection.call(
    :POST,
    '/email/mxplan/{service}/account/{email}/changePassword'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: body
  )
end

#service_account_email_delete(email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 112

def (email:, service:)
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :DELETE,
    '/email/mxplan/{service}/account/{email}'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_diagnostic_get(email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 126

def (email:, service:)
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/account/{email}/diagnostic'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_diagnostic_post(email:, service:, body:) ⇒ Object

Raises:

  • (ArgumentError) 


140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 140

def (email:, service:, body:)
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'body is required' if body.nil?

  @connection.call(
    :POST,
    '/email/mxplan/{service}/account/{email}/diagnostic'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: body
  )
end

#service_account_email_full_access_allowed_account_id_delete(allowed_account_id:, email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 156

def (allowed_account_id:, email:, service:)
  raise ArgumentError, 'allowed_account_id is required' if .nil?
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :DELETE,
    '/email/mxplan/{service}/account/{email}/fullAccess/{allowedAccountId}'
      .gsub('{allowedAccountId}', ERB::Util.url_encode(.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_full_access_allowed_account_id_get(allowed_account_id:, email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 172

def (allowed_account_id:, email:, service:)
  raise ArgumentError, 'allowed_account_id is required' if .nil?
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/account/{email}/fullAccess/{allowedAccountId}'
      .gsub('{allowedAccountId}', ERB::Util.url_encode(.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_full_access_get(email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 188

def (email:, service:)
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/account/{email}/fullAccess'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_full_access_post(email:, service:, body:) ⇒ Object

Raises:

  • (ArgumentError) 


202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 202

def (email:, service:, body:)
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'body is required' if body.nil?

  @connection.call(
    :POST,
    '/email/mxplan/{service}/account/{email}/fullAccess'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: body
  )
end

#service_account_email_get(email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 218

def (email:, service:)
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/account/{email}'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_put(email:, service:, email_mxplan_account:) ⇒ Object

Raises:

  • (ArgumentError) 


232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 232

def (email:, service:, email_mxplan_account:)
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'email_mxplan_account is required' if .nil?

  @connection.call(
    :PUT,
    '/email/mxplan/{service}/account/{email}'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: 
  )
end

#service_account_email_send_as_allowed_account_id_delete(allowed_account_id:, email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 248

def (allowed_account_id:, email:, service:)
  raise ArgumentError, 'allowed_account_id is required' if .nil?
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :DELETE,
    '/email/mxplan/{service}/account/{email}/sendAs/{allowedAccountId}'
      .gsub('{allowedAccountId}', ERB::Util.url_encode(.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_send_as_allowed_account_id_get(allowed_account_id:, email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 264

def (allowed_account_id:, email:, service:)
  raise ArgumentError, 'allowed_account_id is required' if .nil?
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/account/{email}/sendAs/{allowedAccountId}'
      .gsub('{allowedAccountId}', ERB::Util.url_encode(.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_send_as_get(email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 280

def (email:, service:)
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/account/{email}/sendAs'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_send_as_post(email:, service:, body:) ⇒ Object

Raises:

  • (ArgumentError) 


294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 294

def (email:, service:, body:)
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'body is required' if body.nil?

  @connection.call(
    :POST,
    '/email/mxplan/{service}/account/{email}/sendAs'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: body
  )
end

#service_account_email_send_on_behalf_to_allowed_account_id_delete(allowed_account_id:, email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 310

def (allowed_account_id:, email:, service:)
  raise ArgumentError, 'allowed_account_id is required' if .nil?
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :DELETE,
    '/email/mxplan/{service}/account/{email}/sendOnBehalfTo/{allowedAccountId}'
      .gsub('{allowedAccountId}', ERB::Util.url_encode(.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_send_on_behalf_to_allowed_account_id_get(allowed_account_id:, email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 326

def (allowed_account_id:, email:, service:)
  raise ArgumentError, 'allowed_account_id is required' if .nil?
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/account/{email}/sendOnBehalfTo/{allowedAccountId}'
      .gsub('{allowedAccountId}', ERB::Util.url_encode(.to_s))
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_send_on_behalf_to_get(email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 342

def (email:, service:)
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/account/{email}/sendOnBehalfTo'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_send_on_behalf_to_post(email:, service:, body:) ⇒ Object

Raises:

  • (ArgumentError) 


356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 356

def (email:, service:, body:)
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'body is required' if body.nil?

  @connection.call(
    :POST,
    '/email/mxplan/{service}/account/{email}/sendOnBehalfTo'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: body
  )
end

#service_account_email_task_get(email:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 372

def (email:, service:)
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/account/{email}/task'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_email_task_id_get(email:, id:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 386

def (email:, id:, service:)
  raise ArgumentError, 'email is required' if email.nil?
  raise ArgumentError, 'id is required' if id.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/account/{email}/task/{id}'
      .gsub('{email}', ERB::Util.url_encode(email.to_s))
      .gsub('{id}', ERB::Util.url_encode(id.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_account_get(service:, id: nil, primary_email_address: nil) ⇒ Object

Raises:

  • (ArgumentError) 


402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 402

def (service:, id: nil, primary_email_address: nil)
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/account'
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    query: { 'id' => id, 'primaryEmailAddress' => primary_email_address }
  )
end

#service_domain_domain_name_disclaimer_attribute_get(domain_name:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 415

def service_domain_domain_name_disclaimer_attribute_get(domain_name:, service:)
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/domain/{domainName}/disclaimerAttribute'
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_domain_domain_name_disclaimer_delete(domain_name:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 429

def service_domain_domain_name_disclaimer_delete(domain_name:, service:)
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :DELETE,
    '/email/mxplan/{service}/domain/{domainName}/disclaimer'
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_domain_domain_name_disclaimer_get(domain_name:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 443

def service_domain_domain_name_disclaimer_get(domain_name:, service:)
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/domain/{domainName}/disclaimer'
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_domain_domain_name_disclaimer_post(domain_name:, service:, email_exchange_organization_name_service_exchange_service_doma_h2c9d9cb2:) ⇒ Object

Raises:

  • (ArgumentError) 


457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 457

def service_domain_domain_name_disclaimer_post(domain_name:, service:, email_exchange_organization_name_service_exchange_service_doma_h2c9d9cb2:)
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'email_exchange_organization_name_service_exchange_service_doma_h2c9d9cb2 is required' if email_exchange_organization_name_service_exchange_service_doma_h2c9d9cb2.nil?

  @connection.call(
    :POST,
    '/email/mxplan/{service}/domain/{domainName}/disclaimer'
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: email_exchange_organization_name_service_exchange_service_doma_h2c9d9cb2
  )
end

#service_domain_domain_name_disclaimer_put(domain_name:, service:, email_pro_disclaimer:) ⇒ Object

Raises:

  • (ArgumentError) 


473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 473

def service_domain_domain_name_disclaimer_put(domain_name:, service:, email_pro_disclaimer:)
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'email_pro_disclaimer is required' if email_pro_disclaimer.nil?

  @connection.call(
    :PUT,
    '/email/mxplan/{service}/domain/{domainName}/disclaimer'
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: email_pro_disclaimer
  )
end

#service_domain_domain_name_get(domain_name:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 489

def service_domain_domain_name_get(domain_name:, service:)
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/domain/{domainName}'
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_domain_domain_name_put(domain_name:, service:, email_mxplan_domain:) ⇒ Object

Raises:

  • (ArgumentError) 


503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 503

def service_domain_domain_name_put(domain_name:, service:, email_mxplan_domain:)
  raise ArgumentError, 'domain_name is required' if domain_name.nil?
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'email_mxplan_domain is required' if email_mxplan_domain.nil?

  @connection.call(
    :PUT,
    '/email/mxplan/{service}/domain/{domainName}'
      .gsub('{domainName}', ERB::Util.url_encode(domain_name.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: email_mxplan_domain
  )
end

#service_domain_get(service:, state: nil) ⇒ Object

Raises:

  • (ArgumentError) 


519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 519

def service_domain_get(service:, state: nil)
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/domain'
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    query: { 'state' => state }
  )
end

#service_external_contact_external_email_address_delete(external_email_address:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 532

def service_external_contact_external_email_address_delete(external_email_address:, service:)
  raise ArgumentError, 'external_email_address is required' if external_email_address.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :DELETE,
    '/email/mxplan/{service}/externalContact/{externalEmailAddress}'
      .gsub('{externalEmailAddress}', ERB::Util.url_encode(external_email_address.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_external_contact_external_email_address_get(external_email_address:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 546

def service_external_contact_external_email_address_get(external_email_address:, service:)
  raise ArgumentError, 'external_email_address is required' if external_email_address.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/externalContact/{externalEmailAddress}'
      .gsub('{externalEmailAddress}', ERB::Util.url_encode(external_email_address.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_external_contact_external_email_address_put(external_email_address:, service:, email_mxplan_external_contact:) ⇒ Object

Raises:

  • (ArgumentError) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 560

def service_external_contact_external_email_address_put(external_email_address:, service:, email_mxplan_external_contact:)
  raise ArgumentError, 'external_email_address is required' if external_email_address.nil?
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'email_mxplan_external_contact is required' if email_mxplan_external_contact.nil?

  @connection.call(
    :PUT,
    '/email/mxplan/{service}/externalContact/{externalEmailAddress}'
      .gsub('{externalEmailAddress}', ERB::Util.url_encode(external_email_address.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: email_mxplan_external_contact
  )
end

#service_external_contact_get(service:, display_name: nil, external_email_address: nil, first_name: nil, id: nil, last_name: nil) ⇒ Object

Raises:

  • (ArgumentError) 


576
577
578
579
580
581
582
583
584
585
586
587
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 576

def service_external_contact_get(service:, display_name: nil, external_email_address: nil, first_name: nil, id: nil, last_name: nil)
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/externalContact'
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    query: { 'displayName' => display_name, 'externalEmailAddress' => external_email_address, 'firstName' => first_name, 'id' => id, 'lastName' => last_name }
  )
end

#service_external_contact_post(service:, email_mxplan_service_external_contact_post_request:) ⇒ Object

Raises:

  • (ArgumentError) 


589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 589

def service_external_contact_post(service:, email_mxplan_service_external_contact_post_request:)
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'email_mxplan_service_external_contact_post_request is required' if email_mxplan_service_external_contact_post_request.nil?

  @connection.call(
    :POST,
    '/email/mxplan/{service}/externalContact'
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: email_mxplan_service_external_contact_post_request
  )
end

#service_get(service:) ⇒ Object

Raises:

  • (ArgumentError) 


603
604
605
606
607
608
609
610
611
612
613
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 603

def service_get(service:)
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}'
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_put(service:, email_mxplan_service:) ⇒ Object

Raises:

  • (ArgumentError) 


615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 615

def service_put(service:, email_mxplan_service:)
  raise ArgumentError, 'service is required' if service.nil?
  raise ArgumentError, 'email_mxplan_service is required' if email_mxplan_service.nil?

  @connection.call(
    :PUT,
    '/email/mxplan/{service}'
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: [],
    body: email_mxplan_service
  )
end

#service_server_get(service:) ⇒ Object

Raises:

  • (ArgumentError) 


629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 629

def service_server_get(service:)
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/server'
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_task_get(service:) ⇒ Object

Raises:

  • (ArgumentError) 


641
642
643
644
645
646
647
648
649
650
651
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 641

def service_task_get(service:)
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/task'
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_task_id_get(id:, service:) ⇒ Object

Raises:

  • (ArgumentError) 


653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 653

def service_task_id_get(id:, service:)
  raise ArgumentError, 'id is required' if id.nil?
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :GET,
    '/email/mxplan/{service}/task/{id}'
      .gsub('{id}', ERB::Util.url_encode(id.to_s))
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end

#service_update_flags_on_all_accounts_post(service:) ⇒ Object

Raises:

  • (ArgumentError) 


667
668
669
670
671
672
673
674
675
676
677
 
# File 'lib/ovh-api/api/email/mxplan.rb', line 667

def service_update_flags_on_all_accounts_post(service:)
  raise ArgumentError, 'service is required' if service.nil?

  @connection.call(
    :POST,
    '/email/mxplan/{service}/updateFlagsOnAllAccounts'
      .gsub('{service}', ERB::Util.url_encode(service.to_s)),
    type: nil,
    auth: []
  )
end