Class: Inttegro::Chime::EmailMessageInput

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/chime/email_message_input.rb

Overview

Email content accepted for email chimes, broadcasts, and schedules.

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 collapse

Instance Attribute Details

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

Value of the from field in the Inttegro API payload.

Required in the API payload. Wire name: from.

Returns:



54
55
56
57
58
59
60
61
 
# File 'lib/inttegro/chime/email_message_input.rb', line 54

class EmailMessageInput < T::Struct
  const :subject, String
  const :text, String
  const :html, T.nilable(String), default: nil
  const :from, Inttegro::Chime::EmailMailbox
  const :reply_to, T.nilable(String), default: nil
  const :headers, T.nilable(T::Hash[String, String]), 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) 


54
55
56
57
58
59
60
61
 
# File 'lib/inttegro/chime/email_message_input.rb', line 54

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

#html ⇒ String? (readonly)

Optional HTML email body. Unsafe HTML is rejected or sanitized before delivery.

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

Returns:

  • (String, nil) 


54
55
56
57
58
59
60
61
 
# File 'lib/inttegro/chime/email_message_input.rb', line 54

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

#reply_to ⇒ String? (readonly)

Optional reply-to email address.

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

Returns:

  • (String, nil) 


54
55
56
57
58
59
60
61
 
# File 'lib/inttegro/chime/email_message_input.rb', line 54

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

#subject ⇒ String (readonly)

Email subject.

Required in the API payload. Wire name: subject.

Returns:

  • (String) 


54
55
56
57
58
59
60
61
 
# File 'lib/inttegro/chime/email_message_input.rb', line 54

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

#text ⇒ String (readonly)

Plain-text email body.

Required in the API payload. Wire name: text.

Returns:

  • (String) 


54
55
56
57
58
59
60
61
 
# File 'lib/inttegro/chime/email_message_input.rb', line 54

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