List mailboxes
/v1/email/mailboxesfor await (const mailbox of bird.email.mailboxes.list()) {
console.log(mailbox.address);
}for mailbox in client.email.mailboxes.list():
print(mailbox.id, mailbox.address)for mailbox, err := range client.Email.Mailboxes.List(context.Background(), bird.EmailMailboxesListParams{}) {
if err != nil {
log.Fatal(err)
}
fmt.Println(mailbox.Id)
}foreach ($bird->email->mailboxes->list() as $mailbox) {
echo $mailbox->getId(), ' ', $mailbox->getAddress(), "\n";
}bird email mailboxes listcurl -X GET "https://us1.platform.bird.com/v1/email/mailboxes" \
-H "Authorization: Bearer $TOKEN" \
--url-query "address=concierge@inbox.ai" \
--url-query "q=concierge" \
--url-query "domain=inbox.ai" \
--url-query "include_deleted=false" \
--url-query "limit=25"{
"data": [
{
"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"
}
]
}
],
"next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
"prev_cursor": null,
"refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}
Returns a paginated list of the workspace's mailboxes, newest first. Search across addresses and display names with q, look a mailbox up by its exact address, or filter by lifecycle state or domain.
Paramètres de requête
addressstringFilter to the mailbox with exactly this address.
qstringCase-insensitive search matching the mailbox's address or display name (substring).
statestringReturn only active or suspended mailboxes. Use include_deleted for restorable deleted mailboxes.
Possible values: active, suspended
domainstringFilter to mailboxes whose address is on this domain.
include_deletedbooleanInclude mailboxes deleted within their 30-day restore window. Defaults to false, so only active and suspended mailboxes are returned. A deleted mailbox has deleted_at set.
limitintegerMaximum number of items to return per page.
starting_afterstringCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_beforestringCursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
Contenu de la réponse
datanext_cursorCursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.
prev_cursorCursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.
refresh_cursorRefresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.
Ressources associées
Poursuivez avec la documentation, les guides et les exemples sur ce sujet.