Edit Report a Bug

    imap_getsubscribed

    (PHP 4, PHP 5, PHP 7, PHP 8)

    imap_getsubscribed — Liste toutes les boîtes aux lettres souscrites

    Description

    imap_getsubscribed(IMAP\Connection $imap, string $reference, string $pattern): array|false

    Liste toutes les boîtes aux lettres souscrites.

    imap_getsubscribed() est identique à imap_getmailboxes(), mais ne retourne que les boîtes aux lettres auxquelles l'utilisateur est inscrit.

    Liste de paramètres

    imap

    Une instance de IMAP\Connection.

    reference

    reference ne devrait être que le serveur sous la forme décrite dans imap_open()

    Avertissement

    Passer des données qui ne sont pas digne de confiance à ce paramètre est dangereux, sauf si, imap.enable_insecure_rsh est désactivé.

    pattern

    Spécifie la position dans la hiérarchie des boîtes aux lettres, où il faut commencer à chercher.

    Il y a deux caractères spéciaux que vous pouvez utiliser dans pattern : '*' et '%'. '*' signifie : toutes les boîtes aux lettres. Si vous passez pattern comme '*', vous obtiendrez la liste complète des boîtes aux lettres de la hiérarchie. '%' signifie qu'on ne s'intéresse qu'au niveau courant. '%' passé à pattern ne retournera que les boîtes aux lettres de niveau supérieur; '~/mail/%' sous UW_IMAPD retournera toutes les boîtes aux lettres du dossier ~/mail directory, mais pas leurs enfants.

    Valeurs de retour

    Retourne un tableau d'objets contenant les informations sur les boîtes aux lettres. Chaque objet possède un attribut de name, qui contient le nom complet de la boîte aux lettres, delimiter qui est le délimiteur hiérarchique et attributes. attributes est un masque de bits, qui contient :

    • LATT_NOINFERIORS - Cette boîte aux lettres n'a pas d'"enfants" (il n'y a plus de boîtes aux lettres en dessous de celle-ci).
    • LATT_NOSELECT - Ceci est juste un container, pas une boîte aux lettres (vous ne pouvez pas l'ouvrir).
    • LATT_MARKED - Cette boîte aux lettres est marquée. Utilisé uniquement avec UW-IMAPD.
    • LATT_UNMARKED - Cette boîte aux lettres n'est pas marquée. Utilisé uniquement avec UW-IMAPD.
    • LATT_REFERRAL - Ce conteneur a une référence vers une boîte aux lettres distante.
    • LATT_HASCHILDREN - Cette boîte aux lettres a des inférieurs sélectionnables.
    • LATT_HASNOCHILDREN - Cette boîte aux lettres n'a pas d'inférieurs sélectionnables.
    The function returns false on failure.

    Historique

    Version Description
    8.1.0 La paramètre imap attend désormais une instance de IMAP\Connection ; auparavant, une ressource imap était attendue.
    add a note add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top