Send

API Reference

Emails

Send

client.emails.send(EmailSendParamsbody?, RequestOptionsoptions?): messagestringEmailSendResponse

post/v1/email

Send emails

Parameters

bodyattachmentsarraybccunionccunionfromunionheadersRecord<string, string>htmlstringreplyToListunionsubjectstringtextstringtounionEmailSendParams

Hide ParametersShow Parameters

attachmentsarray

optional

Array<Attachment>

A list of attachments to add to the email

Hide ParametersShow Parameters

contentstring

filenamestring

contentIdstring

optional

dispositionstring

optional

typestring

optional

bccunion

optional

string | emailstringnamestringEmailNameAndAddress | Array<string | EmailNameAndAddress>

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

Hide ParametersShow Parameters

string

EmailNameAndAddress

An email address and name

Hide ParametersShow Parameters

emailstring

namestring

optional

Array<string | EmailNameAndAddress>

ccunion

optional

string | emailstringnamestringEmailNameAndAddress | Array<string | EmailNameAndAddress>

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

Hide ParametersShow Parameters

string

EmailNameAndAddress

An email address and name

Hide ParametersShow Parameters

emailstring

namestring

optional

Array<string | EmailNameAndAddress>

fromunion

optional

string | emailstringnamestringEmailNameAndAddress

An email address and name

Hide ParametersShow Parameters

string

EmailNameAndAddress

An email address and name

Hide ParametersShow Parameters

emailstring

namestring

optional

headersRecord<string, string>

optional

A set of headers to include the email that you send

htmlstring

optional

HTML content of the email. Can be specified alongside text

replyToListunion

optional

emailstringnamestringEmailNameAndAddress | Array<EmailList>

A reply-to list of email addresses

Hide ParametersShow Parameters

EmailNameAndAddress

An email address and name

Hide ParametersShow Parameters

emailstring

namestring

optional

Array<EmailList>

subjectstring

optional

The subject line of the email

textstring

optional

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

tounion

optional

string | emailstringnamestringEmailNameAndAddress | Array<string | EmailNameAndAddress>

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

Hide ParametersShow Parameters

string

EmailNameAndAddress

An email address and name

Hide ParametersShow Parameters

emailstring

namestring

optional

Array<string | EmailNameAndAddress>

Returns

EmailSendResponse

Successfully sent email

Hide ParametersShow Parameters

messagestring

HTTPTypeScript

import ValTown from '@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);

200 Example

{
  "message": "message"
}