From 3feafdc25de9c71cd0ca37aeb519e7c93c36763f Mon Sep 17 00:00:00 2001 From: mscdex Date: Thu, 4 Jul 2013 23:47:28 -0400 Subject: [PATCH] readme: add documentation for `flags` Box property --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0136111..76be670 100644 --- a/README.md +++ b/README.md @@ -184,6 +184,7 @@ API * **readOnly** - < _boolean_ > - True if this mailbox was opened in read-only mode. **(Only available with openBox() calls)** * **uidvalidity** - < _integer_ > - A 32-bit number that can be used to determine if UIDs in this mailbox have changed since the last time this mailbox was opened. * **uidnext** - < _integer_ > - The uid that will be assigned to the next message that arrives at this mailbox. + * **flags** - < _array_ > - A list of system-defined flags applicable for this mailbox. Flags in this list but *not* in `permFlags` may be stored for the current session only. Additional server implementation-specific flags may also be available. * **permFlags** - < _array_ > - A list of flags that can be permanently added/removed to/from messages in this mailbox. * **messages** - < _object_ > Contains various message counts for this mailbox: * **total** - < _integer_ > - Total number of messages in this mailbox.