class AsposeEmailCloud::ClientMessageAppendRequest

Email client append message request.

Attributes

account_location[RW]

Email client account configuration location on storage.

@return [StorageFileLocation]

folder[RW]

Path to folder on email server to append message to.

@return [String]

mark_as_sent[RW]

Determines that appended message should be market as sent or not.

@return [BOOLEAN]

message[RW]

Message to append.

@return [MailMessageBase]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/aspose-email-cloud/models/client_message_append_request.rb, line 44
def self.attribute_map
  {
    :'account_location' => :'accountLocation',
    :'folder' => :'folder',
    :'message' => :'message',
    :'mark_as_sent' => :'markAsSent'
  }
end
new( account_location: nil, folder: nil, message: nil, mark_as_sent: nil) click to toggle source

Initializes the object @param [StorageFileLocation] account_location Email client account configuration location on storage.

@param [String] folder Path to folder on email server to append message to.

@param [MailMessageBase] message Message to append.

@param [BOOLEAN] mark_as_sent Determines that appended message should be market as sent or not.

# File lib/aspose-email-cloud/models/client_message_append_request.rb, line 68
def initialize(
  account_location: nil,
  folder: nil,
  message: nil,
  mark_as_sent: nil)
  self.account_location = account_location if account_location
  self.folder = folder if folder
  self.message = message if message
  self.mark_as_sent = mark_as_sent if mark_as_sent
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose-email-cloud/models/client_message_append_request.rb, line 54
def self.swagger_types
  {
    :'account_location' => :'StorageFileLocation',
    :'folder' => :'String',
    :'message' => :'MailMessageBase',
    :'mark_as_sent' => :'BOOLEAN'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/aspose-email-cloud/models/client_message_append_request.rb, line 109
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      account_location == o.account_location &&
      folder == o.folder &&
      message == o.message &&
      mark_as_sent == o.mark_as_sent
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/aspose-email-cloud/models/client_message_append_request.rb, line 156
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
    sub_type = value[:type] || value[:discriminator] || type
    if AsposeEmailCloud.const_defined?(sub_type)
      type = sub_type
    end
    temp_model = AsposeEmailCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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/aspose-email-cloud/models/client_message_append_request.rb, line 226
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/aspose-email-cloud/models/client_message_append_request.rb, line 133
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    attribute_key = self.class.attribute_map[key]
    attribute_key = (attribute_key[0, 1].downcase + attribute_key[1..-1]).to_sym
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[attribute_key].is_a?(Array)
        self.send("#{key}=", attributes[attribute_key].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_key].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_key]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/aspose-email-cloud/models/client_message_append_request.rb, line 120
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/aspose-email-cloud/models/client_message_append_request.rb, line 126
def hash
  [account_location, folder, message, mark_as_sent].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/aspose-email-cloud/models/client_message_append_request.rb, line 81
def list_invalid_properties
  invalid_properties = Array.new
  if @account_location.nil?
    invalid_properties.push('invalid value for "account_location", account_location cannot be nil.')
  end

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

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

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/aspose-email-cloud/models/client_message_append_request.rb, line 206
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/aspose-email-cloud/models/client_message_append_request.rb, line 212
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/aspose-email-cloud/models/client_message_append_request.rb, line 200
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/aspose-email-cloud/models/client_message_append_request.rb, line 100
def valid?
  return false if @account_location.nil?
  return false if @message.nil?
  return false if @mark_as_sent.nil?
  true
end