Class: Telnyx::Models::EmailMessageCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::EmailMessageCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/email_message_create_params.rb,
sig/telnyx/models/email_message_create_params.rbs

Overview

See Also:

• Telnyx::Resources::EmailMessages#create

Constant Summary

Telnyx =

Returns:

• (:TrackingSettings)

Instance Attribute Summary

• #attachments ⇒ Array<Telnyx::Models::AttachmentRequest>^?
• #bcc ⇒ Array<String, Telnyx::Models::EmailInboxes::EmailAddress>^?
• #cc ⇒ Array<String, Telnyx::Models::EmailInboxes::EmailAddress>^?
• #forward_of_message_id ⇒ String^?

  Telnyx message UUID of the message this send forwards.

• #from ⇒ String, Telnyx::Models::EmailInboxes::EmailAddress
• #from_name ⇒ String^?

  Optional display name for string from; overrides from.name when provided.

• #group_id ⇒ String^?

  Optional unsubscribe-group UUID used for group-scoped suppression checks and unsubscribe handling.

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

  Custom email headers.

• #html_body ⇒ String^?

  HTML email body.

• #idempotency_key ⇒ String^?
• #ignore_suppression ⇒ Boolean^?

  When true, allows delivery to recipients whose suppressions explicitly permit an override.

• #in_reply_to_message_id ⇒ String^?

  Telnyx message UUID of the message this send replies to.

• #inline_css ⇒ Boolean^?
• #metadata ⇒ Hash{Symbol=>Object}^?

  Custom metadata.

• #reply_to ⇒ String, ...

  Reply-to address.

• #reply_to_all ⇒ Boolean^?

  Indicates a reply-all intent.

• #sandbox_mode ⇒ Boolean^?
• #scheduled_at ⇒ Time^?

  Future ISO 8601 time to schedule sending.

• #send_at ⇒ Time^? deprecated Deprecated.
• #subject ⇒ String^?

  Required unless template_id is supplied.

• #tags ⇒ Array<String>^?

  Tags for categorization and reporting.

• #template_id ⇒ String^?
• #template_variables ⇒ Hash{Symbol=>Object}^?

  Variables for Liquid template rendering.

• #text_body ⇒ String^?

  Plain text email body.

• #to ⇒ Array<String, Telnyx::Models::EmailInboxes::EmailAddress>
• #tracking_settings ⇒ Telnyx::Models::TrackingSettings^?

  Per-send open and click tracking overrides.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(from:, to:, attachments: nil, bcc: nil, cc: nil, forward_of_message_id: nil, from_name: nil, group_id: nil, headers: nil, html_body: nil, ignore_suppression: nil, in_reply_to_message_id: nil, inline_css: nil, metadata: nil, reply_to: nil, reply_to_all: nil, sandbox_mode: nil, scheduled_at: nil, send_at: nil, subject: nil, tags: nil, template_id: nil, template_variables: nil, text_body: nil, tracking_settings: nil, idempotency_key: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see EmailMessageCreateParams for more details.

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(from:, to:, attachments: nil, bcc: nil, cc: nil, forward_of_message_id: nil, from_name: nil, group_id: nil, headers: nil, html_body: nil, ignore_suppression: nil, in_reply_to_message_id: nil, inline_css: nil, metadata: nil, reply_to: nil, reply_to_all: nil, sandbox_mode: nil, scheduled_at: nil, send_at: nil, subject: nil, tags: nil, template_id: nil, template_variables: nil, text_body: nil, tracking_settings: nil, idempotency_key: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::EmailMessageCreateParams for more details.

Parameters:

• from (String, Telnyx::Models::EmailInboxes::EmailAddress)
• to (Array<String, Telnyx::Models::EmailInboxes::EmailAddress>)
• attachments (Array<Telnyx::Models::AttachmentRequest>) (defaults to: nil)
• bcc (Array<String, Telnyx::Models::EmailInboxes::EmailAddress>) (defaults to: nil)
• cc (Array<String, Telnyx::Models::EmailInboxes::EmailAddress>) (defaults to: nil)
• forward_of_message_id (String, nil) (defaults to: nil) —

  Telnyx message UUID of the message this send forwards. Forwarded

• from_name (String) (defaults to: nil) —

  Optional display name for string from; overrides from.name when provided.

• group_id (String, nil) (defaults to: nil) —

  Optional unsubscribe-group UUID used for group-scoped suppression checks and uns

• headers (Hash{Symbol=>String}) (defaults to: nil) —

  Custom email headers. Write-only; not returned in responses.

• html_body (String) (defaults to: nil) —

  HTML email body. Returned only by GET /email_messages/{id}; omitted from creat

• ignore_suppression (Boolean) (defaults to: nil) —

  When true, allows delivery to recipients whose suppressions explicitly

• in_reply_to_message_id (String, nil) (defaults to: nil) —

  Telnyx message UUID of the message this send replies to. When provided,

• inline_css (Boolean) (defaults to: nil)
• metadata (Hash{Symbol=>Object}) (defaults to: nil) —

  Custom metadata. Write-only; not returned in responses.

• reply_to (String, Telnyx::Models::EmailInboxes::EmailAddress) (defaults to: nil) —

  Reply-to address. If provided as an object with a name, only the email is stored

• reply_to_all (Boolean, nil) (defaults to: nil) —

  Indicates a reply-all intent. In Phase 1 (wire-only) this does not

• sandbox_mode (Boolean) (defaults to: nil)
• scheduled_at (Time, nil) (defaults to: nil) —

  Future ISO 8601 time to schedule sending. Invalid or past timestamps

• send_at (Time) (defaults to: nil) —

  Deprecated alias for scheduled_at.

• subject (String) (defaults to: nil) —

  Required unless template_id is supplied. When using a template, the template's

• tags (Array<String>) (defaults to: nil) —

  Tags for categorization and reporting. Stored on the message and propagated to E

• template_id (String) (defaults to: nil)
• template_variables (Hash{Symbol=>Object}) (defaults to: nil) —

  Variables for Liquid template rendering. Non-object values may cause a 422 valid

• text_body (String) (defaults to: nil) —

  Plain text email body. Returned only by GET /email_messages/{id}; omitted from

• tracking_settings (Telnyx::Models::TrackingSettings) (defaults to: nil) —

  Per-send open and click tracking overrides. Omitted properties inherit the sende

• idempotency_key (String) (defaults to: nil)
• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/telnyx/models/email_message_create_params.rb', line 198

Instance Attribute Details

#attachments ⇒ Array<Telnyx::Models::AttachmentRequest>^?

Returns:

• (Array<Telnyx::Models::AttachmentRequest>, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 23

optional :attachments, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AttachmentRequest] }

#bcc ⇒ Array<String, Telnyx::Models::EmailInboxes::EmailAddress>^?

Returns:

• (Array<String, Telnyx::Models::EmailInboxes::EmailAddress>, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 28

optional :bcc, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::EmailAddressInput] }

#cc ⇒ Array<String, Telnyx::Models::EmailInboxes::EmailAddress>^?

Returns:

• (Array<String, Telnyx::Models::EmailInboxes::EmailAddress>, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 33

optional :cc, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::EmailAddressInput] }

#forward_of_message_id ⇒ String^?

Telnyx message UUID of the message this send forwards. Forwarded messages start a NEW thread per RFC 5322 — NO In-Reply-To or References headers are set on the outbound MIME. The id is recorded in the message's metadata for EDR provenance only.

The id is validated as a UUID but is NOT looked up against the message store — existence is the caller's responsibility (the forward is pure metadata; it does not affect delivery). Cannot be combined with in_reply_to_message_id (422).

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 46

optional :forward_of_message_id, String, nil?: true

#from ⇒ String, Telnyx::Models::EmailInboxes::EmailAddress

Parameters:

• value (Telnyx::Models::email_address_input)

Returns:

• (String, Telnyx::Models::EmailInboxes::EmailAddress)

# File 'lib/telnyx/models/email_message_create_params.rb', line 13

required :from, union: -> { Telnyx::EmailAddressInput }

#from_name ⇒ String^?

Optional display name for string from; overrides from.name when provided.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 52

optional :from_name, String

#group_id ⇒ String^?

Optional unsubscribe-group UUID used for group-scoped suppression checks and unsubscribe handling.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 59

optional :group_id, String, nil?: true

#headers ⇒ Hash{Symbol=>String}^?

Custom email headers. Write-only; not returned in responses.

Parameters:

• (::Hash[Symbol, String])

Returns:

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

# File 'lib/telnyx/models/email_message_create_params.rb', line 65

optional :headers, Telnyx::Internal::Type::HashOf[String]

#html_body ⇒ String^?

HTML email body. Returned only by GET /email_messages/{id}; omitted from create and list responses.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 72

optional :html_body, String

#idempotency_key ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 196

optional :idempotency_key, String

#ignore_suppression ⇒ Boolean^?

When true, allows delivery to recipients whose suppressions explicitly permit an override. Hard bounces, spam complaints, and invalid-address suppressions cannot be overridden. Requires the email:override API scope.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 80

optional :ignore_suppression, Telnyx::Internal::Type::Boolean

#in_reply_to_message_id ⇒ String^?

Telnyx message UUID of the message this send replies to. When provided, the API sets RFC 5322 In-Reply-To and References headers on the outbound MIME so the recipient's mailbox (Gmail/Outlook) threads it correctly. The parent is looked up under the caller's account scope; a UUID belonging to another account yields a non-enumerating 404.

Wire-only (Phase 1): the API sets the headers and does NOT resolve or mutate thread_id on the server side. Messages sent without this parameter are standalone (no threading headers injected).

Cannot be combined with forward_of_message_id (422).

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 96

optional :in_reply_to_message_id, String, nil?: true

#inline_css ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 101

optional :inline_css, Telnyx::Internal::Type::Boolean

#metadata ⇒ Hash{Symbol=>Object}^?

Custom metadata. Write-only; not returned in responses.

Parameters:

• (::Hash[Symbol, top])

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 107

optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#reply_to ⇒ String, ...

Reply-to address. If provided as an object with a name, only the email is stored; the name is ignored.

Returns:

• (String, Telnyx::Models::EmailInboxes::EmailAddress, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 114

optional :reply_to, union: -> { Telnyx::EmailAddressInput }

#reply_to_all ⇒ Boolean^?

Indicates a reply-all intent. In Phase 1 (wire-only) this does not change the threading headers — recipient selection is customer- controlled (to/cc), and a thread is not defined by its audience. When the referenced message has no thread context, reply-all degrades to a plain reply (parent ID only in References). The resolution engine (separate work) will expand the ancestor chain at a later phase with no API change.

Only meaningful alongside in_reply_to_message_id.

Parameters:

• value (Boolean, nil)

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 127

optional :reply_to_all, Telnyx::Internal::Type::Boolean, nil?: true

#sandbox_mode ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 132

optional :sandbox_mode, Telnyx::Internal::Type::Boolean

#scheduled_at ⇒ Time^?

Future ISO 8601 time to schedule sending. Invalid or past timestamps are silently ignored and the email is sent immediately. The legacy alias send_at is still accepted for backward compatibility; when both are provided, scheduled_at wins.

Parameters:

• value (Time, nil)

Returns:

• (Time, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 141

optional :scheduled_at, Time, nil?: true

#send_at ⇒ Time^?

Deprecated.

Deprecated alias for scheduled_at.

Parameters:

• (Time)

Returns:

• (Time, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 149

optional :send_at, Time

#subject ⇒ String^?

Required unless template_id is supplied. When using a template, the template's subject is rendered; if the template has no subject or renders empty, the request returns 400.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 157

optional :subject, String

#tags ⇒ Array<String>^?

Tags for categorization and reporting. Stored on the message and propagated to Email Detail Records. Not returned in API responses.

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 164

optional :tags, Telnyx::Internal::Type::ArrayOf[String]

#template_id ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 169

optional :template_id, String

#template_variables ⇒ Hash{Symbol=>Object}^?

Variables for Liquid template rendering. Non-object values may cause a 422 validation error on message creation, but are silently treated as an empty object for template rendering.

Parameters:

• (::Hash[Symbol, top])

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 177

optional :template_variables, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#text_body ⇒ String^?

Plain text email body. Returned only by GET /email_messages/{id}; omitted from create and list responses.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 184

optional :text_body, String

#to ⇒ Array<String, Telnyx::Models::EmailInboxes::EmailAddress>

Parameters:

• value (::Array[Telnyx::Models::email_address_input])

Returns:

• (Array<String, Telnyx::Models::EmailInboxes::EmailAddress>)

# File 'lib/telnyx/models/email_message_create_params.rb', line 18

required :to, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::EmailAddressInput] }

#tracking_settings ⇒ Telnyx::Models::TrackingSettings^?

Per-send open and click tracking overrides. Omitted properties inherit the sender domain's tracking settings.

Returns:

• (Telnyx::Models::TrackingSettings, nil)

# File 'lib/telnyx/models/email_message_create_params.rb', line 191

optional :tracking_settings, -> { Telnyx::TrackingSettings }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/email_message_create_params.rbs', line 168

def to_hash: -> {