bird lookup email
Usage
Przykład kodu
bird lookup email [flags]Description
Create an email address lookup
Create a deliverability lookup for one email address. Returns result, delivery_confidence, address flags, an undeliverable reason, and did_you_mean when a correction is available. Treat unknown result and reason values as valid additions and use delivery_confidence as the fallback; each completed lookup incurs the same charge.
Build the request from flags, a JSON EmailLookupRequest body via --body-file ("-" reads
stdin), or both — a flag overrides the matching body field. Run --example to
print a ready-to-edit body, or --dry-run to print the resolved request without
sending it.
Examples
Przykład kodu
# print the body shape (no credentials needed)
bird lookup email --example
# the body it prints:Przykład kodu
{
"email": "aisha.khan@example.com"
}Options
Request
| Name | Description |
|---|---|
| --body-file | Read the JSON request body from this file; "-" reads stdin |
| --example | Print a complete example request body, then exit |
| --dry-run | Print the resolved request without sending it, then exit |
| --idempotency-key | Deduplication key; a retry with the same key won't act twice |
Options
| Name | Description |
|---|---|
| The email address to look up. Send it exactly as you hold it. The part before the @ is case-sensitive, so the API does not lowercase it. A display-name form such as Aisha <aisha@example.com> is rejected rather than unwrapped. | |
| --response-schema | Print the fields this command returns, then exit |
Related
| Name | Description |
|---|---|
| bird lookup phone-number | Create a phone number lookup |