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 iva 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



81
82
83
84
85
86
87
88
89
90
91
92
93
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
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 81

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
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

#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

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 39

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'
  }
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



175
176
177
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 175

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 67

def self.openapi_nullable
  Set.new([
    :'imap_ssl',
    :'imap_username',
    :'imap_password',
    :'select_folder',
    :'search_terms',
    :'imap_port',
    :'enabled'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 53

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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 147

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
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



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
232
233
234
235
236
237
238
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 203

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



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

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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 182

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


162
163
164
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 162

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



168
169
170
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 168

def hash
  [imap_ssl, imap_username, imap_password, select_folder, search_terms, imap_port, imap_host, enabled].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



129
130
131
132
133
134
135
136
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 129

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



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

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



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 254

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



242
243
244
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 242

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



140
141
142
143
 
# File 'lib/mailslurp_client/models/create_connector_imap_connection_options.rb', line 140

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