Class: MailSlurpClient::EmailAnalysis

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

Overview

Analysis result for email. Each verdict property is a string PASS|FAIL|GRAY or dynamic error message

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailAnalysis

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/mailslurp_client/models/email_analysis.rb', line 68

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

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

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

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

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

Instance Attribute Details

#dkim_verdict ⇒ Object

Verdict of DomainKeys Identified Mail analysis



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

def dkim_verdict
  @dkim_verdict
end

#dmarc_verdict ⇒ Object

Verdict of Domain-based Message Authentication Reporting and Conformance analysis



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

def dmarc_verdict
  @dmarc_verdict
end

#spam_verdict ⇒ Object

Verdict of spam ranking analysis



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

def spam_verdict
  @spam_verdict
end

#spf_verdict ⇒ Object

Verdict of Send Policy Framework record spoofing analysis



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

def spf_verdict
  @spf_verdict
end

#virus_verdict ⇒ Object

Verdict of virus scan analysis



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

def virus_verdict
  @virus_verdict
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/mailslurp_client/models/email_analysis.rb', line 34

def self.attribute_map
  {
    :'spam_verdict' => :'spamVerdict',
    :'virus_verdict' => :'virusVerdict',
    :'spf_verdict' => :'spfVerdict',
    :'dkim_verdict' => :'dkimVerdict',
    :'dmarc_verdict' => :'dmarcVerdict'
  }
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



142
143
144
 
# File 'lib/mailslurp_client/models/email_analysis.rb', line 142

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
    :'spam_verdict',
    :'virus_verdict',
    :'spf_verdict',
    :'dkim_verdict',
    :'dmarc_verdict'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
 
# File 'lib/mailslurp_client/models/email_analysis.rb', line 45

def self.openapi_types
  {
    :'spam_verdict' => :'String',
    :'virus_verdict' => :'String',
    :'spf_verdict' => :'String',
    :'dkim_verdict' => :'String',
    :'dmarc_verdict' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



117
118
119
120
121
122
123
124
125
 
# File 'lib/mailslurp_client/models/email_analysis.rb', line 117

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      spam_verdict == o.spam_verdict &&
      virus_verdict == o.virus_verdict &&
      spf_verdict == o.spf_verdict &&
      dkim_verdict == o.dkim_verdict &&
      dmarc_verdict == o.dmarc_verdict
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



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
204
205
 
# File 'lib/mailslurp_client/models/email_analysis.rb', line 170

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



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/mailslurp_client/models/email_analysis.rb', line 239

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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/mailslurp_client/models/email_analysis.rb', line 149

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


129
130
131
 
# File 'lib/mailslurp_client/models/email_analysis.rb', line 129

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



135
136
137
 
# File 'lib/mailslurp_client/models/email_analysis.rb', line 135

def hash
  [spam_verdict, virus_verdict, spf_verdict, dkim_verdict, dmarc_verdict].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



104
105
106
107
 
# File 'lib/mailslurp_client/models/email_analysis.rb', line 104

def list_invalid_properties
  invalid_properties = Array.new
  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



215
216
217
 
# File 'lib/mailslurp_client/models/email_analysis.rb', line 215

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



221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/mailslurp_client/models/email_analysis.rb', line 221

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



209
210
211
 
# File 'lib/mailslurp_client/models/email_analysis.rb', line 209

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



111
112
113
 
# File 'lib/mailslurp_client/models/email_analysis.rb', line 111

def valid?
  true
end