List receive rules

GET

/v1/email/mailboxes/{mailbox_id}/receive-rules

for await (const rule of bird.email.mailboxes.receiveRules.list("mbx_01abc")) {
  console.log(rule.action, rule.entry);
}

for rule in client.email.mailboxes.receive_rules.list("mbx_01krdgeqcxet5s7t44vh8rt9mg"):
    print(rule.id, rule.action)

for rule, err := range client.Email.Mailboxes.ReceiveRules.List(context.Background(), "mbx_123", bird.EmailMailboxesReceiveRulesListParams{}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(rule.Id, rule.Action, rule.Entry)
}

foreach ($bird->email->mailboxes->receiveRules->list('mbx_01krdgeqcxet5s7t44vh8rt9mg') as $rule) {
    echo $rule->getAction(), ' ', $rule->getEntry(), "\n";
}

bird email mailboxes receive-rules list <mailbox-id>

curl -X GET "https://us1.platform.bird.com/v1/email/mailboxes/{mailbox_id}/receive-rules" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "limit=25"

Réponse200

{
  "data": [
    {
      "id": "erl_01krdgeqcxet5s7t44vh8rt9mg",
      "mailbox_id": "mbx_01krdgeqcxet5s7t44vh8rt9mg",
      "action": "allow",
      "entry": "partner.example.com",
      "entry_type": "address"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns a paginated list of the mailbox's receive rules, oldest first. Filter by action to see only allow or only block entries.

Paramètres

mailbox_idstring

Mailbox identifier. Starts with mbx_.

Paramètres de requête

actionstring

Return only allow or block rules; omit to return both actions.

Possible values: allow, block

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor 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

data

array of object

obligatoire

Afficher les attributs enfants

next_cursor

nullable string

obligatoire

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor

nullable string

obligatoire

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor

nullable string

obligatoire

Refresh 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.

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

Obtenir un guide d'implémentation

for await (const rule of bird.email.mailboxes.receiveRules.list("mbx_01abc")) {
  console.log(rule.action, rule.entry);
}

for rule in client.email.mailboxes.receive_rules.list("mbx_01krdgeqcxet5s7t44vh8rt9mg"):
    print(rule.id, rule.action)

for rule, err := range client.Email.Mailboxes.ReceiveRules.List(context.Background(), "mbx_123", bird.EmailMailboxesReceiveRulesListParams{}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(rule.Id, rule.Action, rule.Entry)
}

foreach ($bird->email->mailboxes->receiveRules->list('mbx_01krdgeqcxet5s7t44vh8rt9mg') as $rule) {
    echo $rule->getAction(), ' ', $rule->getEntry(), "\n";
}

bird email mailboxes receive-rules list <mailbox-id>

curl -X GET "https://us1.platform.bird.com/v1/email/mailboxes/{mailbox_id}/receive-rules" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "limit=25"

Réponse200

{
  "data": [
    {
      "id": "erl_01krdgeqcxet5s7t44vh8rt9mg",
      "mailbox_id": "mbx_01krdgeqcxet5s7t44vh8rt9mg",
      "action": "allow",
      "entry": "partner.example.com",
      "entry_type": "address"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

List receive rules

Paramètres

Paramètres de requête

Contenu de la réponse

Ressources associées