Class: Mimepost::Email

Inherits:
Object
  • Object
show all
Defined in:
lib/mimepost/models/email.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Email

Initializes the object

Parameters:

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

    Model attributes in the form of hash



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/mimepost/models/email.rb', line 71

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

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

  if attributes.has_key?(:'from_email')
    self.from_email = attributes[:'from_email']
  end

  if attributes.has_key?(:'from_name')
    self.from_name = attributes[:'from_name']
  end

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

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

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

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

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

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

Instance Attribute Details

#attachments ⇒ Object

Returns the value of attribute attachments.



33
34
35
 
# File 'lib/mimepost/models/email.rb', line 33

def attachments
  @attachments
end

#bcc ⇒ Object

Returns the value of attribute bcc.



31
32
33
 
# File 'lib/mimepost/models/email.rb', line 31

def bcc
  @bcc
end

#cc ⇒ Object

Returns the value of attribute cc.



29
30
31
 
# File 'lib/mimepost/models/email.rb', line 29

def cc
  @cc
end

#from_email ⇒ Object

Returns the value of attribute from_email.



21
22
23
 
# File 'lib/mimepost/models/email.rb', line 21

def from_email
  @from_email
end

#from_name ⇒ Object

Returns the value of attribute from_name.



23
24
25
 
# File 'lib/mimepost/models/email.rb', line 23

def from_name
  @from_name
end

#global_merge_vars ⇒ Object

Returns the value of attribute global_merge_vars.



25
26
27
 
# File 'lib/mimepost/models/email.rb', line 25

def global_merge_vars
  @global_merge_vars
end

#html ⇒ Object

Returns the value of attribute html.



17
18
19
 
# File 'lib/mimepost/models/email.rb', line 17

def html
  @html
end

#subject ⇒ Object

Returns the value of attribute subject.



19
20
21
 
# File 'lib/mimepost/models/email.rb', line 19

def subject
  @subject
end

#to ⇒ Object

Returns the value of attribute to.



27
28
29
 
# File 'lib/mimepost/models/email.rb', line 27

def to
  @to
end

#vars ⇒ Object

Returns the value of attribute vars.



35
36
37
 
# File 'lib/mimepost/models/email.rb', line 35

def vars
  @vars
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/mimepost/models/email.rb', line 38

def self.attribute_map
  {
    :'html' => :'html',
    :'subject' => :'subject',
    :'from_email' => :'from_email',
    :'from_name' => :'from_name',
    :'global_merge_vars' => :'global_merge_vars',
    :'to' => :'to',
    :'cc' => :'cc',
    :'bcc' => :'bcc',
    :'attachments' => :'attachments',
    :'vars' => :'vars'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/mimepost/models/email.rb', line 54

def self.swagger_types
  {
    :'html' => :'String',
    :'subject' => :'String',
    :'from_email' => :'String',
    :'from_name' => :'String',
    :'global_merge_vars' => :'Array<EmailGlobalMergeVars>',
    :'to' => :'Array<EmailTo>',
    :'cc' => :'Array<String>',
    :'bcc' => :'Array<String>',
    :'attachments' => :'Array<EmailAttachments>',
    :'vars' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/mimepost/models/email.rb', line 165

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      html == o.html &&
      subject == o.subject &&
      from_email == o.from_email &&
      from_name == o.from_name &&
      global_merge_vars == o.global_merge_vars &&
      to == o.to &&
      cc == o.cc &&
      bcc == o.bcc &&
      attachments == o.attachments &&
      vars == o.vars
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



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
 
# File 'lib/mimepost/models/email.rb', line 216

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
    temp_model = Mimepost.const_get(type).new
    temp_model.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



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/mimepost/models/email.rb', line 282

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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/mimepost/models/email.rb', line 195

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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


182
183
184
 
# File 'lib/mimepost/models/email.rb', line 182

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



188
189
190
 
# File 'lib/mimepost/models/email.rb', line 188

def hash
  [html, subject, from_email, from_name, global_merge_vars, to, cc, bcc, attachments, vars].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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/mimepost/models/email.rb', line 132

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

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

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

  if @to.nil?
    invalid_properties.push('invalid value for "to", to 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



262
263
264
 
# File 'lib/mimepost/models/email.rb', line 262

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



268
269
270
271
272
273
274
275
276
 
# File 'lib/mimepost/models/email.rb', line 268

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



256
257
258
 
# File 'lib/mimepost/models/email.rb', line 256

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



155
156
157
158
159
160
161
 
# File 'lib/mimepost/models/email.rb', line 155

def valid?
  return false if @html.nil?
  return false if @subject.nil?
  return false if @from_email.nil?
  return false if @to.nil?
  true
end