Class: cloudEmailPreferences

cloudEmailPreferences(domainOrOptionsopt)

new cloudEmailPreferences(domainOrOptionsopt)

Parameters:
Name Type Attributes Description
domainOrOptions string | object <optional>
The project domain or options object. If object, see the object's optional properties.
Properties
Name Type Attributes Description
domain string <optional>
The project domain
token object <optional>
auth token - object with value property and optional headerOrQueryName and isQuery properties
Source:

Methods

getEmailPreferences()

Get the email preferences for the user.
Source:

patchEmailPreference(body)

Update the user's email preferences
Parameters:
Name Type Description
body EmailPreference Email preferences
Source:

setToken(value, headerOrQueryName, isQuery)

Set Token
Parameters:
Name Type Description
value string token's value
headerOrQueryName string the header or query name to send the token at
isQuery boolean true if send the token as query param, otherwise, send as header param
Source: