Class

EmailClient

EmailClient()

Manages email addresses of the current user.
Constructor

# new EmailClient()

View Source lib/client/EmailClient.ts, line 12

Extends

Members

Methods

# async create(address) → {Promise.<Email>}

Adds a new email address to the current user.
Parameters:
Name Type Description
address string The email address to be added.
See:

View Source lib/client/EmailClient.ts, line 137

Promise.<Email>

# async delete(emailID) → {Promise.<void>}

Deletes the specified email address.
Parameters:
Name Type Description
emailID string The ID of the email address to be deleted
See:

View Source lib/client/EmailClient.ts, line 163

Promise.<void>

# async list() → {Promise.<Emails>}

Returns a list of all email addresses assigned to the current user.
See:

View Source lib/client/EmailClient.ts, line 122

Promise.<Emails>

# async setPrimaryEmail(emailID) → {Promise.<void>}

Marks the specified email address as primary.
Parameters:
Name Type Description
emailID string The ID of the email address to be updated
See:

View Source lib/client/EmailClient.ts, line 150

Promise.<void>