Restore a deleted mailbox
/v1/email/mailboxes/{mailbox_id}/restoreconst mailbox = await bird.email.mailboxes.restore("mbx_01abc");
console.log(mailbox.deleted_at); // nullmailbox = client.email.mailboxes.restore("mbx_01krdgeqcxet5s7t44vh8rt9mg")
print(mailbox.id)mailbox, err := client.Email.Mailboxes.Restore(context.Background(), "mbx_123")
if err != nil {
log.Fatal(err)
}
fmt.Println(mailbox.Id)$mailbox = $bird->email->mailboxes->restore('mbx_01krdgeqcxet5s7t44vh8rt9mg');
echo $mailbox->getState();bird email mailboxes restore <mailbox-id>curl -X POST "https://us1.platform.bird.com/v1/email/mailboxes/{mailbox_id}/restore" \
-H "Authorization: Bearer $TOKEN"{
"id": "mbx_01krdgeqcxet5s7t44vh8rt9mg",
"address": "concierge@inbox.ai",
"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"
}
Restores receiving and access to unexpired messages. Returns 404 if deletion was 30 or more days ago or permanent erasure has started, and 409 if the mailbox is not deleted or its address is unavailable.
参数
mailbox_idstringMailbox identifier. Starts with mbx_.
响应载荷
idMailbox ID.
addressThe mailbox's email address. Immutable once created.
display_nameDisplay name used as the sender name on mail from this mailbox. null when unset.
default_reply_toDefault Reply-To address stamped on mail sent from this mailbox. null when unset.
receive_policyWhich 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
stateLifecycle 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
channelThe channel this mailbox receives on. Always email.
Possible values: email
ownerThe principal that owns the mailbox. Always the workspace.
显示子属性
owner.typeOwner principal type.
Possible values: workspace
owner.idOwner principal ID.
inbound_address_idThe underlying inbound address that receives this mailbox's mail.
retention_tierHow 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_countNumber of retained messages across all threads.
thread_countNumber of retained threads.
size_bytesStored 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_countNumber of threads with unread messages in this mailbox, excluding trash. null on create/update responses.
metadataYour own key/value data attached to the mailbox. Up to 2 KB. Keys starting with __bird are reserved.
local_part_generatedWhether 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_atWhen the mailbox was created.
updated_atWhen the mailbox was last updated.
deleted_atWhen the mailbox was deleted, or null if active. Deletion stops receiving; restore is available for 30 days unless permanent erasure has started.