Sign inGet Started

CLI

Verstuur je eerste e-mail vanuit een macOS- of Linux-terminal: installeer de bird CLI, log één keer in en verstuur. Je hoeft geen API-sleutel te kopiëren.

1. Installeren

Codevoorbeeld
curl -fsSL https://cli.bird.com/install.sh | sh
Voer bird version uit om te bevestigen dat de installatie is geslaagd. Zie Installeer de CLI voor Windows en andere installatieopties.

2. Inloggen

Codevoorbeeld
bird auth login --scope emails:write
Dit opent een toestemmingspagina in de browser waar je een werkruimte kiest en de machtiging goedkeurt. De emails:write-scope laat stap 3 verzenden. Zonder deze scope vraagt bird auth login alleen leestoegang aan en wordt het verzenden geweigerd. De CLI slaat een werkruimtegebonden OAuth-token op in ~/.config/bird/credentials.json, vernieuwt het wanneer nodig en registreert de werkruimteregio.

3. Een e-mail versturen

Verstuur vanaf het gedeelde onboardingdomein van Bird naar het delivered@messagebird.dev-sandbox-adres: geen domeinverificatie, geen echte mailbox nodig.
Codevoorbeeld
bird email send \
  --from onboarding@messagebird.dev \
  --to delivered@messagebird.dev \
  --subject "Hello from Bird" \
  --html "<p>My first Bird email.</p>"
De CLI toont het geaccepteerde bericht als JSON. De *_count-velden volgen ontvangers door de afleverstatussen. In het eerste antwoord is één ontvanger geaccepteerd en zijn er geen afgeleverd:
Codevoorbeeld
{
  "id": "em_01ky7ma8y2es1s2akzk53tmjn0",
  "status": "accepted",
  "category": "marketing",
  "from": { "email": "onboarding@messagebird.dev" },
  "to": [{ "email": "delivered@messagebird.dev" }],
  "subject": "Hello from Bird",
  "accepted_count": 1,
  "processed_count": 0,
  "delivered_count": 0,
  "deferred_count": 0,
  "bounced_count": 0,
  "complained_count": 0,
  "rejected_count": 0,
  "open_count": 0,
  "click_count": 0,
  "track_opens": true,
  "track_clicks": true,
  "created_at": "2026-07-23T13:58:20.866Z"
}
--to is herhaalbaar voor meerdere ontvangers, --text verstuurt een platte-tekstbody, en --dry-run toont het opgeloste verzoek zonder het te verzenden.

4. Het resultaat controleren

accepted betekent dat Bird het bericht heeft aangenomen en het asynchroon aflevert. Lees het terug via zijn em_-ID en wacht tot de status delivered bereikt:
Codevoorbeeld
bird email get em_01ky7ma8y2es1s2akzk53tmjn0
Voeg --format text toe voor een leesbare kaart in plaats van JSON.
Elk commando schrijft standaard JSON naar standaarduitvoer. Fouten gebruiken een JSON-foutantwoord op standaardfout, en exitcodes identificeren foutcategorieën. Zie de CLI voor agents voor het volledige contract.

Volgende stappen