Class: MailSlurpClient::ReplyToAliasEmailOptions

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

Overview

Options for replying to an alias email using the alias inbox

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReplyToAliasEmailOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
141
142
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
171
172
173
174
 
# File 'lib/mailslurp_client/models/reply_to_alias_email_options.rb', line 116

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::ReplyToAliasEmailOptions` 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::ReplyToAliasEmailOptions`. 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?(:'body')
    self.body = attributes[:'body']
  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?(:'custom_headers')
    if (value = attributes[:'custom_headers']).is_a?(Hash)
      self.custom_headers = value
    end
  end

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

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

Instance Attribute Details

#attachments ⇒ Object

List of uploaded attachments to send with the reply. Optional.



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

def attachments
  @attachments
end

#body ⇒ Object

Body of the reply email you want to send



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

def body
  @body
end

#charset ⇒ Object

The charset that your message should be sent with. Optional. Default is UTF-8



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

def charset
  @charset
end

#custom_headers ⇒ Object

Optional custom headers



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

def custom_headers
  @custom_headers
end

#html ⇒ Object

Returns the value of attribute html.



45
46
47
 
# File 'lib/mailslurp_client/models/reply_to_alias_email_options.rb', line 45

def html
  @html
end

#is_html ⇒ Object

Is the reply HTML



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

def is_html
  @is_html
end

#send_strategy ⇒ Object

How an email should be sent based on its recipients



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

def send_strategy
  @send_strategy
end

#template ⇒ Object

Template ID to use instead of body. Will use template variable map to fill defined variable slots.



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

def template
  @template
end

#template_variables ⇒ Object

Template variables if using a template



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

def template_variables
  @template_variables
end

#use_inbox_name ⇒ Object

Optionally use inbox name as display name for sender email address



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

def use_inbox_name
  @use_inbox_name
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/mailslurp_client/models/reply_to_alias_email_options.rb', line 70

def self.attribute_map
  {
    :'body' => :'body',
    :'is_html' => :'isHTML',
    :'charset' => :'charset',
    :'attachments' => :'attachments',
    :'template_variables' => :'templateVariables',
    :'template' => :'template',
    :'send_strategy' => :'sendStrategy',
    :'custom_headers' => :'customHeaders',
    :'use_inbox_name' => :'useInboxName',
    :'html' => :'html'
  }
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



243
244
245
 
# File 'lib/mailslurp_client/models/reply_to_alias_email_options.rb', line 243

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/mailslurp_client/models/reply_to_alias_email_options.rb', line 102

def self.openapi_nullable
  Set.new([
    :'charset',
    :'attachments',
    :'template_variables',
    :'template',
    :'send_strategy',
    :'custom_headers',
    :'use_inbox_name',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/mailslurp_client/models/reply_to_alias_email_options.rb', line 86

def self.openapi_types
  {
    :'body' => :'String',
    :'is_html' => :'Boolean',
    :'charset' => :'String',
    :'attachments' => :'Array<String>',
    :'template_variables' => :'Hash<String, Object>',
    :'template' => :'String',
    :'send_strategy' => :'String',
    :'custom_headers' => :'Hash<String, String>',
    :'use_inbox_name' => :'Boolean',
    :'html' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/mailslurp_client/models/reply_to_alias_email_options.rb', line 213

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      body == o.body &&
      is_html == o.is_html &&
      charset == o.charset &&
      attachments == o.attachments &&
      template_variables == o.template_variables &&
      template == o.template &&
      send_strategy == o.send_strategy &&
      custom_headers == o.custom_headers &&
      use_inbox_name == o.use_inbox_name &&
      html == o.html
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



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
 
# File 'lib/mailslurp_client/models/reply_to_alias_email_options.rb', line 271

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



340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/mailslurp_client/models/reply_to_alias_email_options.rb', line 340

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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/mailslurp_client/models/reply_to_alias_email_options.rb', line 250

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


230
231
232
 
# File 'lib/mailslurp_client/models/reply_to_alias_email_options.rb', line 230

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



236
237
238
 
# File 'lib/mailslurp_client/models/reply_to_alias_email_options.rb', line 236

def hash
  [body, is_html, charset, attachments, template_variables, template, send_strategy, custom_headers, use_inbox_name, html].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



178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/mailslurp_client/models/reply_to_alias_email_options.rb', line 178

def list_invalid_properties
  invalid_properties = Array.new
  if @body.nil?
    invalid_properties.push('invalid value for "body", body cannot be nil.')
  end

  if @is_html.nil?
    invalid_properties.push('invalid value for "is_html", is_html cannot be nil.')
  end

  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



316
317
318
 
# File 'lib/mailslurp_client/models/reply_to_alias_email_options.rb', line 316

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



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/mailslurp_client/models/reply_to_alias_email_options.rb', line 322

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



310
311
312
 
# File 'lib/mailslurp_client/models/reply_to_alias_email_options.rb', line 310

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



193
194
195
196
197
198
199
 
# File 'lib/mailslurp_client/models/reply_to_alias_email_options.rb', line 193

def valid?
  return false if @body.nil?
  return false if @is_html.nil?
  send_strategy_validator = EnumAttributeValidator.new('String', ["SINGLE_MESSAGE"])
  return false unless send_strategy_validator.valid?(@send_strategy)
  true
end