Skip to content

SDK method

tools.sendEmail

Send an email. Convenience alias for send_email, forwarding to tinbox.api.messages.send.mutate.

Signature

ts
sendEmail(input: Parameters<TinboxTools["sendEmail"]>[0]): ReturnType<TinboxTools["sendEmail"]>

Parameters

NameTypeRequiredDescription
inboxIdstringyesThe inbox to send from (required).
tostring[]yesRecipient address(es).
ccstring[]no—
bccstring[]no—
subjectstringyesEmail subject.
bodyTextstringnoPlain-text body (provide bodyText and/or bodyHtml).
bodyHtmlstringnoHTML body.
fromstringnoExplicit From — must be an address this inbox owns.

Returns

ReturnType<TinboxTools["sendEmail"]>

Example

ts
await tinbox.tools.sendEmail({
  "inboxId": "ibx_…",
  "to": [
    "ada@example.com"
  ],
  "subject": "<subject>"
});