API ReferenceInboxesMessages

Send Message

**CLI:** ```bash agentmail inboxes:messages send --inbox-id <inbox_id> --to recipient@example.com --subject "Hello" --text "Body" ```

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

inbox_idstringRequired
The ID of the inbox.

Request

This endpoint expects an object.
labelslist of stringsOptional
Labels of message.
reply_tostring or list of stringsOptional

Reply-to address or addresses.

tostring or list of stringsOptional
Recipient address or addresses.
ccstring or list of stringsOptional
CC recipient address or addresses.
bccstring or list of stringsOptional
BCC recipient address or addresses.
subjectstringOptional
Subject of message.
textstringOptional
Plain text body of message.
htmlstringOptional
HTML body of message.
attachmentslist of objectsOptional
Attachments to include in message.
headersmap from strings to stringsOptional
Headers to include in message.
track_opensbooleanOptional

Track when this message is first opened. Requires a custom domain with tracking enabled and an HTML body. Opens surface as the opened label on the message and as a message.opened event. One pixel is injected per message, not per recipient, so a message with several recipients fires once when any of them opens it, and the event does not identify which one.

Response

This endpoint returns an object.
message_idstring
ID of message.
thread_idstring
ID of thread.

Errors

400
Validation Error
403
Message Rejected Error
404
Not Found Error
409
Conflict Error