Class: EmailsAPI

new EmailsAPI(rest)

This class is used to interact with Emails in TidyHQ.

Parameters:

Name	Type	Description
`rest`	Rest	The rest instance to use for requests.

Source: src/Emails.js, line 14

Methods

(async) createEmail(email, optionsopt) → {Promise.<TidyAPI_V1_Email>}

Create a new email.

Parameters:

Name Type Attributes Default Description

email

object

The email to create.

Properties

Name	Type	Description
`subject`	string	The subject of the email.
`body`	string	The body of the email.
`contacts`	Array.<number>	The contacts to send the email to.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/Emails.js, line 67

Returns:

- The email.

Type:: Promise.<TidyAPI_V1_Email>

(async) getEmail(email_id, optionsopt) → {Promise.<TidyAPI_V1_Email>}

Get a specific email associated with the access token.

Parameters:

Name Type Attributes Default Description

email_id string The ID of the email.

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/Emails.js, line 53

Returns:

- The email.

Type:: Promise.<TidyAPI_V1_Email>

(async) getEmails(optionsopt) → {Promise.<TidyAPI_V1_Emails>}

Get the emails associated with the access token.

Parameters:

Name Type Attributes Default Description

options

object

{}

Properties

Name	Type	Attributes	Description
`access_token`	string	<optional>	The access token to use.

Source: src/Emails.js, line 42

Returns:

- The emails.

Type:: Promise.<TidyAPI_V1_Emails>