Class: PureCloud::EmailMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/email_message.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailMessage

Returns a new instance of EmailMessage.



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
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
 
# File 'lib/purecloud/models/email_message.rb', line 90

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

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

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'to']
    if (value = attributes[:'to']).is_a?(Array)
      self.to = value
    end
  end
  
  if attributes[:'cc']
    if (value = attributes[:'cc']).is_a?(Array)
      self.cc = value
    end
  end
  
  if attributes[:'bcc']
    if (value = attributes[:'bcc']).is_a?(Array)
      self.bcc = value
    end
  end
  
  if attributes[:'from']
    self.from = attributes[:'from']
  end
  
  if attributes[:'subject']
    self.subject = attributes[:'subject']
  end
  
  if attributes[:'attachments']
    if (value = attributes[:'attachments']).is_a?(Array)
      self.attachments = value
    end
  end
  
  if attributes[:'textBody']
    self.text_body = attributes[:'textBody']
  end
  
  if attributes[:'htmlBody']
    self.html_body = attributes[:'htmlBody']
  end
  
  if attributes[:'time']
    self.time = attributes[:'time']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#attachments ⇒ Object

The attachments of the email message.



26
27
28
 
# File 'lib/purecloud/models/email_message.rb', line 26

def attachments
  @attachments
end

#bcc ⇒ Object

The recipients that were blind copied on the email message.



17
18
19
 
# File 'lib/purecloud/models/email_message.rb', line 17

def bcc
  @bcc
end

#cc ⇒ Object

The recipients that were copied on the email message.



14
15
16
 
# File 'lib/purecloud/models/email_message.rb', line 14

def cc
  @cc
end

#from ⇒ Object

The sender of the email message.



20
21
22
 
# File 'lib/purecloud/models/email_message.rb', line 20

def from
  @from
end

#html_body ⇒ Object

The html body of the email message.



32
33
34
 
# File 'lib/purecloud/models/email_message.rb', line 32

def html_body
  @html_body
end

#id ⇒ Object

The globally unique identifier for the object.



6
7
8
 
# File 'lib/purecloud/models/email_message.rb', line 6

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



8
9
10
 
# File 'lib/purecloud/models/email_message.rb', line 8

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



38
39
40
 
# File 'lib/purecloud/models/email_message.rb', line 38

def self_uri
  @self_uri
end

#subject ⇒ Object

The subject of the email message.



23
24
25
 
# File 'lib/purecloud/models/email_message.rb', line 23

def subject
  @subject
end

#text_body ⇒ Object

The text body of the email message.



29
30
31
 
# File 'lib/purecloud/models/email_message.rb', line 29

def text_body
  @text_body
end

#time ⇒ Object

The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



35
36
37
 
# File 'lib/purecloud/models/email_message.rb', line 35

def time
  @time
end

#to ⇒ Object

The recipients of the email message.



11
12
13
 
# File 'lib/purecloud/models/email_message.rb', line 11

def to
  @to
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/purecloud/models/email_message.rb', line 41

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'to' => :'to',
    
    :'cc' => :'cc',
    
    :'bcc' => :'bcc',
    
    :'from' => :'from',
    
    :'subject' => :'subject',
    
    :'attachments' => :'attachments',
    
    :'text_body' => :'textBody',
    
    :'html_body' => :'htmlBody',
    
    :'time' => :'time',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/purecloud/models/email_message.rb', line 72

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'to' => :'Array<EmailAddress>',
    :'cc' => :'Array<EmailAddress>',
    :'bcc' => :'Array<EmailAddress>',
    :'from' => :'EmailAddress',
    :'subject' => :'String',
    :'attachments' => :'Array<Attachment>',
    :'text_body' => :'String',
    :'html_body' => :'String',
    :'time' => :'DateTime',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/purecloud/models/email_message.rb', line 156

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      to == o.to &&
      cc == o.cc &&
      bcc == o.bcc &&
      from == o.from &&
      subject == o.subject &&
      attachments == o.attachments &&
      text_body == o.text_body &&
      html_body == o.html_body &&
      time == o.time &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



203
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
 
# File 'lib/purecloud/models/email_message.rb', line 203

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

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



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/purecloud/models/email_message.rb', line 260

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

build the object from hash



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/purecloud/models/email_message.rb', line 184

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


174
175
176
 
# File 'lib/purecloud/models/email_message.rb', line 174

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



179
180
181
 
# File 'lib/purecloud/models/email_message.rb', line 179

def hash
  [id, name, to, cc, bcc, from, subject, attachments, text_body, html_body, time, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



243
244
245
 
# File 'lib/purecloud/models/email_message.rb', line 243

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



248
249
250
251
252
253
254
255
256
 
# File 'lib/purecloud/models/email_message.rb', line 248

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 ⇒ Object 



238
239
240
 
# File 'lib/purecloud/models/email_message.rb', line 238

def to_s
  to_hash.to_s
end