class MailSlurpClient::EmailProjection
A compact representation of a full email. Used in list endpoints to keep response sizes low. Body and attachments are not included. To get all fields of the email use the `getEmail` method with the email projection's ID. See `EmailDto` for documentation on projection properties.
Attributes
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/mailslurp_client/models/email_projection.rb, line 45 def self.attribute_map { :'attachments' => :'attachments', :'bcc' => :'bcc', :'body_excerpt' => :'bodyExcerpt', :'body_md5_hash' => :'bodyMD5Hash', :'cc' => :'cc', :'created_at' => :'createdAt', :'from' => :'from', :'id' => :'id', :'inbox_id' => :'inboxId', :'read' => :'read', :'subject' => :'subject', :'team_access' => :'teamAccess', :'to' => :'to' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/mailslurp_client/models/email_projection.rb, line 232 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/mailslurp_client/models/email_projection.rb, line 90 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::EmailProjection` 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::EmailProjection`. 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?(:'attachments') if (value = attributes[:'attachments']).is_a?(Array) self.attachments = value end end if attributes.key?(:'bcc') if (value = attributes[:'bcc']).is_a?(Array) self.bcc = value end end if attributes.key?(:'body_excerpt') self.body_excerpt = attributes[:'body_excerpt'] end if attributes.key?(:'body_md5_hash') self.body_md5_hash = attributes[:'body_md5_hash'] end if attributes.key?(:'cc') if (value = attributes[:'cc']).is_a?(Array) self.cc = value end end if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.key?(:'from') self.from = attributes[:'from'] end if attributes.key?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'inbox_id') self.inbox_id = attributes[:'inbox_id'] end if attributes.key?(:'read') self.read = attributes[:'read'] end if attributes.key?(:'subject') self.subject = attributes[:'subject'] end if attributes.key?(:'team_access') self.team_access = attributes[:'team_access'] end if attributes.key?(:'to') if (value = attributes[:'to']).is_a?(Array) self.to = value end end end
List of attributes with nullable: true
# File lib/mailslurp_client/models/email_projection.rb, line 83 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/mailslurp_client/models/email_projection.rb, line 64 def self.openapi_types { :'attachments' => :'Array<String>', :'bcc' => :'Array<String>', :'body_excerpt' => :'String', :'body_md5_hash' => :'String', :'cc' => :'Array<String>', :'created_at' => :'DateTime', :'from' => :'String', :'id' => :'String', :'inbox_id' => :'String', :'read' => :'Boolean', :'subject' => :'String', :'team_access' => :'Boolean', :'to' => :'Array<String>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/mailslurp_client/models/email_projection.rb, line 199 def ==(o) return true if self.equal?(o) self.class == o.class && attachments == o.attachments && bcc == o.bcc && body_excerpt == o.body_excerpt && body_md5_hash == o.body_md5_hash && cc == o.cc && created_at == o.created_at && from == o.from && id == o.id && inbox_id == o.inbox_id && read == o.read && subject == o.subject && team_access == o.team_access && to == o.to end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/mailslurp_client/models/email_projection.rb, line 260 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/mailslurp_client/models/email_projection.rb, line 329 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/mailslurp_client/models/email_projection.rb, line 239 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
@see the `==` method @param [Object] Object to be compared
# File lib/mailslurp_client/models/email_projection.rb, line 219 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/mailslurp_client/models/email_projection.rb, line 225 def hash [attachments, bcc, body_excerpt, body_md5_hash, cc, created_at, from, id, inbox_id, read, subject, team_access, to].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/mailslurp_client/models/email_projection.rb, line 166 def list_invalid_properties invalid_properties = Array.new if @created_at.nil? invalid_properties.push('invalid value for "created_at", created_at cannot be nil.') end if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @inbox_id.nil? invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.') end if @to.nil? invalid_properties.push('invalid value for "to", to cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/mailslurp_client/models/email_projection.rb, line 311 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/mailslurp_client/models/email_projection.rb, line 299 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/mailslurp_client/models/email_projection.rb, line 189 def valid? return false if @created_at.nil? return false if @id.nil? return false if @inbox_id.nil? return false if @to.nil? true end