Sign inGet Started
Começar
Guias
Referência de API
SDKs
CLI
Base de conhecimento
Changelog

Get a received email

GET
/v1/email/inbound-messages/{inbound_message_id}
bird email inbound-messages get <inbound-message-id>
Resposta200
{
  "id": "rem_01krdgeqcxet5s7t44vh8rt9mg",
  "from": {
    "email": "jane@acme.com",
    "name": "Jane Doe"
  },
  "to": [
    {
      "email": "jane@acme.com",
      "name": "Jane Doe"
    }
  ],
  "cc": [
    {
      "email": "jane@acme.com",
      "name": "Jane Doe"
    }
  ],
  "subject": "Re: Your receipt",
  "message_id": "<CAH+T8d5...@mail.gmail.com>",
  "in_reply_to": "<previous-message@example.com>",
  "mailbox_id": "mbx_01krdgeqcxet5s7t44vh8rt9mg",
  "authentication": "pass",
  "attachments": [
    {
      "id": "rea_01krdgeqcxet5s7t44vh8rt9mg",
      "filename": "invoice.pdf",
      "content_type": "application/pdf",
      "size": 215432
    }
  ]
}

Returns the parsed metadata for a received email:

  • Addresses.
  • Subject.
  • Threading headers.
  • The mailbox and conversation that received it, when a mailbox did.
  • Authentication results.
  • The attachment manifest.

Content is fetched separately:

Received emails are retained for 30 days. An unknown or expired message returns 404.

Parâmetros

inbound_message_idstring

Received email identifier. Starts with rem_.

Payload de resposta

id
string
obrigatório

Received message ID.

from
object
obrigatório

Sender address parsed from the message.

Mostrar atributos secundários
to
array of object
obrigatório

Recipients on the message's To header.

Mostrar atributos secundários
cc
array of object
obrigatório

Recipients on the message's Cc header.

Mostrar atributos secundários
subject
nullable string
obrigatório

Subject line as received, or null when the message had no subject.

message_id
nullable string
obrigatório

RFC 5322 Message-ID header from the sender, or null when the sender did not include one.

in_reply_to
nullable string
obrigatório

The In-Reply-To header, which holds the Message-ID this message is replying to. null when the message is not a reply.

references
array of string

The References header, which holds every Message-ID in this conversation, oldest first. Left out when the message arrived without one.

mailbox_id
nullable string
obrigatório

Mailbox that received this message, or null when it arrived on an inbound address or domain without a mailbox.

thread_id
nullable string
obrigatório

Mailbox conversation this message belongs to, or null when it was not received by a mailbox or has since been deleted from it.

authentication
nullable string
obrigatório

DMARC result for the domain in the received message's From header.

  • pass: SPF or DKIM passed and aligned with that domain.
  • fail: DMARC was evaluated and did not pass.
  • unknown: no trustworthy verdict is available.

This follows dmarc_pass and does not verify a particular person. The receiving provider currently supplies no DMARC result, so received messages report unknown.

Possible values: pass, fail, unknown, null

spf_pass
nullable boolean
obrigatório

Whether the receiving provider reports that SPF authorized the envelope sender for the sending server. A soft failure is false. Missing, neutral and inconclusive results are null.

dkim_pass
nullable boolean
obrigatório

Whether the receiving provider verified a DKIM signature. A passing signature makes this true even when another signature fails. Missing signatures and inconclusive verification results are null.

dmarc_pass
nullable boolean
obrigatório

Whether SPF or DKIM passed and aligned with the domain in the message's From header. The receiving provider currently supplies no DMARC result, so this is null.

spam_score
nullable number
obrigatório

Content spam score when available. The receiving provider currently supplies no score, so this is null.

attachments
array of object
obrigatório

Metadata for each attachment found on the message. Empty when the message had no attachments.

Mostrar atributos secundários
attachments.id
string
obrigatório

Attachment ID, stable within the received message.

attachments.filename
nullable string
obrigatório

Filename from the attachment's Content-Disposition, or null when the sender did not name the part.

attachments.content_type
nullable string
obrigatório

MIME type parsed from the attachment part, or null when absent.

attachments.size
integer
obrigatório

Size of the attachment in bytes.

received_at
string
obrigatório

When the message was received.

Recursos relacionados

Continue com a documentação, guias e exemplos sobre este tópico.

Experimente na prática e obtenha um resumo de implementação