Class: Inttegro::Chime::EmailSafetyResult

Inherits:

T::Struct

• Object
• T::Struct
• Inttegro::Chime::EmailSafetyResult

Defined in:

lib/inttegro/chime/email_safety_result.rb

Overview

Result of the email safety scan

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary

• #content_hash ⇒ String^? readonly

  Hash of the scanned email content.

• #links ⇒ Array<Inttegro::Chime::EmailScannedLink>^? readonly

  Value of the links field in the Inttegro API payload.

• #normalized_text ⇒ String^? readonly

  Normalized plain-text body used by the scanner.

• #quarantine_notes ⇒ String^? readonly

  Value of the quarantine_notes field in the Inttegro API payload.

• #reason_codes ⇒ Array<String>^? readonly

  Machine-readable reasons for non-allowed results.

• #sanitized_html ⇒ String^? readonly

  Sanitized HTML body used for provider send when present.

• #scanner ⇒ String^? readonly

  Safety scanner identifier.

• #status ⇒ Inttegro::Shared::ContentSafetyStatus^? readonly

  Safety decision for the email content.

Instance Attribute Details

#content_hash ⇒ String^? (readonly)

Hash of the scanned email content

Optional in the API payload; omitted values default to nil. Wire name: content_hash.

Returns:

• (String, nil)

# File 'lib/inttegro/chime/email_safety_result.rb', line 67

class EmailSafetyResult < T::Struct
  const :status, T.nilable(Inttegro::Shared::ContentSafetyStatus), default: nil
  const :reason_codes, T.nilable(T::Array[String]), default: nil
  const :sanitized_html, T.nilable(String), default: nil
  const :normalized_text, T.nilable(String), default: nil
  const :links, T.nilable(T::Array[Inttegro::Chime::EmailScannedLink]), default: nil
  const :scanner, T.nilable(String), default: nil
  const :content_hash, T.nilable(String), default: nil
  const :quarantine_notes, T.nilable(String), default: nil
end

#links ⇒ Array<Inttegro::Chime::EmailScannedLink>^? (readonly)

Value of the links field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: links.

Returns:

• (Array<Inttegro::Chime::EmailScannedLink>, nil)

# File 'lib/inttegro/chime/email_safety_result.rb', line 67

class EmailSafetyResult < T::Struct
  const :status, T.nilable(Inttegro::Shared::ContentSafetyStatus), default: nil
  const :reason_codes, T.nilable(T::Array[String]), default: nil
  const :sanitized_html, T.nilable(String), default: nil
  const :normalized_text, T.nilable(String), default: nil
  const :links, T.nilable(T::Array[Inttegro::Chime::EmailScannedLink]), default: nil
  const :scanner, T.nilable(String), default: nil
  const :content_hash, T.nilable(String), default: nil
  const :quarantine_notes, T.nilable(String), default: nil
end

#normalized_text ⇒ String^? (readonly)

Normalized plain-text body used by the scanner

Optional in the API payload; omitted values default to nil. Wire name: normalized_text.

Returns:

• (String, nil)

# File 'lib/inttegro/chime/email_safety_result.rb', line 67

class EmailSafetyResult < T::Struct
  const :status, T.nilable(Inttegro::Shared::ContentSafetyStatus), default: nil
  const :reason_codes, T.nilable(T::Array[String]), default: nil
  const :sanitized_html, T.nilable(String), default: nil
  const :normalized_text, T.nilable(String), default: nil
  const :links, T.nilable(T::Array[Inttegro::Chime::EmailScannedLink]), default: nil
  const :scanner, T.nilable(String), default: nil
  const :content_hash, T.nilable(String), default: nil
  const :quarantine_notes, T.nilable(String), default: nil
end

#quarantine_notes ⇒ String^? (readonly)

Value of the quarantine_notes field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: quarantine_notes.

Returns:

• (String, nil)

# File 'lib/inttegro/chime/email_safety_result.rb', line 67

class EmailSafetyResult < T::Struct
  const :status, T.nilable(Inttegro::Shared::ContentSafetyStatus), default: nil
  const :reason_codes, T.nilable(T::Array[String]), default: nil
  const :sanitized_html, T.nilable(String), default: nil
  const :normalized_text, T.nilable(String), default: nil
  const :links, T.nilable(T::Array[Inttegro::Chime::EmailScannedLink]), default: nil
  const :scanner, T.nilable(String), default: nil
  const :content_hash, T.nilable(String), default: nil
  const :quarantine_notes, T.nilable(String), default: nil
end

#reason_codes ⇒ Array<String>^? (readonly)

Machine-readable reasons for non-allowed results

Optional in the API payload; omitted values default to nil. Wire name: reason_codes.

Returns:

• (Array<String>, nil)

# File 'lib/inttegro/chime/email_safety_result.rb', line 67

class EmailSafetyResult < T::Struct
  const :status, T.nilable(Inttegro::Shared::ContentSafetyStatus), default: nil
  const :reason_codes, T.nilable(T::Array[String]), default: nil
  const :sanitized_html, T.nilable(String), default: nil
  const :normalized_text, T.nilable(String), default: nil
  const :links, T.nilable(T::Array[Inttegro::Chime::EmailScannedLink]), default: nil
  const :scanner, T.nilable(String), default: nil
  const :content_hash, T.nilable(String), default: nil
  const :quarantine_notes, T.nilable(String), default: nil
end

#sanitized_html ⇒ String^? (readonly)

Sanitized HTML body used for provider send when present

Optional in the API payload; omitted values default to nil. Wire name: sanitized_html.

Returns:

• (String, nil)

# File 'lib/inttegro/chime/email_safety_result.rb', line 67

class EmailSafetyResult < T::Struct
  const :status, T.nilable(Inttegro::Shared::ContentSafetyStatus), default: nil
  const :reason_codes, T.nilable(T::Array[String]), default: nil
  const :sanitized_html, T.nilable(String), default: nil
  const :normalized_text, T.nilable(String), default: nil
  const :links, T.nilable(T::Array[Inttegro::Chime::EmailScannedLink]), default: nil
  const :scanner, T.nilable(String), default: nil
  const :content_hash, T.nilable(String), default: nil
  const :quarantine_notes, T.nilable(String), default: nil
end

#scanner ⇒ String^? (readonly)

Safety scanner identifier

Optional in the API payload; omitted values default to nil. Wire name: scanner.

Returns:

• (String, nil)

# File 'lib/inttegro/chime/email_safety_result.rb', line 67

class EmailSafetyResult < T::Struct
  const :status, T.nilable(Inttegro::Shared::ContentSafetyStatus), default: nil
  const :reason_codes, T.nilable(T::Array[String]), default: nil
  const :sanitized_html, T.nilable(String), default: nil
  const :normalized_text, T.nilable(String), default: nil
  const :links, T.nilable(T::Array[Inttegro::Chime::EmailScannedLink]), default: nil
  const :scanner, T.nilable(String), default: nil
  const :content_hash, T.nilable(String), default: nil
  const :quarantine_notes, T.nilable(String), default: nil
end

#status ⇒ Inttegro::Shared::ContentSafetyStatus^? (readonly)

Safety decision for the email content

Optional in the API payload; omitted values default to nil. Wire name: status.

Returns:

• (Inttegro::Shared::ContentSafetyStatus, nil)

# File 'lib/inttegro/chime/email_safety_result.rb', line 67

class EmailSafetyResult < T::Struct
  const :status, T.nilable(Inttegro::Shared::ContentSafetyStatus), default: nil
  const :reason_codes, T.nilable(T::Array[String]), default: nil
  const :sanitized_html, T.nilable(String), default: nil
  const :normalized_text, T.nilable(String), default: nil
  const :links, T.nilable(T::Array[Inttegro::Chime::EmailScannedLink]), default: nil
  const :scanner, T.nilable(String), default: nil
  const :content_hash, T.nilable(String), default: nil
  const :quarantine_notes, T.nilable(String), default: nil
end