Class: AsposeEmailCloud::MailMessageBase64

Inherits:
MailMessageBase show all
Defined in:
lib/aspose-email-cloud/models/mail_message_base64.rb

Overview

Email message represented as file, encoded to Base64 format.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(value_base64: nil, format: nil) ⇒ MailMessageBase64

Initializes the object

Parameters:

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

    Email message file data encoded to Base64 string.

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

    Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft



65
66
67
68
69
70
 
# File 'lib/aspose-email-cloud/models/mail_message_base64.rb', line 65

def initialize(#,
  value_base64: nil,
  format: nil)
  self.value_base64 = value_base64 if value_base64
  self.format = format if format
end

Instance Attribute Details

#format ⇒ String

Email document format. Enum, available values: Eml, Msg, MsgUnicode, Mhtml, Html, Tnef, Oft

Returns:

  • (String) 


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

def format
  @format
end

#value_base64 ⇒ String

Email message file data encoded to Base64 string.

Returns:

  • (String) 


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

def value_base64
  @value_base64
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
 
# File 'lib/aspose-email-cloud/models/mail_message_base64.rb', line 45

def self.attribute_map
  {
    :'discriminator' => :'discriminator',
    :'value_base64' => :'valueBase64',
    :'format' => :'format'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
 
# File 'lib/aspose-email-cloud/models/mail_message_base64.rb', line 54

def self.swagger_types
  {
    :'discriminator' => :'String',
    :'value_base64' => :'String',
    :'format' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



121
122
123
124
125
126
127
 
# File 'lib/aspose-email-cloud/models/mail_message_base64.rb', line 121

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      discriminator == o.discriminator &&
      value_base64 == o.value_base64 &&
      format == o.format
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



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
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/aspose-email-cloud/models/mail_message_base64.rb', line 167

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



237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/aspose-email-cloud/models/mail_message_base64.rb', line 237

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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/aspose-email-cloud/models/mail_message_base64.rb', line 144

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

#discriminator ⇒ Object

getter method



31
32
33
 
# File 'lib/aspose-email-cloud/models/mail_message_base64.rb', line 31

def discriminator #getter method
  self.class.name.split('::').last
end

#discriminator=(discriminator) ⇒ Object

setter method, parameter ignored



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

def discriminator=(discriminator) #setter method, parameter ignored
  @discriminator = self.class.name.split('::').last
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


131
132
133
 
# File 'lib/aspose-email-cloud/models/mail_message_base64.rb', line 131

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



137
138
139
 
# File 'lib/aspose-email-cloud/models/mail_message_base64.rb', line 137

def hash
  [discriminator, value_base64, format].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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/aspose-email-cloud/models/mail_message_base64.rb', line 74

def list_invalid_properties
  invalid_properties = Array.new
  if @discriminator.nil?
    invalid_properties.push('invalid value for "discriminator", discriminator cannot be nil.')
  end

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

  if @value_base64.to_s.length < 1
    invalid_properties.push('invalid value for "value_base64", the character length must be great than or equal to 1.')
  end

  if @format.nil?
    invalid_properties.push('invalid value for "format", format 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



217
218
219
 
# File 'lib/aspose-email-cloud/models/mail_message_base64.rb', line 217

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



223
224
225
226
227
228
229
230
231
 
# File 'lib/aspose-email-cloud/models/mail_message_base64.rb', line 223

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



211
212
213
 
# File 'lib/aspose-email-cloud/models/mail_message_base64.rb', line 211

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



97
98
99
100
101
102
103
 
# File 'lib/aspose-email-cloud/models/mail_message_base64.rb', line 97

def valid?
  return false if @discriminator.nil?
  return false if @value_base64.nil?
  return false if @value_base64.to_s.length < 1
  return false if @format.nil?
  true
end