Class: AsposeEmailCloud::ClientMessageAppendRequest

Inherits:
ClientAccountBaseRequest show all
Defined in:
lib/aspose-email-cloud/models/client_message_append_request.rb

Overview

Email client append message request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(account_location: nil, folder: nil, message: nil, mark_as_sent: nil) ⇒ ClientMessageAppendRequest

Initializes the object

Parameters:

  • account_location (StorageFileLocation) (defaults to: nil) —

    Email client account configuration location on storage.

  • folder (String) (defaults to: nil) —

    Path to folder on email server to append message to.

  • message (MailMessageBase) (defaults to: nil) —

    Message to append.

  • mark_as_sent (BOOLEAN) (defaults to: nil) —

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



68
69
70
71
72
73
74
75
76
77
 
# 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. =  if 
  self.folder = folder if folder
  self.message = message if message
  self.mark_as_sent = mark_as_sent if mark_as_sent
end

Instance Attribute Details

#account_location ⇒ StorageFileLocation

Email client account configuration location on storage.

Returns:



33
34
35
 
# File 'lib/aspose-email-cloud/models/client_message_append_request.rb', line 33

def 
  @account_location
end

#folder ⇒ String

Path to folder on email server to append message to.

Returns:

  • (String) 


36
37
38
 
# File 'lib/aspose-email-cloud/models/client_message_append_request.rb', line 36

def folder
  @folder
end

#mark_as_sent ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


42
43
44
 
# File 'lib/aspose-email-cloud/models/client_message_append_request.rb', line 42

def mark_as_sent
  @mark_as_sent
end

#message ⇒ MailMessageBase

Message to append.

Returns:



39
40
41
 
# File 'lib/aspose-email-cloud/models/client_message_append_request.rb', line 39

def message
  @message
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



109
110
111
112
113
114
115
116
 
# 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 &&
       == o. &&
      folder == o.folder &&
      message == o.message &&
      mark_as_sent == o.mark_as_sent
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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# 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) ⇒ 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



226
227
228
229
230
231
232
233
234
235
236
237
238
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


120
121
122
 
# File 'lib/aspose-email-cloud/models/client_message_append_request.rb', line 120

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



126
127
128
 
# File 'lib/aspose-email-cloud/models/client_message_append_request.rb', line 126

def hash
  [, folder, message, mark_as_sent].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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# 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 ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



206
207
208
 
# File 'lib/aspose-email-cloud/models/client_message_append_request.rb', line 206

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



212
213
214
215
216
217
218
219
220
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



200
201
202
 
# File 'lib/aspose-email-cloud/models/client_message_append_request.rb', line 200

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



100
101
102
103
104
105
 
# 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