Generic Function | Package: net.post-office | ToC | DocOverview | CGDoc | RelNotes | FAQ | Index | PermutedIndex
| Allegro CL version 9.0 Unrevised from 8.2 to 9.0. 8.2 version

## mailbox-list

Arguments: mailbox &key reference pattern

This function returns a list of items describing the mailboxes that match the arguments. The reference is the root of the hierarchy to scan. By default it is the empty string (from which all mailboxes are reachable). The pattern is a string matched against all mailbox names reachable from reference. There are two special characters allowed in the pattern: an asterisk (*) matches all characters including hierarchy delimiters; a percent (%) matches all characters but not the hierarchy delimiter. Thus

    (mailbox-list mailbox :pattern "*")

returns a list of all mailboxes at all depths in the hierarchy.

The value returned is a list of lists. Accessing the inner lists can be done with the following accessor functions:

- mailbox-list-flags
- mailbox-list-separator
- mailbox-list-name

See imap.htm for more information.

Copyright (c) 1998-2019, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.2 page.
Created 2012.5.30.

|  | ToC | DocOverview | CGDoc | RelNotes | FAQ | Index | PermutedIndex
| Allegro CL version 9.0 Unrevised from 8.2 to 9.0. 8.2 version