Mailspring/docs/Account.html

64 lines
2.1 KiB
HTML
Raw Normal View History

2015-10-03 01:57:40 +08:00
---
layout: docs
title: Account
2015-10-04 03:05:22 +08:00
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/models/account.coffee"
2015-10-03 01:57:40 +08:00
---
2015-10-02 03:34:16 +08:00
2015-10-03 01:57:40 +08:00
<h2>Summary</h2>
2015-10-02 03:34:16 +08:00
2015-10-03 01:57:40 +08:00
<div class="markdown-from-sourecode">
<p><p>The Account model represents a Account served by the Nylas Platform API.
2015-10-02 03:34:16 +08:00
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>
2015-10-03 01:57:40 +08:00
<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&#39;s mail provider (ie: <code>gmail</code>)</p>
<p><code>emailAddress</code>: <a href='attributestring.html'>AttributeString</a> The Account&#39;s email address
2015-10-02 03:34:16 +08:00
(ie: <code>ben@nylas.com</code>). Queryable.</p>
2015-10-03 01:57:40 +08:00
<p><code>organizationUnit</code>: <a href='attributestring.html'>AttributeString</a> Either &quot;label&quot; or &quot;folder&quot;.
2015-10-02 03:34:16 +08:00
Depending on the provider, the account may be organized by folders or
labels.</p>
2015-10-03 01:57:40 +08:00
<p>This class also inherits attributes from <a href='model.html'>Model</a></p>
2015-10-02 03:34:16 +08:00
</p>
</div>
2015-10-03 01:57:40 +08:00
<ul>
</ul>
<h3>Instance Methods</h3>
<h4 id=usesLabels class="function-name">
usesLabels(<span class="args"></span>) <a href="#usesLabels" class="link"></a>
</h4>
2015-10-04 03:05:22 +08:00
2015-10-03 01:57:40 +08:00
<div class="function-description markdown-from-sourecode">
<p><p>The current organization_unit used by the account. </p>
</p>
</div>
2015-10-04 03:05:22 +08:00
2015-10-03 01:57:40 +08:00
<h4 id=displayProvider class="function-name">
displayProvider(<span class="args"></span>) <a href="#displayProvider" class="link"></a>
</h4>
2015-10-04 03:05:22 +08:00
2015-10-03 01:57:40 +08:00
<div class="function-description markdown-from-sourecode">
<p></p>
</div>
2015-10-04 03:05:22 +08:00
2015-10-03 01:57:40 +08:00
<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>