Class: MailSlurpClient::CreateConnectorImapConnectionOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/models/create_connector_imap_connection_options.rb

Overview

Options for IMAP connection to external email inbox. Allows syncing emails via IMAP.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateConnectorImapConnectionOptions

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
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
197
198
199
200
201
202
203
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 123

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::CreateConnectorImapConnectionOptions` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::CreateConnectorImapConnectionOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'imap_ssl')
    self.imap_ssl = attributes[:'imap_ssl']
  end

  if attributes.key?(:'imap_username')
    self.imap_username = attributes[:'imap_username']
  end

  if attributes.key?(:'imap_password')
    self.imap_password = attributes[:'imap_password']
  end

  if attributes.key?(:'select_folder')
    self.select_folder = attributes[:'select_folder']
  end

  if attributes.key?(:'search_terms')
    self.search_terms = attributes[:'search_terms']
  end

  if attributes.key?(:'imap_port')
    self.imap_port = attributes[:'imap_port']
  end

  if attributes.key?(:'imap_host')
    self.imap_host = attributes[:'imap_host']
  end

  if attributes.key?(:'enabled')
    self.enabled = attributes[:'enabled']
  end

  if attributes.key?(:'start_tls')
    self.start_tls = attributes[:'start_tls']
  end

  if attributes.key?(:'proxy_enabled')
    self.proxy_enabled = attributes[:'proxy_enabled']
  end

  if attributes.key?(:'proxy_port')
    self.proxy_port = attributes[:'proxy_port']
  end

  if attributes.key?(:'proxy_host')
    self.proxy_host = attributes[:'proxy_host']
  end

  if attributes.key?(:'local_host_name')
    self.local_host_name = attributes[:'local_host_name']
  end

  if attributes.key?(:'mechanisms')
    if (value = attributes[:'mechanisms']).is_a?(Array)
      self.mechanisms = value
    end
  end

  if attributes.key?(:'ssl_trust')
    self.ssl_trust = attributes[:'ssl_trust']
  end

  if attributes.key?(:'ssl_protocols')
    if (value = attributes[:'ssl_protocols']).is_a?(Array)
      self.ssl_protocols = value
    end
  end
end

Instance Attribute Details

#enabled ⇒ Object

IMAP server enabled



36
37
38
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 36

def enabled
  @enabled
end

#imap_host ⇒ Object

IMAP server host



33
34
35
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 33

def imap_host
  @imap_host
end

#imap_password ⇒ Object

Returns the value of attribute imap_password.



22
23
24
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 22

def imap_password
  @imap_password
end

#imap_port ⇒ Object

IMAP server port



30
31
32
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 30

def imap_port
  @imap_port
end

#imap_ssl ⇒ Object

Returns the value of attribute imap_ssl.



18
19
20
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 18

def imap_ssl
  @imap_ssl
end

#imap_username ⇒ Object

Returns the value of attribute imap_username.



20
21
22
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 20

def imap_username
  @imap_username
end

#local_host_name ⇒ Object

Returns the value of attribute local_host_name.



46
47
48
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 46

def local_host_name
  @local_host_name
end

#mechanisms ⇒ Object

List of IMAP mechanisms



49
50
51
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 49

def mechanisms
  @mechanisms
end

#proxy_enabled ⇒ Object

Returns the value of attribute proxy_enabled.



40
41
42
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 40

def proxy_enabled
  @proxy_enabled
end

#proxy_host ⇒ Object

Returns the value of attribute proxy_host.



44
45
46
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 44

def proxy_host
  @proxy_host
end

#proxy_port ⇒ Object

Returns the value of attribute proxy_port.



42
43
44
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 42

def proxy_port
  @proxy_port
end

#search_terms ⇒ Object

Returns the value of attribute search_terms.



27
28
29
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 27

def search_terms
  @search_terms
end

#select_folder ⇒ Object

Optional folder to select during IMAP connection



25
26
27
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 25

def select_folder
  @select_folder
end

#ssl_protocols ⇒ Object

List of SSL protocols



54
55
56
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 54

def ssl_protocols
  @ssl_protocols
end

#ssl_trust ⇒ Object

Returns the value of attribute ssl_trust.



51
52
53
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 51

def ssl_trust
  @ssl_trust
end

#start_tls ⇒ Object

Returns the value of attribute start_tls.



38
39
40
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 38

def start_tls
  @start_tls
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 57

def self.attribute_map
  {
    :'imap_ssl' => :'imapSsl',
    :'imap_username' => :'imapUsername',
    :'imap_password' => :'imapPassword',
    :'select_folder' => :'selectFolder',
    :'search_terms' => :'searchTerms',
    :'imap_port' => :'imapPort',
    :'imap_host' => :'imapHost',
    :'enabled' => :'enabled',
    :'start_tls' => :'startTls',
    :'proxy_enabled' => :'proxyEnabled',
    :'proxy_port' => :'proxyPort',
    :'proxy_host' => :'proxyHost',
    :'local_host_name' => :'localHostName',
    :'mechanisms' => :'mechanisms',
    :'ssl_trust' => :'sslTrust',
    :'ssl_protocols' => :'sslProtocols'
  }
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



261
262
263
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 261

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 101

def self.openapi_nullable
  Set.new([
    :'imap_ssl',
    :'imap_username',
    :'imap_password',
    :'select_folder',
    :'search_terms',
    :'imap_port',
    :'enabled',
    :'start_tls',
    :'proxy_enabled',
    :'proxy_port',
    :'proxy_host',
    :'local_host_name',
    :'mechanisms',
    :'ssl_trust',
    :'ssl_protocols'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 79

def self.openapi_types
  {
    :'imap_ssl' => :'Boolean',
    :'imap_username' => :'String',
    :'imap_password' => :'String',
    :'select_folder' => :'String',
    :'search_terms' => :'String',
    :'imap_port' => :'Integer',
    :'imap_host' => :'String',
    :'enabled' => :'Boolean',
    :'start_tls' => :'Boolean',
    :'proxy_enabled' => :'Boolean',
    :'proxy_port' => :'Integer',
    :'proxy_host' => :'String',
    :'local_host_name' => :'String',
    :'mechanisms' => :'Array<String>',
    :'ssl_trust' => :'String',
    :'ssl_protocols' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 225

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      imap_ssl == o.imap_ssl &&
      imap_username == o.imap_username &&
      imap_password == o.imap_password &&
      select_folder == o.select_folder &&
      search_terms == o.search_terms &&
      imap_port == o.imap_port &&
      imap_host == o.imap_host &&
      enabled == o.enabled &&
      start_tls == o.start_tls &&
      proxy_enabled == o.proxy_enabled &&
      proxy_port == o.proxy_port &&
      proxy_host == o.proxy_host &&
      local_host_name == o.local_host_name &&
      mechanisms == o.mechanisms &&
      ssl_trust == o.ssl_trust &&
      ssl_protocols == o.ssl_protocols
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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 289

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
    MailSlurpClient.const_get(type).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



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 358

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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 268

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[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


248
249
250
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 248

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



254
255
256
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 254

def hash
  [imap_ssl, imap_username, imap_password, select_folder, search_terms, imap_port, imap_host, enabled, start_tls, proxy_enabled, proxy_port, proxy_host, local_host_name, mechanisms, ssl_trust, ssl_protocols].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



207
208
209
210
211
212
213
214
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 207

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



334
335
336
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 334

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



340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 340

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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



328
329
330
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 328

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



218
219
220
221
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 218

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