class PureCloud::EmailMessage
Attributes
The attachments of the email message.
The recipients that were blind copied on the email message.
The recipients that were copied on the email message.
The sender of the email message.
Indicates whether the history of previous emails of the conversation is included within the email bodies of this message.
The html body of the email message.
The globally unique identifier for the object.
The URI for this object
The subject of the email message.
The text body of the email message.
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
The recipients of the email message.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/email_message.rb, line 60 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', :'history_included' => :'historyIncluded', :'self_uri' => :'selfUri' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/email_message.rb, line 127 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?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] 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?(:'from') self.from = attributes[:'from'] end if attributes.has_key?(:'subject') self.subject = attributes[:'subject'] end if attributes.has_key?(:'attachments') if (value = attributes[:'attachments']).is_a?(Array) self.attachments = value end end if attributes.has_key?(:'textBody') self.text_body = attributes[:'textBody'] end if attributes.has_key?(:'htmlBody') self.html_body = attributes[:'htmlBody'] end if attributes.has_key?(:'time') self.time = attributes[:'time'] end if attributes.has_key?(:'historyIncluded') self.history_included = attributes[:'historyIncluded'] end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/email_message.rb, line 93 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', :'history_included' => :'BOOLEAN', :'self_uri' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/email_message.rb, line 411 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 && history_included == o.history_included && self_uri == o.self_uri end
# File lib/purecloudplatformclientv2/models/email_message.rb, line 461 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 =~ /^(true|t|yes|y|1)$/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 _model = Object.const_get("PureCloud").const_get(type).new _model.build_from_hash(value) end end
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloudplatformclientv2/models/email_message.rb, line 521 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 the object from hash
# File lib/purecloudplatformclientv2/models/email_message.rb, line 442 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
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/email_message.rb, line 431 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/email_message.rb, line 437 def hash [id, name, to, cc, bcc, from, subject, attachments, text_body, html_body, time, history_included, self_uri].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/email_message.rb, line 263 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/email_message.rb, line 509 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
# File lib/purecloudplatformclientv2/models/email_message.rb, line 499 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/purecloudplatformclientv2/models/email_message.rb, line 272 def valid? if @to.nil? return false end if @from.nil? return false end if @text_body.nil? return false end end