@ -255,18 +255,18 @@ Each message part is identified by a partID which is used when you want to fetch
The structure of a message with only one part will simply look something like this:
```javascript
[ { partID: '1'
, type: 'text'
, subtype: 'plain'
, params: { charset: 'ISO-8859-1' }
, id: null
, description: null
, encoding: '7BIT'
, size: 935
, lines: 46
, md5: null
, disposition: null
, language: null
[ { partID: '1',
type: 'text',
subtype: 'plain',
params: { charset: 'ISO-8859-1' },
id: null,
description: null,
encoding: '7BIT',
size: 935,
lines: 46,
md5: null,
disposition: null,
language: null
}
]
```
@ -323,13 +323,13 @@ ImapConnection Properties
There should always be at least one entry (although the IMAP spec allows for more, it doesn't seem to be very common) in the personal namespace list, with a blank namespace prefix. Each property's array contains objects of the following format (with example values):
```javascript
{ prefix: '' // A string containing the prefix to use to access mailboxes in this namespace
, delimiter: '/' // A string containing the hierarchy delimiter for this namespace, or boolean false
{ prefix: '', // A string containing the prefix to use to access mailboxes in this namespace
delimiter: '/', // A string containing the hierarchy delimiter for this namespace, or boolean false
// for a flat namespace with no hierarchy
, extensions: [ // An array of namespace extensions supported by this namespace, or null if none
extensions: [ // An array of namespace extensions supported by this namespace, or null if none
// are specified
{ name: 'X-FOO-BAR' // A string indicating the extension name
, params: [ 'BAZ' ] // An array of strings containing the parameters for this extension,
{ name: 'X-FOO-BAR', // A string indicating the extension name
params: [ 'BAZ' ] // An array of strings containing the parameters for this extension,
// or null if none are specified
}
]
@ -382,62 +382,62 @@ ImapConnection Functions
```javascript
{ INBOX: // mailbox name
{ attribs: [] // mailbox attributes. An attribute of 'NOSELECT' indicates the mailbox cannot
{ attribs: [], // mailbox attributes. An attribute of 'NOSELECT' indicates the mailbox cannot
// be opened
, displayName: 'INBOX' // the UTF-7-decoded version of the mailbox name
, delimiter: '/' // hierarchy delimiter for accessing this mailbox's direct children.
, children: null // an object containing another structure similar in format to this top level,
displayName: 'INBOX', // UTF-7-decoded version of the mailbox name
delimiter: '/', // hierarchy delimiter for accessing this mailbox's direct children.
children: null, // an object containing another structure similar in format to this top level,
// otherwise null if no children
, parent: null // pointer to parent mailbox, null if at the top level
}
, Work:
{ attribs: []
, delimiter: '/'
, children: null
, parent: null
}
, '[Gmail]':
{ attribs: [ 'NOSELECT' ]
, delimiter: '/'
, children:
parent: null // pointer to parent mailbox, null if at the top level
`request` is an _object_ or an _array_ of _object_s with the following valid properties:
`request` is an _object_ or an _array_ of _object_ with the following valid properties:
* **id** - <_mixed_ > - _integer_ or _string_ referencing a message part to use when retrieving headers and/or a body. **Default:** (root part/entire message)