mirror of
https://github.com/Foundry376/Mailspring.git
synced 2025-01-01 13:14:16 +08:00
63 lines
2.1 KiB
HTML
63 lines
2.1 KiB
HTML
---
|
|
layout: docs
|
|
title: Account
|
|
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/models/account.coffee"
|
|
---
|
|
|
|
<h2>Summary</h2>
|
|
|
|
<div class="markdown-from-sourecode">
|
|
<p><p>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.</p>
|
|
<p>For more information about Accounts on the Nylas Platform, read the
|
|
<a href="https://nylas.com/docs/api#Account">Account API Documentation</a></p>
|
|
<h2 id="attributes">Attributes</h2>
|
|
<p><code>name</code>: <a href='attributestring.html'>AttributeString</a> The name of the Account.</p>
|
|
<p><code>provider</code>: <a href='attributestring.html'>AttributeString</a> The Account's mail provider (ie: <code>gmail</code>)</p>
|
|
<p><code>emailAddress</code>: <a href='attributestring.html'>AttributeString</a> The Account's email address
|
|
(ie: <code>ben@nylas.com</code>). Queryable.</p>
|
|
<p><code>organizationUnit</code>: <a href='attributestring.html'>AttributeString</a> Either "label" or "folder".
|
|
Depending on the provider, the account may be organized by folders or
|
|
labels.</p>
|
|
<p>This class also inherits attributes from <a href='model.html'>Model</a></p>
|
|
</p>
|
|
</div>
|
|
|
|
<ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Instance Methods</h3>
|
|
|
|
<h4 id=usesLabels class="function-name">
|
|
usesLabels(<span class="args"></span>) <a href="#usesLabels" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p><p>The current organization_unit used by the account. </p>
|
|
</p>
|
|
</div>
|
|
|
|
|
|
<h4 id=displayProvider class="function-name">
|
|
displayProvider(<span class="args"></span>) <a href="#displayProvider" class="link"></a>
|
|
</h4>
|
|
|
|
<div class="function-description markdown-from-sourecode">
|
|
<p></p>
|
|
</div>
|
|
|
|
|
|
<strong>Returns</strong>
|
|
<table class="arguments">
|
|
<tr>
|
|
<th>Return Values</th>
|
|
</tr>
|
|
<tr><td class="markdown-from-sourecode"><p>Returns the localized, properly capitalized provider name,
|
|
like Gmail, Exchange, or Outlook 365</p>
|
|
</td></tr>
|
|
</table>
|