List email messages

GET

email_messages

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const response of client.emailMessages.list()) {
  console.log(response);
}

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	emailMessages, err := client.EmailMessages.List(context.TODO())
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", emailMessages.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        var page = client.emailMessages().list();
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->emailMessages->list();

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

{
  "data": [
    {
      "record_type": "email_message",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "queued",
      "from": {
        "email": "<string>",
        "name": "<string>"
      },
      "to": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "cc": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "bcc": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "reply_to": "<string>",
      "subject": "<string>",
      "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "template_variables": {},
      "tags": [],
      "metadata": {},
      "attachments": [
        {
          "url": "<string>",
          "sha256": "<string>",
          "size_bytes": 123,
          "filename": "<string>",
          "content_type": "<string>",
          "disposition": "attachment",
          "content_id": "<string>"
        }
      ],
      "events": [
        {
          "type": "queued",
          "occurred_at": "2023-11-07T05:31:56Z",
          "payload": {}
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "scheduled_at": "2023-11-07T05:31:56Z",
      "inline_css": true,
      "sandbox": true,
      "recipient_statuses": {
        "delivered": 998,
        "bounced": 2
      },
      "suppressed": [
        {
          "to": "jsmith@example.com",
          "reason": "<string>",
          "scope": "<string>",
          "override_allowed": true
        }
      ]
    }
  ],
  "meta": {
    "page_size": 50,
    "page_cursor": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Telnyx API key supplied as Authorization: Bearer <token>. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.

Query Parameters

page_size

integer

default:25

Number of results to return. Defaults to 25; maximum is 100. Invalid values are clamped to the valid range.

Required range: 1 <= x <= 100

page_cursor

string

Opaque URL-safe Base64 cursor returned by a previous list response.

filter[tags]

string

Comma-separated tags. Each segment is trimmed, and messages having at least one supplied tag are returned; matching is exact and case-sensitive after trimming. Because commas delimit values and surrounding whitespace is removed, this filter cannot represent stored tags containing literal commas or leading/trailing whitespace. An empty value omits the filter. Empty segments and non-string/nested query shapes return HTTP 400.

filter[metadata]

string

Metadata containment filter, supplied as a JSON object or comma-separated key=value pairs. All supplied key/value pairs must be contained in the message metadata. An empty value or empty JSON object omits the filter. Malformed values, valid non-object JSON, pairs without =, empty keys, and non-string/nested query shapes return HTTP 400.

Response

Paginated list of email messages.

data

object[]

required

Show child attributes

meta

object

required

Show child attributes

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const response of client.emailMessages.list()) {
  console.log(response);
}

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	emailMessages, err := client.EmailMessages.List(context.TODO())
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", emailMessages.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        var page = client.emailMessages().list();
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->emailMessages->list();

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

{
  "data": [
    {
      "record_type": "email_message",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "queued",
      "from": {
        "email": "<string>",
        "name": "<string>"
      },
      "to": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "cc": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "bcc": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "reply_to": "<string>",
      "subject": "<string>",
      "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "template_variables": {},
      "tags": [],
      "metadata": {},
      "attachments": [
        {
          "url": "<string>",
          "sha256": "<string>",
          "size_bytes": 123,
          "filename": "<string>",
          "content_type": "<string>",
          "disposition": "attachment",
          "content_id": "<string>"
        }
      ],
      "events": [
        {
          "type": "queued",
          "occurred_at": "2023-11-07T05:31:56Z",
          "payload": {}
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "scheduled_at": "2023-11-07T05:31:56Z",
      "inline_css": true,
      "sandbox": true,
      "recipient_statuses": {
        "delivered": 998,
        "bounced": 2
      },
      "suppressed": [
        {
          "to": "jsmith@example.com",
          "reason": "<string>",
          "scope": "<string>",
          "override_allowed": true
        }
      ]
    }
  ],
  "meta": {
    "page_size": 50,
    "page_cursor": "<string>"
  }
}

Getting Started

Sending Email

Inboxes

Domains & Validation

Deliverability

Templates & Suppression

Events & Webhooks

For AI Agents

List email messages

Authorizations

Query Parameters

Response