imap_lsub
(PHP 4, PHP 5, PHP 7)
imap_lsub — List all the subscribed mailboxes
Description
$imap_stream
, string $ref
, string $pattern
) : arrayGets an array of all the mailboxes that you have subscribed.
Parameters
-
imap_stream
-
An IMAP stream returned by imap_open().
-
ref
-
ref
should normally be just the server specification as described in imap_open()WarningPassing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.
-
pattern
-
Specifies where in the mailbox hierarchy to start searching.
There are two special characters you can pass as part of the
pattern
: '*' and '%'. '*' means to return all mailboxes. If you passpattern
as '*', you will get a list of the entire mailbox hierarchy. '%' means to return the current level only. '%' as thepattern
parameter will return only the top level mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox in the ~/mail directory, but none in subfolders of that directory.
See Also
- imap_list() - Read the list of mailboxes
- imap_getmailboxes() - Read the list of mailboxes, returning detailed information on each one
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-function.imap-lsub.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.