Deployments.ai Docs
Command reference

deployments email

Platform tenant-scoped email delivery

deployments email send

Send email and return the provider acceptance receipt.

deployments email send <tenant-id> --from <from> --to <json> --subject <subject>
  • Calls POST /v1/email/tenants/{tenantId}/messages (SDK sendEmail).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
  • Output contains secrets. They are redacted unless you pass --reveal.
FlagTypeRequiredDefaultDescription
<tenantId>positionalyesSending tenant ID
--fromstringyesSender mailbox; display name allowed
--tostring (json)yesJSON array of recipient mailboxes
--ccstring (json)JSON array of CC mailboxes
--bccstring (json)JSON array of BCC mailboxes
--reply-tostring (json)JSON array of reply-to mailboxes
--subjectstringyesMessage subject
--textstringPlain-text body; prefer --text-file or --text-env for secrets
--htmlstringHTML body; prefer --html-file or --html-env for secrets
--text-filestringFile containing the plain-text body
--html-filestringFile containing the HTML body
--text-envstringEnvironment variable containing the plain-text body
--html-envstringEnvironment variable containing the HTML body

Also accepts the global flags.

On this page