Class: MailSlurpClient::SmtpAccessDetails

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

Overview

Access details for inbox using SMTP

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SmtpAccessDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
126
127
128
129
130
131
132
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 84

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::SmtpAccessDetails` 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::SmtpAccessDetails`. 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?(:'secure_smtp_server_host')
    self.secure_smtp_server_host = attributes[:'secure_smtp_server_host']
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#mail_from_domain ⇒ Object

Mail from domain or SMTP HELO value



43
44
45
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 43

def mail_from_domain
  @mail_from_domain
end

#secure_smtp_password ⇒ Object

Secure TLS SMTP password for login



28
29
30
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 28

def secure_smtp_password
  @secure_smtp_password
end

#secure_smtp_server_host ⇒ Object

Secure TLS SMTP server host domain



19
20
21
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 19

def secure_smtp_server_host
  @secure_smtp_server_host
end

#secure_smtp_server_port ⇒ Object

Secure TLS SMTP server host port



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

def secure_smtp_server_port
  @secure_smtp_server_port
end

#secure_smtp_username ⇒ Object

Secure TLS SMTP username for login



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

def secure_smtp_username
  @secure_smtp_username
end

#smtp_password ⇒ Object

SMTP password for login



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

def smtp_password
  @smtp_password
end

#smtp_server_host ⇒ Object

SMTP server host domain



31
32
33
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 31

def smtp_server_host
  @smtp_server_host
end

#smtp_server_port ⇒ Object

SMTP server host port



34
35
36
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 34

def smtp_server_port
  @smtp_server_port
end

#smtp_username ⇒ Object

SMTP username for login



37
38
39
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 37

def smtp_username
  @smtp_username
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 46

def self.attribute_map
  {
    :'secure_smtp_server_host' => :'secureSmtpServerHost',
    :'secure_smtp_server_port' => :'secureSmtpServerPort',
    :'secure_smtp_username' => :'secureSmtpUsername',
    :'secure_smtp_password' => :'secureSmtpPassword',
    :'smtp_server_host' => :'smtpServerHost',
    :'smtp_server_port' => :'smtpServerPort',
    :'smtp_username' => :'smtpUsername',
    :'smtp_password' => :'smtpPassword',
    :'mail_from_domain' => :'mailFromDomain'
  }
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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



76
77
78
79
80
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 76

def self.openapi_nullable
  Set.new([
    :'mail_from_domain'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 61

def self.openapi_types
  {
    :'secure_smtp_server_host' => :'String',
    :'secure_smtp_server_port' => :'Integer',
    :'secure_smtp_username' => :'String',
    :'secure_smtp_password' => :'String',
    :'smtp_server_host' => :'String',
    :'smtp_server_port' => :'Integer',
    :'smtp_username' => :'String',
    :'smtp_password' => :'String',
    :'mail_from_domain' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 189

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      secure_smtp_server_host == o.secure_smtp_server_host &&
      secure_smtp_server_port == o.secure_smtp_server_port &&
      secure_smtp_username == o.secure_smtp_username &&
      secure_smtp_password == o.secure_smtp_password &&
      smtp_server_host == o.smtp_server_host &&
      smtp_server_port == o.smtp_server_port &&
      smtp_username == o.smtp_username &&
      smtp_password == o.smtp_password &&
      mail_from_domain == o.mail_from_domain
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



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
276
277
278
279
280
281
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 246

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



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 315

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



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

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


205
206
207
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



211
212
213
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 211

def hash
  [secure_smtp_server_host, secure_smtp_server_port, secure_smtp_username, secure_smtp_password, smtp_server_host, smtp_server_port, smtp_username, smtp_password, mail_from_domain].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



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
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 136

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

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

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

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

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

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

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

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



291
292
293
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 291

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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 297

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



285
286
287
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 285

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



175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/mailslurp_client/models/smtp_access_details.rb', line 175

def valid?
  return false if @secure_smtp_server_host.nil?
  return false if @secure_smtp_server_port.nil?
  return false if @secure_smtp_username.nil?
  return false if @secure_smtp_password.nil?
  return false if @smtp_server_host.nil?
  return false if @smtp_server_port.nil?
  return false if @smtp_username.nil?
  return false if @smtp_password.nil?
  true
end