Documentation
Sign inGet started
Commencer
Guides
Référence API
SDK
CLI
Base de connaissances
Changelog

Get a received email

GET
/v1/email/inbound-messages/{inbound_message_id}
bird email inbound-messages get <inbound-message-id>
Réponse200
{
  "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>",
  "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.
  • Authentication results.
  • The attachment manifest.
Content is fetched separately:
Received emails are retained for 30 days. An unknown or expired message returns 404.
Paramètres
inbound_message_id
string
Received email identifier. Starts with rem_.
Contenu de la réponse
id
string
obligatoire
Received message ID.
from
object
obligatoire
Sender address parsed from the message.
Afficher les attributs enfants
from.email
string
obligatoire
Email address.
from.name
string
Display name shown alongside the address in mail clients.
to
array of object
obligatoire
Recipients on the message's To header.
Afficher les attributs enfants
to.email
string
obligatoire
Email address.
to.name
string
Display name shown alongside the address in mail clients.
cc
array of object
obligatoire
Recipients on the message's Cc header.
Afficher les attributs enfants
cc.email
string
obligatoire
Email address.
cc.name
string
Display name shown alongside the address in mail clients.
subject
nullable string
obligatoire
Subject line as received, or null when the message had no subject.
message_id
nullable string
obligatoire
RFC 5322 Message-ID header from the sender, or null when the sender did not include one.
in_reply_to
nullable string
obligatoire
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.
thread_id
nullable string
obligatoire
Conversation this message belongs to, or null when it is not grouped into one.
authentication
nullable string
obligatoire
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
obligatoire
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
obligatoire
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
obligatoire
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
obligatoire
Content spam score when available. The receiving provider currently supplies no score, so this is null.
attachments
array of object
obligatoire
Metadata for each attachment found on the message. Empty when the message had no attachments.
Afficher les attributs enfants
attachments.id
string
obligatoire
Attachment ID, stable within the received message.
attachments.filename
nullable string
obligatoire
Filename from the attachment's Content-Disposition, or null when the sender did not name the part.
attachments.content_type
nullable string
obligatoire
MIME type parsed from the attachment part, or null when absent.
attachments.size
integer
obligatoire
Size of the attachment in bytes.
received_at
string
obligatoire
When the message was received.

Ressources associées

Poursuivez avec la documentation, les guides et les exemples sur ce sujet. Les ressources sont en anglais.

Regarder le guideGetting started with emailExplorer la fonctionnalitéEmailSuivre le parcours d'apprentissageBuild your first integrationGuide d'implémentationSend your first email
Essayez la pratique et obtenez un guide d'implémentation