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

Get a mailbox

GET
/v1/email/mailboxes/{mailbox_id}
const mailbox = await bird.email.mailboxes.get("mbx_01abc");
console.log(mailbox.state); // "active"
Réponse200
{
  "id": "mbx_01krdgeqcxet5s7t44vh8rt9mg",
  "address": "concierge@inbox.ai",
  "forwarding_address": "k7q2mzxw4h6p5ra3@eu1.inbound.bird.com",
  "display_name": "Acme Concierge",
  "receive_policy": "open",
  "state": "active",
  "channel": "email",
  "owner": {
    "type": "workspace",
    "id": "ws_01krdgeqcxet5s7t44vh8rt9mg"
  },
  "inbound_address_id": "ina_01krdgeqcxet5s7t44vh8rt9mg",
  "retention_tier": "30d",
  "next": [
    {
      "kind": "operation"
    }
  ]
}

Returns a single mailbox by ID. A mailbox deleted within its 30-day restore window is still returned, with deleted_at set. Once the window closes it is permanently removed and returns 404.

Paramètres

mailbox_idstring

Mailbox identifier. Starts with mbx_.

Contenu de la réponse

id
string
obligatoire

Mailbox ID.

address
string
obligatoire

The mailbox's email address. Immutable once created.

forwarding_address
nullable string
obligatoire

An address we generate on our receiving domain when the mailbox is created on a domain not set up for receiving with us. Forward mail for address here from your current email provider, and it lands in this mailbox. Replies still go out from address. Immutable. It stops receiving while the mailbox is deleted, works again with the same value after a restore, and keeps working if you later enable receiving on the domain. null on mailboxes created on the shared domain or on a domain already enabled for receiving.

display_name
nullable string
obligatoire

Display name used as the sender name on mail from this mailbox. null when unset.

default_reply_to
nullable string
obligatoire

Default Reply-To address stamped on mail sent from this mailbox. null when unset.

receive_policy
string
obligatoire

Which inbound mail the mailbox accepts:

  • open: Accepts everything not blocked by a rule.
  • replies_only: Accepts only replies to messages this mailbox has sent. A reply must match a message the mailbox sent. Landing in an existing thread by itself does not count.
  • allowlist: Accepts only senders matching an allow rule. Replies to prior outbound mail are always admitted unless blocked.
  • drop: Stores nothing.

Possible values: open, replies_only, allowlist, drop

state
string
obligatoire

Lifecycle state. active means the mailbox can send, receive, and expose conversations. suspended pauses sending, conversation reads, and events; inbound mail is retained with the blocked label until you resume it.

Possible values: active, suspended

channel
string
obligatoire

The channel this mailbox receives on. Always email.

Possible values: email

owner
object
obligatoire

The principal that owns the mailbox. Always the workspace.

Afficher les attributs enfants
inbound_address_id
string
obligatoire

The underlying inbound address that receives this mailbox's mail.

retention_tier
string
obligatoire

How long message metadata, extracted text, and attachments are kept. Original bodies and inbound raw MIME are limited to 30 days on every tier.

Possible values: 30d, 90d, 1y

message_count
integer
obligatoire

Number of retained messages across all threads.

thread_count
integer
obligatoire

Number of retained threads.

size_bytes
integer
obligatoire

Stored bytes across the mailbox's retained messages: subject, preview, extracted text, and attachment bytes. Message bodies and raw MIME expire after 30 days and do not count. Maintained with each message written or deleted, so the value is current; messages stored before the counter existed are not counted.

unread_thread_count
nullable integer

Number of threads with unread messages in this mailbox, excluding trash. null on create/update responses.

metadata
object
obligatoire

Your own key/value data attached to the mailbox. Up to 2 KB. Keys starting with __bird are reserved.

local_part_generated
boolean
obligatoire

Whether we generated the local part of the address. false means a custom handle was chosen at creation. On the shared inbox.ai domain a custom handle counts against your plan's custom-handle allowance.

created_at
string
obligatoire

When the mailbox was created.

updated_at
string
obligatoire

When the mailbox was last updated.

deleted_at
nullable string

When the mailbox was deleted, or null if active. Deletion stops receiving; restore is available for 30 days unless permanent erasure has started.

next
array of object

What to do next with this mailbox. The response that creates it suggests subscribing to the mail it receives; other reads of one mailbox return an empty list, and lists omit it.

Afficher les attributs enfants

Ressources associées

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.

Obtenir un guide d'implémentation