Skip to content

Commit

Permalink
Introduce MailFolderType
Browse files Browse the repository at this point in the history
  • Loading branch information
jobisoft committed Oct 23, 2023
1 parent 14e3259 commit 09cd334
Showing 1 changed file with 46 additions and 28 deletions.
74 changes: 46 additions & 28 deletions folders.rst
Original file line number Diff line number Diff line change
Expand Up @@ -600,35 +600,9 @@ An object describing a mail folder, as returned for example by the :ref:`folders

.. api-member::
:name: [``type``]
:type: (`string`, optional)
:type: (:ref:`folders.MailFolderType`, optional)

The type of folder, for several common types.

Supported values:

.. api-member::
:name: :value:`inbox`

.. api-member::
:name: :value:`drafts`

.. api-member::
:name: :value:`sent`

.. api-member::
:name: :value:`trash`

.. api-member::
:name: :value:`templates`

.. api-member::
:name: :value:`archives`

.. api-member::
:name: :value:`junk`

.. api-member::
:name: :value:`outbox`
The type of folder.


.. _folders.MailFolderInfo:
Expand Down Expand Up @@ -664,3 +638,47 @@ An object containing additional information about a mail folder.

Number of unread messages in this folder.


.. _folders.MailFolderType:

MailFolderType
--------------

.. api-section-annotation-hack::

The type of folder

.. api-header::
:label: `string`


.. container:: api-member-node

.. container:: api-member-description-only

Supported values:

.. api-member::
:name: :value:`inbox`

.. api-member::
:name: :value:`drafts`

.. api-member::
:name: :value:`sent`

.. api-member::
:name: :value:`trash`

.. api-member::
:name: :value:`templates`

.. api-member::
:name: :value:`archives`

.. api-member::
:name: :value:`junk`

.. api-member::
:name: :value:`outbox`

0 comments on commit 09cd334

Please sign in to comment.