Class: AsposeEmailCloud::Attachment

Inherits:
AttachmentBase show all
Defined in:
lib/aspose-email-cloud/models/attachment.rb

Overview

Document attachment.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base64_data: nil, content_id: nil, content_type: nil, headers: nil, content_disposition: nil, is_embedded_message: nil, name: nil, name_encoding: nil, preferred_text_encoding: nil) ⇒ Attachment

Initializes the object

Parameters:

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

    Attachment file content as Base64 string.

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

    Attachment content id

  • content_type (ContentType) (defaults to: nil) —

    Content type

  • headers (Hash<String, String>) (defaults to: nil) —

    Attachment headers.

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

    Content-Disposition header. Read only.

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

    Determines if attachment is an embedded message. Read only.

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

    Attachment name.

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

    Encoding of attachment name.

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

    Preferred text encoding.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/aspose-email-cloud/models/attachment.rb', line 98

def initialize(
  base64_data: nil,
  content_id: nil,
  content_type: nil,
  headers: nil,
  content_disposition: nil,
  is_embedded_message: nil,
  name: nil,
  name_encoding: nil,
  preferred_text_encoding: nil)
  self.base64_data = base64_data if base64_data
  self.content_id = content_id if content_id
  self.content_type = content_type if content_type
  self.headers = headers if headers
  self.content_disposition = content_disposition if content_disposition
  self.is_embedded_message = is_embedded_message if is_embedded_message
  self.name = name if name
  self.name_encoding = name_encoding if name_encoding
  self.preferred_text_encoding = preferred_text_encoding if preferred_text_encoding
end

Instance Attribute Details

#base64_data ⇒ String

Attachment file content as Base64 string.

Returns:

  • (String) 


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

def base64_data
  @base64_data
end

#content_disposition ⇒ String

Content-Disposition header. Read only.

Returns:

  • (String) 


45
46
47
 
# File 'lib/aspose-email-cloud/models/attachment.rb', line 45

def content_disposition
  @content_disposition
end

#content_id ⇒ String

Attachment content id

Returns:

  • (String) 


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

def content_id
  @content_id
end

#content_type ⇒ ContentType

Content type

Returns:



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

def content_type
  @content_type
end

#headers ⇒ Hash<String, String>

Attachment headers.

Returns:

  • (Hash<String, String>) 


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

def headers
  @headers
end

#is_embedded_message ⇒ BOOLEAN

Determines if attachment is an embedded message. Read only.

Returns:

  • (BOOLEAN) 


48
49
50
 
# File 'lib/aspose-email-cloud/models/attachment.rb', line 48

def is_embedded_message
  @is_embedded_message
end

#name ⇒ String

Attachment name.

Returns:

  • (String) 


51
52
53
 
# File 'lib/aspose-email-cloud/models/attachment.rb', line 51

def name
  @name
end

#name_encoding ⇒ String

Encoding of attachment name.

Returns:

  • (String) 


54
55
56
 
# File 'lib/aspose-email-cloud/models/attachment.rb', line 54

def name_encoding
  @name_encoding
end

#preferred_text_encoding ⇒ String

Preferred text encoding.

Returns:

  • (String) 


57
58
59
 
# File 'lib/aspose-email-cloud/models/attachment.rb', line 57

def preferred_text_encoding
  @preferred_text_encoding
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/aspose-email-cloud/models/attachment.rb', line 59

def self.attribute_map
  {
    :'base64_data' => :'base64Data',
    :'content_id' => :'contentId',
    :'content_type' => :'contentType',
    :'headers' => :'headers',
    :'content_disposition' => :'contentDisposition',
    :'is_embedded_message' => :'isEmbeddedMessage',
    :'name' => :'name',
    :'name_encoding' => :'nameEncoding',
    :'preferred_text_encoding' => :'preferredTextEncoding'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/aspose-email-cloud/models/attachment.rb', line 74

def self.swagger_types
  {
    :'base64_data' => :'String',
    :'content_id' => :'String',
    :'content_type' => :'ContentType',
    :'headers' => :'Hash<String, String>',
    :'content_disposition' => :'String',
    :'is_embedded_message' => :'BOOLEAN',
    :'name' => :'String',
    :'name_encoding' => :'String',
    :'preferred_text_encoding' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/aspose-email-cloud/models/attachment.rb', line 139

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      base64_data == o.base64_data &&
      content_id == o.content_id &&
      content_type == o.content_type &&
      headers == o.headers &&
      content_disposition == o.content_disposition &&
      is_embedded_message == o.is_embedded_message &&
      name == o.name &&
      name_encoding == o.name_encoding &&
      preferred_text_encoding == o.preferred_text_encoding
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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/aspose-email-cloud/models/attachment.rb', line 191

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



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/aspose-email-cloud/models/attachment.rb', line 261

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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/aspose-email-cloud/models/attachment.rb', line 168

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


155
156
157
 
# File 'lib/aspose-email-cloud/models/attachment.rb', line 155

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



161
162
163
 
# File 'lib/aspose-email-cloud/models/attachment.rb', line 161

def hash
  [base64_data, content_id, content_type, headers, content_disposition, is_embedded_message, name, name_encoding, preferred_text_encoding].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if @is_embedded_message.nil?
    invalid_properties.push('invalid value for "is_embedded_message", is_embedded_message 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



241
242
243
 
# File 'lib/aspose-email-cloud/models/attachment.rb', line 241

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



247
248
249
250
251
252
253
254
255
 
# File 'lib/aspose-email-cloud/models/attachment.rb', line 247

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



235
236
237
 
# File 'lib/aspose-email-cloud/models/attachment.rb', line 235

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



132
133
134
135
 
# File 'lib/aspose-email-cloud/models/attachment.rb', line 132

def valid?
  return false if @is_embedded_message.nil?
  true
end