Class: Telnyx::Resources::EmailMessages::Recipients

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/email_messages/recipients.rb,
sig/telnyx/resources/email_messages/recipients.rbs

Overview

Send and manage email messages. Legacy /v2/emails routes are aliases for these endpoints.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Recipients

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Recipients.

Parameters:



78
79
80
 
# File 'lib/telnyx/resources/email_messages/recipients.rb', line 78

def initialize(client:)
  @client = client
end

Instance Method Details

#list(email_id, kind: nil, page_cursor: nil, page_size: nil, status: nil, request_options: {}) ⇒ Telnyx::Models::EmailMessages::RecipientListResponse

Some parameter documentations has been truncated, see Models::EmailMessages::RecipientListParams for more details.

Lists per-recipient delivery states for a single message with cursor pagination. Each recipient has an independent status, billable flag, and lifecycle timestamps. BCC recipient addresses are redacted (returned as null) to protect BCC privacy. Default page size is 25, maximum is 100.

Parameters:

Returns:

See Also:



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/telnyx/resources/email_messages/recipients.rb', line 63

def list(email_id, params = {})
  parsed, options = Telnyx::EmailMessages::RecipientListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["email_messages/%1$s/recipients", email_id],
    query: query,
    model: Telnyx::Models::EmailMessages::RecipientListResponse,
    options: options
  )
end

#retrieve(recipient_id, email_id:, request_options: {}) ⇒ Telnyx::Models::EmailMessages::RecipientRetrieveResponse

Returns the current delivery state of a single recipient, including status, billable flag, SMTP detail, and lifecycle timestamps. BCC recipient addresses are redacted (returned as null).

Parameters:

  • recipient_id (String) —

    Recipient UUID.

  • email_id (String) —

    Email message UUID.

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

Returns:

See Also:



24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/telnyx/resources/email_messages/recipients.rb', line 24

def retrieve(recipient_id, params)
  parsed, options = Telnyx::EmailMessages::RecipientRetrieveParams.dump_request(params)
  email_id =
    parsed.delete(:email_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["email_messages/%1$s/recipients/%2$s", email_id, recipient_id],
    model: Telnyx::Models::EmailMessages::RecipientRetrieveResponse,
    options: options
  )
end