Class: Inttegro::Chime::EmailMessage

Inherits:

T::Struct

• Object
• T::Struct
• Inttegro::Chime::EmailMessage

Defined in:

lib/inttegro/chime/email_message.rb

Overview

Email content, safety scan result, and system-generated schema markup for email chimes.

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

• #from ⇒ Inttegro::Chime::EmailMailbox^? readonly

  Value of the from field in the Inttegro API payload.

• #headers ⇒ Hash{String => String}^? readonly

  Validated provider-neutral email headers.

• #html ⇒ String^? readonly

  Optional HTML email body before provider-specific rendering.

• #reply_to ⇒ Inttegro::Chime::EmailMailbox^? readonly

  Value of the reply_to field in the Inttegro API payload.

• #safety ⇒ Inttegro::Chime::EmailSafetyResult^? readonly

  Result of the email safety scan.

• #schema ⇒ Inttegro::Chime::EmailSchemaMarkup^? readonly

  Schema.org JSON-LD markup generated at email send time.

• #subject ⇒ String^? readonly

  Email subject.

• #text ⇒ String^? readonly

  Plain-text email body.

Instance Attribute Details

#from ⇒ Inttegro::Chime::EmailMailbox^? (readonly)

Value of the from field in the Inttegro API payload.

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

Returns:

• (Inttegro::Chime::EmailMailbox, nil)

# File 'lib/inttegro/chime/email_message.rb', line 68

class EmailMessage < T::Struct
  const :subject, T.nilable(String), default: nil
  const :text, T.nilable(String), default: nil
  const :html, T.nilable(String), default: nil
  const :from, T.nilable(Inttegro::Chime::EmailMailbox), default: nil
  const :reply_to, T.nilable(Inttegro::Chime::EmailMailbox), default: nil
  const :headers, T.nilable(T::Hash[String, String]), default: nil
  const :safety, T.nilable(Inttegro::Chime::EmailSafetyResult), default: nil
  const :schema, T.nilable(Inttegro::Chime::EmailSchemaMarkup), default: nil
end

#headers ⇒ Hash{String => String}^? (readonly)

Validated provider-neutral email headers.

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

Returns:

• (Hash{String => String}, nil)

# File 'lib/inttegro/chime/email_message.rb', line 68

class EmailMessage < T::Struct
  const :subject, T.nilable(String), default: nil
  const :text, T.nilable(String), default: nil
  const :html, T.nilable(String), default: nil
  const :from, T.nilable(Inttegro::Chime::EmailMailbox), default: nil
  const :reply_to, T.nilable(Inttegro::Chime::EmailMailbox), default: nil
  const :headers, T.nilable(T::Hash[String, String]), default: nil
  const :safety, T.nilable(Inttegro::Chime::EmailSafetyResult), default: nil
  const :schema, T.nilable(Inttegro::Chime::EmailSchemaMarkup), default: nil
end

#html ⇒ String^? (readonly)

Optional HTML email body before provider-specific rendering

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

Returns:

• (String, nil)

# File 'lib/inttegro/chime/email_message.rb', line 68

class EmailMessage < T::Struct
  const :subject, T.nilable(String), default: nil
  const :text, T.nilable(String), default: nil
  const :html, T.nilable(String), default: nil
  const :from, T.nilable(Inttegro::Chime::EmailMailbox), default: nil
  const :reply_to, T.nilable(Inttegro::Chime::EmailMailbox), default: nil
  const :headers, T.nilable(T::Hash[String, String]), default: nil
  const :safety, T.nilable(Inttegro::Chime::EmailSafetyResult), default: nil
  const :schema, T.nilable(Inttegro::Chime::EmailSchemaMarkup), default: nil
end

#reply_to ⇒ Inttegro::Chime::EmailMailbox^? (readonly)

Value of the reply_to field in the Inttegro API payload.

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

Returns:

• (Inttegro::Chime::EmailMailbox, nil)

# File 'lib/inttegro/chime/email_message.rb', line 68

class EmailMessage < T::Struct
  const :subject, T.nilable(String), default: nil
  const :text, T.nilable(String), default: nil
  const :html, T.nilable(String), default: nil
  const :from, T.nilable(Inttegro::Chime::EmailMailbox), default: nil
  const :reply_to, T.nilable(Inttegro::Chime::EmailMailbox), default: nil
  const :headers, T.nilable(T::Hash[String, String]), default: nil
  const :safety, T.nilable(Inttegro::Chime::EmailSafetyResult), default: nil
  const :schema, T.nilable(Inttegro::Chime::EmailSchemaMarkup), default: nil
end

#safety ⇒ Inttegro::Chime::EmailSafetyResult^? (readonly)

Result of the email safety scan

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

Returns:

• (Inttegro::Chime::EmailSafetyResult, nil)

# File 'lib/inttegro/chime/email_message.rb', line 68

class EmailMessage < T::Struct
  const :subject, T.nilable(String), default: nil
  const :text, T.nilable(String), default: nil
  const :html, T.nilable(String), default: nil
  const :from, T.nilable(Inttegro::Chime::EmailMailbox), default: nil
  const :reply_to, T.nilable(Inttegro::Chime::EmailMailbox), default: nil
  const :headers, T.nilable(T::Hash[String, String]), default: nil
  const :safety, T.nilable(Inttegro::Chime::EmailSafetyResult), default: nil
  const :schema, T.nilable(Inttegro::Chime::EmailSchemaMarkup), default: nil
end

#schema ⇒ Inttegro::Chime::EmailSchemaMarkup^? (readonly)

Schema.org JSON-LD markup generated at email send time.

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

Returns:

• (Inttegro::Chime::EmailSchemaMarkup, nil)

# File 'lib/inttegro/chime/email_message.rb', line 68

class EmailMessage < T::Struct
  const :subject, T.nilable(String), default: nil
  const :text, T.nilable(String), default: nil
  const :html, T.nilable(String), default: nil
  const :from, T.nilable(Inttegro::Chime::EmailMailbox), default: nil
  const :reply_to, T.nilable(Inttegro::Chime::EmailMailbox), default: nil
  const :headers, T.nilable(T::Hash[String, String]), default: nil
  const :safety, T.nilable(Inttegro::Chime::EmailSafetyResult), default: nil
  const :schema, T.nilable(Inttegro::Chime::EmailSchemaMarkup), default: nil
end

#subject ⇒ String^? (readonly)

Email subject

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

Returns:

• (String, nil)

# File 'lib/inttegro/chime/email_message.rb', line 68

class EmailMessage < T::Struct
  const :subject, T.nilable(String), default: nil
  const :text, T.nilable(String), default: nil
  const :html, T.nilable(String), default: nil
  const :from, T.nilable(Inttegro::Chime::EmailMailbox), default: nil
  const :reply_to, T.nilable(Inttegro::Chime::EmailMailbox), default: nil
  const :headers, T.nilable(T::Hash[String, String]), default: nil
  const :safety, T.nilable(Inttegro::Chime::EmailSafetyResult), default: nil
  const :schema, T.nilable(Inttegro::Chime::EmailSchemaMarkup), default: nil
end

#text ⇒ String^? (readonly)

Plain-text email body

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

Returns:

• (String, nil)

# File 'lib/inttegro/chime/email_message.rb', line 68

class EmailMessage < T::Struct
  const :subject, T.nilable(String), default: nil
  const :text, T.nilable(String), default: nil
  const :html, T.nilable(String), default: nil
  const :from, T.nilable(Inttegro::Chime::EmailMailbox), default: nil
  const :reply_to, T.nilable(Inttegro::Chime::EmailMailbox), default: nil
  const :headers, T.nilable(T::Hash[String, String]), default: nil
  const :safety, T.nilable(Inttegro::Chime::EmailSafetyResult), default: nil
  const :schema, T.nilable(Inttegro::Chime::EmailSchemaMarkup), default: nil
end