Class: MailSlurpClient::ForwardEmailOptions

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

Overview

Options for forwarding an email

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ForwardEmailOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



79
80
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/forward_email_options.rb', line 79

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

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

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

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

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

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

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

Instance Attribute Details

#bcc ⇒ Object

Optional bcc recipients



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

def bcc
  @bcc
end

#cc ⇒ Object

Optional cc recipients



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

def cc
  @cc
end

#filter_bounced_recipients ⇒ Object

Filter recipients to remove any bounced recipients from to, bcc, and cc before sending



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

def filter_bounced_recipients
  @filter_bounced_recipients
end

#from ⇒ Object

Optional from override



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

def from
  @from
end

#subject ⇒ Object

Subject for forwarded email



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

def subject
  @subject
end

#to ⇒ Object

To recipients for forwarded email



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

def to
  @to
end

#use_inbox_name ⇒ Object

Optionally use inbox name as display name for sender email address



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

def use_inbox_name
  @use_inbox_name
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'to' => :'to',
    :'subject' => :'subject',
    :'cc' => :'cc',
    :'bcc' => :'bcc',
    :'from' => :'from',
    :'use_inbox_name' => :'useInboxName',
    :'filter_bounced_recipients' => :'filterBouncedRecipients'
  }
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



174
175
176
 
# File 'lib/mailslurp_client/models/forward_email_options.rb', line 174

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
    :'subject',
    :'cc',
    :'bcc',
    :'from',
    :'use_inbox_name',
    :'filter_bounced_recipients'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'to' => :'Array<String>',
    :'subject' => :'String',
    :'cc' => :'Array<String>',
    :'bcc' => :'Array<String>',
    :'from' => :'String',
    :'use_inbox_name' => :'Boolean',
    :'filter_bounced_recipients' => :'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
 
# File 'lib/mailslurp_client/models/forward_email_options.rb', line 147

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      to == o.to &&
      subject == o.subject &&
      cc == o.cc &&
      bcc == o.bcc &&
      from == o.from &&
      use_inbox_name == o.use_inbox_name &&
      filter_bounced_recipients == o.filter_bounced_recipients
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



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

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



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

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



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

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


161
162
163
 
# File 'lib/mailslurp_client/models/forward_email_options.rb', line 161

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



167
168
169
 
# File 'lib/mailslurp_client/models/forward_email_options.rb', line 167

def hash
  [to, subject, cc, bcc, from, use_inbox_name, filter_bounced_recipients].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/forward_email_options.rb', line 129

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



247
248
249
 
# File 'lib/mailslurp_client/models/forward_email_options.rb', line 247

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



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

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



241
242
243
 
# File 'lib/mailslurp_client/models/forward_email_options.rb', line 241

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/forward_email_options.rb', line 140

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