Summary
The Account model represents a Account served by the Nylas Platform API. Every object on the Nylas platform exists within a Account, which typically represents an email account.
For more information about Accounts on the Nylas Platform, read the Account API Documentation
Attributes
name
: AttributeString The name of the Account.
provider
: AttributeString The Account's mail provider (ie: gmail
)
emailAddress
: AttributeString The Account's email address
(ie: ben@nylas.com
). Queryable.
organizationUnit
: AttributeString Either "label" or "folder".
Depending on the provider, the account may be organized by folders or
labels.
This class also inherits attributes from Model
Instance Methods
usesLabels()
The current organization_unit used by the account.
displayProvider()
Return Values |
---|
Returns the localized, properly capitalized provider name, like Gmail, Exchange, or Outlook 365 |