Send

client.emails.send(?, ?): EmailSendResponse { message }

post/v1/email

Send emails

ParametersExpand Collapse

body: EmailSendParams { attachments, bcc, cc, 7 more }

attachments?: Array<Attachment>

A list of attachments to add to the email

content: string

filename: string

contentId?: string

disposition?: string

type?: string

bcc?: string | EmailNameAndAddress { email, name } | Array<string | EmailNameAndAddress { email, name } >

A single email or list of emails for one of the address fields

Accepts one of the following:

string

EmailNameAndAddress { email, name }

An email address and name

email: string

name?: string

Array<string | EmailNameAndAddress { email, name } >

string

EmailNameAndAddress { email, name }

An email address and name

email: string

name?: string

cc?: string | EmailNameAndAddress { email, name } | Array<string | EmailNameAndAddress { email, name } >

A single email or list of emails for one of the address fields

Accepts one of the following:

string

EmailNameAndAddress { email, name }

An email address and name

email: string

name?: string

Array<string | EmailNameAndAddress { email, name } >

string

EmailNameAndAddress { email, name }

An email address and name

email: string

name?: string

from?: string | EmailNameAndAddress { email, name }

An email address and name

Accepts one of the following:

string

EmailNameAndAddress { email, name }

An email address and name

email: string

name?: string

headers?: Record<string, string>

A set of headers to include the email that you send

html?: string

HTML content of the email. Can be specified alongside text

minLength1

replyToList?: EmailNameAndAddress { email, name } | Array<EmailList>

A reply-to list of email addresses

Accepts one of the following:

EmailNameAndAddress { email, name }

An email address and name

email: string

name?: string

Array<EmailList>

email: string

name?: string

subject?: string

The subject line of the email

text?: string

Text content of the email, for email clients that may not support HTML

to?: string | EmailNameAndAddress { email, name } | Array<string | EmailNameAndAddress { email, name } >

A single email or list of emails for one of the address fields

Accepts one of the following:

string

EmailNameAndAddress { email, name }

An email address and name

email: string

name?: string

Array<string | EmailNameAndAddress { email, name } >

string

EmailNameAndAddress { email, name }

An email address and name

email: string

name?: string

ReturnsExpand Collapse

EmailSendResponse { message }

Successfully sent email

message: string

import ValTown from "npm:@valtown/sdk";

const client = new ValTown({
  bearerToken: 'My Bearer Token',
});

const response = await client.emails.send({
  html: 'Hello <strong>world</strong>',
  subject: 'An important message',
  text: 'Hello world',
});

console.log(response.message);

{
  "message": "message"
}

Returns Examples

{
  "message": "message"
}