mirror of
https://github.com/Foundry376/Mailspring.git
synced 2025-01-01 13:14:16 +08:00
42 lines
1.6 KiB
HTML
42 lines
1.6 KiB
HTML
---
|
|
layout: docs
|
|
title: Folder
|
|
edit_url: "https://github.com/nylas/N1/blob/master/src/flux/models/folder.coffee"
|
|
---
|
|
|
|
<h2>Summary</h2>
|
|
|
|
<div class="markdown-from-sourecode">
|
|
<p><p>The Folder model represents a Nylas Folder object. For more
|
|
information about Folder on the Nylas Platform, read the <a href="https://nylas.com/docs/api#folders">Folder API
|
|
Documentation</a></p>
|
|
<p>NOTE: This is different from a <code>Label</code>. A <code>Folder</code> is used for generic
|
|
IMAP and Exchange, while <code>Label</code>s are used for Gmail. The <code>Account</code> has
|
|
the filed <code>organizationUnit</code> which specifies if the current account uses
|
|
either "folder" or "label".</p>
|
|
<p>While the two appear fairly similar, they have different behavioral
|
|
semantics and are treated separately.</p>
|
|
<p>Nylas also exposes a set of standard types or categories of folders/
|
|
labels: an extended version of [rfc-6154]
|
|
(<a href="http://tools.ietf.org/html/rfc6154">http://tools.ietf.org/html/rfc6154</a>), returned as the name of the folder/
|
|
label:</p>
|
|
<ul>
|
|
<li>inbox</li>
|
|
<li>all</li>
|
|
<li>trash</li>
|
|
<li>archive</li>
|
|
<li>drafts</li>
|
|
<li>sent</li>
|
|
<li>spam</li>
|
|
<li>important</li>
|
|
</ul>
|
|
<p>NOTE: "starred" and "unread" are no longer folder nor labels. They are now
|
|
boolean values on messages and threads.</p>
|
|
<h2 id="attributes">Attributes</h2>
|
|
<p><code>name</code>: <a href='attributestring.html'>AttributeString</a> The internal name of the folder. Queryable.</p>
|
|
<p><code>displayName</code>: <a href='attributestring.html'>AttributeString</a> The display-friendly name of the folder. Queryable.</p>
|
|
</p>
|
|
</div>
|
|
|
|
<ul>
|
|
</ul>
|