Class: AsposeEmailCloud::EmailClientAccount

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose-email-cloud/models/email_client_account.rb

Overview

A universal email client account

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(host: nil, port: nil, security_options: nil, protocol_type: nil, credentials: nil, cache_file: nil) ⇒ EmailClientAccount

Initializes the object

Parameters:

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

    Mail server host name or IP address

  • port (Integer) (defaults to: nil) —

    Mail server port

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

    Email account security mode. Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto

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

    Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav

  • credentials (EmailClientAccountCredentials) (defaults to: nil) —

    Email client account credentials

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

    File with messages cache. Used to provide extra functions, which are not supported by account



80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/aspose-email-cloud/models/email_client_account.rb', line 80

def initialize(
  host: nil,
  port: nil,
  security_options: nil,
  protocol_type: nil,
  credentials: nil,
  cache_file: nil)
  self.host = host if host
  self.port = port if port
  self.security_options = security_options if security_options
  self.protocol_type = protocol_type if protocol_type
  self.credentials = credentials if credentials
  self.cache_file = cache_file if cache_file
end

Instance Attribute Details

#cache_file ⇒ StorageFileLocation

File with messages cache. Used to provide extra functions, which are not supported by account

Returns:



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

def cache_file
  @cache_file
end

#credentials ⇒ EmailClientAccountCredentials

Email client account credentials

Returns:



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

def credentials
  @credentials
end

#host ⇒ String

Mail server host name or IP address

Returns:

  • (String) 


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

def host
  @host
end

#port ⇒ Integer

Mail server port

Returns:

  • (Integer) 


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

def port
  @port
end

#protocol_type ⇒ String

Type of connection protocol. Enum, available values: IMAP, POP3, SMTP, EWS, WebDav

Returns:

  • (String) 


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

def protocol_type
  @protocol_type
end

#security_options ⇒ String

Email account security mode. Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto

Returns:

  • (String) 


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

def security_options
  @security_options
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/aspose-email-cloud/models/email_client_account.rb', line 50

def self.attribute_map
  {
    :'host' => :'host',
    :'port' => :'port',
    :'security_options' => :'securityOptions',
    :'protocol_type' => :'protocolType',
    :'credentials' => :'credentials',
    :'cache_file' => :'cacheFile'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'host' => :'String',
    :'port' => :'Integer',
    :'security_options' => :'String',
    :'protocol_type' => :'String',
    :'credentials' => :'EmailClientAccountCredentials',
    :'cache_file' => :'StorageFileLocation'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



182
183
184
185
186
187
188
189
190
191
 
# File 'lib/aspose-email-cloud/models/email_client_account.rb', line 182

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      host == o.host &&
      port == o.port &&
      security_options == o.security_options &&
      protocol_type == o.protocol_type &&
      credentials == o.credentials &&
      cache_file == o.cache_file
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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/aspose-email-cloud/models/email_client_account.rb', line 231

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



301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/aspose-email-cloud/models/email_client_account.rb', line 301

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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/aspose-email-cloud/models/email_client_account.rb', line 208

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


195
196
197
 
# File 'lib/aspose-email-cloud/models/email_client_account.rb', line 195

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [host, port, security_options, protocol_type, credentials, cache_file].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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/aspose-email-cloud/models/email_client_account.rb', line 97

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

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

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

  if @port > 2147483647
    invalid_properties.push('invalid value for "port", must be smaller than or equal to 2147483647.')
  end

  if @port < 1
    invalid_properties.push('invalid value for "port", must be greater than or equal to 1.')
  end

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

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

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



281
282
283
 
# File 'lib/aspose-email-cloud/models/email_client_account.rb', line 281

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



287
288
289
290
291
292
293
294
295
 
# File 'lib/aspose-email-cloud/models/email_client_account.rb', line 287

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



275
276
277
 
# File 'lib/aspose-email-cloud/models/email_client_account.rb', line 275

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



136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/aspose-email-cloud/models/email_client_account.rb', line 136

def valid?
  return false if @host.nil?
  return false if @host.to_s.length < 1
  return false if @port.nil?
  return false if @port > 2147483647
  return false if @port < 1
  return false if @security_options.nil?
  return false if @protocol_type.nil?
  return false if @credentials.nil?
  true
end