Email Inboxes

List and search messages in an inbox

Changed on

Lists inbound messages newest first. All access is scoped to the authenticated account. filter[search] performs PostgreSQL full-text search over the subject, plain-text body, and HTML body. Filters compose with stable cursor pagination.

get/email_inboxes/{inbox_id}/messages

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/email_inboxes/{inbox_id}/messages
  • Auth: HTTP bearer

Path parameters

inbox_idstring uuid required

Email inbox UUID.

Query parameters

filter[from]string

Case-insensitive literal substring of the sender address.

filter[subject]string

Case-insensitive literal substring of the subject.

filter[received_after]string date-time

Inclusive ISO 8601 lower bound for the received timestamp.

filter[received_before]string date-time

Inclusive ISO 8601 upper bound for the received timestamp.

filter[read]boolean

Whether the message has a read timestamp.

filter[unread]boolean

Whether the message has no read timestamp. Set to true to return only unread messages.

filter[label]string

Returns only messages carrying this label. Matching is exact and case-sensitive. Reserved telnyx: labels can be filtered on even though they cannot be written by customers.

filter[search]string

Full-text query over subject and body, up to 500 characters.

page[size]integer

Number of results to return. Defaults to 25; maximum is 100.

page[after]string

Opaque cursor returned by the previous page.

Response

Paginated inbox messages.

Changes

  • 9621f6123ebcRevision changes
    • warning

      added the new 10011 enum value to the // response property for the response status

    • warning

      added the new 10011 enum value to the // response property for the response status

    • warning

      added the new 10011 enum value to the // response property for the response status

    • warning

      added the new 10011 enum value to the // response property for the response status

    • warning

      added the new domain_graduation_limit_exceeded enum value to the // response property for the response status

    • warning

      added the new domain_graduation_limit_exceeded enum value to the // response property for the response status

    • warning

      added the new domain_graduation_limit_exceeded enum value to the // response property for the response status

    • warning

      added the new domain_graduation_limit_exceeded enum value to the // response property for the response status

  • b1bf96d8391eRevision changes
    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • info

      added the new optional query request parameter filter[label]

    • info

      added the new optional query request parameter filter[unread]

    • info

      added subschema #2 to the / response property allOf list for the response status