Liefert die Liste aller abonnierten Postfächer

# imap_getsubscribed

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

imap_getsubscribed — Liefert die Liste aller abonnierten Postfächer

### Beschreibung

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

Gibt Informationen zu den abonnierten Postfächern zurück.

Diese Funktion ist weitgehend identisch zu imap_getmailboxes(), beachtet aber nur Postfächer, die der Benutzer bereits abonniert hat.

### Parameter-Liste

`imap`

  Eine IMAP\Connection-Instanz.

`reference`

  Die Angabe des Servers in der in imap_open() beschriebenen Form.

  Warnung

  Die Übergabe von nicht vertrauenswürdigen Daten an diesen Parameter ist unsicher,falls imap.enable_insecure_rsh nicht deaktiviert ist.

`pattern`

  Gibt an, wo in der Postfach-Hierarchie mit der Suche begonnen werden soll.

  Es gibt zwei Sonderzeichen, die man als Teil von `pattern` verwenden kann: '`*`' und '`%`'. '`*`' heißt, dass alle Postfächer zurückgegeben werden sollen. Wenn man `pattern` als '`*`' übergibt, so erhält man eine Liste der vollständigen Postfach-Hierarchie. '`%`' heißt, dass nur die aktuelle Stufe zurückgegeben wird. '`%`' als Wert des Parameters `pattern` gibt nur die Postfächer der obersten Ebene zurück. '`~/mail/%`' unter `UW_IMAPD` gibt alle Postfächer des Verzeichnisses ~/mail zurück, aber keine aus dessen Unterverzeichnissen.

### Rückgabewerte

Gibt ein Array zurück, das Objekte mit Postfachbeschreibungen enthält. Jedes Objekt verfügt über die Attribute `name` für den Namen des Postfachs, `delimiter` für das gültige Hierachietrennzeichen innerhalb des Hierachieabschnitts, in dem sich das Postfach befindet, und Eigenschaften des Postfachs in `attribute`. Die Eigenschaften setzen sich als Bitmaske aus folgenden möglichen Werten zusammen:

- `LATT_NOINFERIORS` - Dieses Postfach enthält keine Unterpostfächer.
- `LATT_NOSELECT` - Dieses Postfach enthält nur Unterpostfächer aber keine Nachrichten; es kann nicht geöffnet werden.
- `LATT_MARKED` - Dieses Postfach ist markiert. Wird nur von UW-IMAPD verwendet.
- `LATT_UNMARKED` - Dieses Postfach ist nicht markiert. Wird nur von UW-IMAPD verwendet.
- `LATT_REFERRAL` - Dieses Postfach bezieht sich auf eine Remote-Mailbox.
- `LATT_HASCHILDREN` - Dieses Postfach enthält auswählbare Unterpostfächer.
- `LATT_HASNOCHILDREN` - Dieses Postfach enthält keine auswählbaren Unterpostfächer.

Diese Funktion gibt bei einem Fehler `false` zurück.

### Changelog

Version | Beschreibung
--- | ---
8.1.0 | Der Parameter `imap` erwartet nun eine IMAP\Connection-Instanz; vorher wurde eine gültige `imap`-Ressource erwartet.

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open