Class: AsposeEmailCloud::EmailAccountConfig

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

Overview

Email account configuration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(display_name = nil, protocol_type = nil, host = nil, port = nil, socket_type = nil, authentication_types = nil, extra_info = nil, is_validated = nil) ⇒ EmailAccountConfig

Initializes the object

Parameters:

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

    Email account display name

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

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

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

    Email account host.

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

    Port.

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

    Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto

  • authentication_types (Array<String>) (defaults to: nil) —

    Supported authentication types. Items: Email account authentication types. Enum, available values: NoAuth, OAuth2, PasswordCleartext, PasswordEncrypted, SmtpAfterPop, ClientIpAddress

  • extra_info (Array<NameValuePair>) (defaults to: nil) —

    Extra account information.

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

    Determines that configuration validated. Set to false if validation skipped.



94
95
96
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
133
134
135
 
# File 'lib/aspose-email-cloud/models/email_account_config.rb', line 94

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'displayName')
    self.display_name = attributes[:'displayName']
  end

  if attributes.has_key?(:'protocolType')
    self.protocol_type = attributes[:'protocolType']
  end

  if attributes.has_key?(:'host')
    self.host = attributes[:'host']
  end

  if attributes.has_key?(:'port')
    self.port = attributes[:'port']
  end

  if attributes.has_key?(:'socketType')
    self.socket_type = attributes[:'socketType']
  end

  if attributes.has_key?(:'authenticationTypes')
    if (value = attributes[:'authenticationTypes']).is_a?(Array)
      self.authentication_types = value
    end
  end

  if attributes.has_key?(:'extraInfo')
    if (value = attributes[:'extraInfo']).is_a?(Array)
      self.extra_info = value
    end
  end

  if attributes.has_key?(:'isValidated')
    self.is_validated = attributes[:'isValidated']
  end
end

Instance Attribute Details

#authentication_types ⇒ Array<String>

Supported authentication types. Items: Email account authentication types. Enum, available values: NoAuth, OAuth2, PasswordCleartext, PasswordEncrypted, SmtpAfterPop, ClientIpAddress

Returns:

  • (Array<String>) 


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

def authentication_types
  @authentication_types
end

#display_name ⇒ String

Email account display name

Returns:

  • (String) 


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

def display_name
  @display_name
end

#extra_info ⇒ Array<NameValuePair>

Extra account information.

Returns:



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

def extra_info
  @extra_info
end

#host ⇒ String

Email account host.

Returns:

  • (String) 


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

def host
  @host
end

#is_validated ⇒ BOOLEAN

Determines that configuration validated. Set to false if validation skipped.

Returns:

  • (BOOLEAN) 


62
63
64
 
# File 'lib/aspose-email-cloud/models/email_account_config.rb', line 62

def is_validated
  @is_validated
end

#port ⇒ Integer

Port.

Returns:

  • (Integer) 


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

def port
  @port
end

#protocol_type ⇒ String

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

Returns:

  • (String) 


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

def protocol_type
  @protocol_type
end

#socket_type ⇒ String

Enum, available values: None, SSLExplicit, SSLImplicit, SSLAuto, Auto

Returns:

  • (String) 


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

def socket_type
  @socket_type
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/aspose-email-cloud/models/email_account_config.rb', line 65

def self.attribute_map
  {
    :'display_name' => :'displayName',
    :'protocol_type' => :'protocolType',
    :'host' => :'host',
    :'port' => :'port',
    :'socket_type' => :'socketType',
    :'authentication_types' => :'authenticationTypes',
    :'extra_info' => :'extraInfo',
    :'is_validated' => :'isValidated'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'display_name' => :'String',
    :'protocol_type' => :'String',
    :'host' => :'String',
    :'port' => :'Integer',
    :'socket_type' => :'String',
    :'authentication_types' => :'Array<String>',
    :'extra_info' => :'Array<NameValuePair>',
    :'is_validated' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/aspose-email-cloud/models/email_account_config.rb', line 187

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      display_name == o.display_name &&
      protocol_type == o.protocol_type &&
      host == o.host &&
      port == o.port &&
      socket_type == o.socket_type &&
      authentication_types == o.authentication_types &&
      extra_info == o.extra_info &&
      is_validated == o.is_validated
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



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
272
273
274
275
 
# File 'lib/aspose-email-cloud/models/email_account_config.rb', line 238

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
    type = value[:type] || type
    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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/aspose-email-cloud/models/email_account_config.rb', line 305

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/aspose-email-cloud/models/email_account_config.rb', line 215

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



208
209
210
 
# File 'lib/aspose-email-cloud/models/email_account_config.rb', line 208

def hash
  [display_name, protocol_type, host, port, socket_type, authentication_types, extra_info, is_validated].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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/aspose-email-cloud/models/email_account_config.rb', line 159

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

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

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



285
286
287
 
# File 'lib/aspose-email-cloud/models/email_account_config.rb', line 285

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



291
292
293
294
295
296
297
298
299
 
# File 'lib/aspose-email-cloud/models/email_account_config.rb', line 291

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



279
280
281
 
# File 'lib/aspose-email-cloud/models/email_account_config.rb', line 279

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



178
179
180
181
182
183
 
# File 'lib/aspose-email-cloud/models/email_account_config.rb', line 178

def valid?
  return false if @protocol_type.nil?
  return false if @socket_type.nil?
  return false if @is_validated.nil?
  true
end