Class: MailSlurpClient::SendEmailOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/models/send_email_options.rb

Overview

Options for the email to be sent

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SendEmailOptions

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 204

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::SendEmailOptions` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::SendEmailOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'to_contacts')
    if (value = attributes[:'to_contacts']).is_a?(Array)
      self.to_contacts = value
    end
  end

  if attributes.key?(:'to_group')
    self.to_group = attributes[:'to_group']
  end

  if attributes.key?(:'to')
    if (value = attributes[:'to']).is_a?(Array)
      self.to = value
    end
  end

  if attributes.key?(:'from')
    self.from = attributes[:'from']
  end

  if attributes.key?(:'cc')
    if (value = attributes[:'cc']).is_a?(Array)
      self.cc = value
    end
  end

  if attributes.key?(:'bcc')
    if (value = attributes[:'bcc']).is_a?(Array)
      self.bcc = value
    end
  end

  if attributes.key?(:'subject')
    self.subject = attributes[:'subject']
  end

  if attributes.key?(:'reply_to')
    self.reply_to = attributes[:'reply_to']
  end

  if attributes.key?(:'custom_headers')
    if (value = attributes[:'custom_headers']).is_a?(Hash)
      self.custom_headers = value
    end
  end

  if attributes.key?(:'body')
    self.body = attributes[:'body']
  end

  if attributes.key?(:'html')
    self.html = attributes[:'html']
  end

  if attributes.key?(:'is_html')
    self.is_html = attributes[:'is_html']
  end

  if attributes.key?(:'charset')
    self.charset = attributes[:'charset']
  end

  if attributes.key?(:'attachments')
    if (value = attributes[:'attachments']).is_a?(Array)
      self.attachments = value
    end
  end

  if attributes.key?(:'template_variables')
    if (value = attributes[:'template_variables']).is_a?(Hash)
      self.template_variables = value
    end
  end

  if attributes.key?(:'template')
    self.template = attributes[:'template']
  end

  if attributes.key?(:'send_strategy')
    self.send_strategy = attributes[:'send_strategy']
  end

  if attributes.key?(:'use_inbox_name')
    self.use_inbox_name = attributes[:'use_inbox_name']
  end

  if attributes.key?(:'add_tracking_pixel')
    self.add_tracking_pixel = attributes[:'add_tracking_pixel']
  end

  if attributes.key?(:'filter_bounced_recipients')
    self.filter_bounced_recipients = attributes[:'filter_bounced_recipients']
  end

  if attributes.key?(:'validate_email_addresses')
    self.validate_email_addresses = attributes[:'validate_email_addresses']
  end

  if attributes.key?(:'ignore_empty_recipients')
    self.ignore_empty_recipients = attributes[:'ignore_empty_recipients']
  end

  if attributes.key?(:'is_x_amp_html')
    self.is_x_amp_html = attributes[:'is_x_amp_html']
  end

  if attributes.key?(:'body_parts')
    if (value = attributes[:'body_parts']).is_a?(Array)
      self.body_parts = value
    end
  end
end

Instance Attribute Details

#add_tracking_pixel ⇒ Object

Add tracking pixel to email



73
74
75
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 73

def add_tracking_pixel
  @add_tracking_pixel
end

#attachments ⇒ Object

Optional list of attachment IDs to send with this email. You must first upload each attachment separately via method call or dashboard in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded. There are several ways to upload that support `multi-part form`, `base64 file encoding`, and octet stream binary uploads. See the `UploadController` for available methods.



58
59
60
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 58

def attachments
  @attachments
end

#bcc ⇒ Object

Optional list of bcc destination email addresses



34
35
36
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 34

def bcc
  @bcc
end

#body ⇒ Object

Optional contents of email. If body contains HTML then set `isHTML` to true to ensure that email clients render it correctly. You can use moustache template syntax in the email body in conjunction with `toGroup` contact variables or `templateVariables` data. If you need more templating control consider creating a template and using the `template` property instead of the body.



46
47
48
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 46

def body
  @body
end

#body_parts ⇒ Object

Email body content parts for multipart mime message. Will override body.



88
89
90
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 88

def body_parts
  @body_parts
end

#cc ⇒ Object

Optional list of cc destination email addresses



31
32
33
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 31

def cc
  @cc
end

#charset ⇒ Object

Optional charset



55
56
57
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 55

def charset
  @charset
end

#custom_headers ⇒ Object

Optional custom headers



43
44
45
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 43

def custom_headers
  @custom_headers
end

#filter_bounced_recipients ⇒ Object

Filter recipients to remove any bounced recipients from to, bcc, and cc before sending



76
77
78
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 76

def filter_bounced_recipients
  @filter_bounced_recipients
end

#from ⇒ Object

Optional from address. Email address is RFC 5322 format and may include a display name and email in angle brackets (`my@address.com` or `My inbox <my@address.com>`). If no sender is set the source inbox address will be used for this field. If you set `useInboxName` to `true` the from field will include the inbox name as a display name: `inbox_name <inbox@address.com>`. For this to work use the name field when creating an inbox. Beware of potential spam penalties when setting the from field to an address not used by the inbox. Your emails may get blocked by services if you impersonate another address. To use a custom email addresses use a custom domain. You can create domains with the DomainController. The domain must be verified in the dashboard before it can be used.



28
29
30
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 28

def from
  @from
end

#html ⇒ Object

Optional HTML flag to indicate that contents is HTML. Set's a `content-type: text/html` for email. (Deprecated: use `isHTML` instead.)



49
50
51
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 49

def html
  @html
end

#ignore_empty_recipients ⇒ Object

Ignore empty recipients after validation removes all recipients as invalid and fail silently



82
83
84
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 82

def ignore_empty_recipients
  @ignore_empty_recipients
end

#is_html ⇒ Object

Optional HTML flag. If true the `content-type` of the email will be `text/html`. Set to true when sending HTML to ensure proper rending on email clients



52
53
54
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 52

def is_html
  @is_html
end

#is_x_amp_html ⇒ Object

Is content AMP4EMAIL compatible. If set will send as x-amp-html part.



85
86
87
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 85

def is_x_amp_html
  @is_x_amp_html
end

#reply_to ⇒ Object

Optional replyTo header



40
41
42
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 40

def reply_to
  @reply_to
end

#send_strategy ⇒ Object

How an email should be sent based on its recipients



67
68
69
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 67

def send_strategy
  @send_strategy
end

#subject ⇒ Object

Optional email subject line



37
38
39
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 37

def subject
  @subject
end

#template ⇒ Object

Optional template ID to use for body. Will override body if provided. When using a template make sure you pass the corresponding map of `templateVariables`. You can find which variables are needed by fetching the template itself or viewing it in the dashboard.



64
65
66
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 64

def template
  @template
end

#template_variables ⇒ Object

Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found.



61
62
63
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 61

def template_variables
  @template_variables
end

#to ⇒ Object

List of destination email addresses. Each email address must be RFC 5322 format. Even single recipients must be in array form. Maximum recipients per email depends on your plan. If you need to send many emails try using contacts or contact groups or use a non standard sendStrategy to ensure that spam filters are not triggered (many recipients in one email can affect your spam rating). Be cautious when sending emails that your recipients exist. High bounce rates (meaning a high percentage of emails cannot be delivered because an address does not exist) can result in account freezing.



25
26
27
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 25

def to
  @to
end

#to_contacts ⇒ Object

Optional list of contact IDs to send email to. Manage your contacts via the API or dashboard. When contacts are used the email is sent to each contact separately so they will not see other recipients.



19
20
21
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 19

def to_contacts
  @to_contacts
end

#to_group ⇒ Object

Optional contact group ID to send email to. You can create contacts and contact groups in the API or dashboard and use them for email campaigns. When contact groups are used the email is sent to each contact separately so they will not see other recipients



22
23
24
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 22

def to_group
  @to_group
end

#use_inbox_name ⇒ Object

Use name of inbox as sender email address name. Will construct RFC 5322 email address with `Inbox name <inbox@address.com>` if the inbox has a name.



70
71
72
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 70

def use_inbox_name
  @use_inbox_name
end

#validate_email_addresses ⇒ Object

Validate recipient email addresses before sending



79
80
81
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 79

def validate_email_addresses
  @validate_email_addresses
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 113

def self.attribute_map
  {
    :'to_contacts' => :'toContacts',
    :'to_group' => :'toGroup',
    :'to' => :'to',
    :'from' => :'from',
    :'cc' => :'cc',
    :'bcc' => :'bcc',
    :'subject' => :'subject',
    :'reply_to' => :'replyTo',
    :'custom_headers' => :'customHeaders',
    :'body' => :'body',
    :'html' => :'html',
    :'is_html' => :'isHTML',
    :'charset' => :'charset',
    :'attachments' => :'attachments',
    :'template_variables' => :'templateVariables',
    :'template' => :'template',
    :'send_strategy' => :'sendStrategy',
    :'use_inbox_name' => :'useInboxName',
    :'add_tracking_pixel' => :'addTrackingPixel',
    :'filter_bounced_recipients' => :'filterBouncedRecipients',
    :'validate_email_addresses' => :'validateEmailAddresses',
    :'ignore_empty_recipients' => :'ignoreEmptyRecipients',
    :'is_x_amp_html' => :'isXAmpHtml',
    :'body_parts' => :'bodyParts'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



413
414
415
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 413

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 173

def self.openapi_nullable
  Set.new([
    :'to_contacts',
    :'to_group',
    :'to',
    :'from',
    :'cc',
    :'bcc',
    :'subject',
    :'reply_to',
    :'custom_headers',
    :'body',
    :'html',
    :'is_html',
    :'charset',
    :'attachments',
    :'template_variables',
    :'template',
    :'send_strategy',
    :'use_inbox_name',
    :'add_tracking_pixel',
    :'filter_bounced_recipients',
    :'validate_email_addresses',
    :'ignore_empty_recipients',
    :'is_x_amp_html',
    :'body_parts'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 143

def self.openapi_types
  {
    :'to_contacts' => :'Array<String>',
    :'to_group' => :'String',
    :'to' => :'Array<String>',
    :'from' => :'String',
    :'cc' => :'Array<String>',
    :'bcc' => :'Array<String>',
    :'subject' => :'String',
    :'reply_to' => :'String',
    :'custom_headers' => :'Hash<String, String>',
    :'body' => :'String',
    :'html' => :'Boolean',
    :'is_html' => :'Boolean',
    :'charset' => :'String',
    :'attachments' => :'Array<String>',
    :'template_variables' => :'Hash<String, Object>',
    :'template' => :'String',
    :'send_strategy' => :'String',
    :'use_inbox_name' => :'Boolean',
    :'add_tracking_pixel' => :'Boolean',
    :'filter_bounced_recipients' => :'Boolean',
    :'validate_email_addresses' => :'String',
    :'ignore_empty_recipients' => :'Boolean',
    :'is_x_amp_html' => :'Boolean',
    :'body_parts' => :'Array<SendEmailBodyPart>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 369

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      to_contacts == o.to_contacts &&
      to_group == o.to_group &&
      to == o.to &&
      from == o.from &&
      cc == o.cc &&
      bcc == o.bcc &&
      subject == o.subject &&
      reply_to == o.reply_to &&
      custom_headers == o.custom_headers &&
      body == o.body &&
      html == o.html &&
      is_html == o.is_html &&
      charset == o.charset &&
      attachments == o.attachments &&
      template_variables == o.template_variables &&
      template == o.template &&
      send_strategy == o.send_strategy &&
      use_inbox_name == o.use_inbox_name &&
      add_tracking_pixel == o.add_tracking_pixel &&
      filter_bounced_recipients == o.filter_bounced_recipients &&
      validate_email_addresses == o.validate_email_addresses &&
      ignore_empty_recipients == o.ignore_empty_recipients &&
      is_x_amp_html == o.is_x_amp_html &&
      body_parts == o.body_parts
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 441

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    MailSlurpClient.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 510

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 420

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


400
401
402
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 400

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



406
407
408
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 406

def hash
  [to_contacts, to_group, to, from, cc, bcc, subject, reply_to, custom_headers, body, html, is_html, charset, attachments, template_variables, template, send_strategy, use_inbox_name, add_tracking_pixel, filter_bounced_recipients, validate_email_addresses, ignore_empty_recipients, is_x_amp_html, body_parts].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



332
333
334
335
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 332

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



486
487
488
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 486

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 492

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



480
481
482
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 480

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



339
340
341
342
343
344
345
 
# File 'lib/mailslurp_client/models/send_email_options.rb', line 339

def valid?
  send_strategy_validator = EnumAttributeValidator.new('String', ["SINGLE_MESSAGE"])
  return false unless send_strategy_validator.valid?(@send_strategy)
  validate_email_addresses_validator = EnumAttributeValidator.new('String', ["VALIDATE_FILTER_REMOVE_INVALID", "VALIDATE_ERROR_IF_INVALID", "NO_VALIDATION"])
  return false unless validate_email_addresses_validator.valid?(@validate_email_addresses)
  true
end