(PHP 4, PHP 5, PHP 7)
imap_getsubscribed — Üyesi olunan tüm posta kutularını listeler
$imap_akımı
, string $hedef
, string $kalıp
) : arrayÜyesi olunan tüm posta kutularını bir dizi içinde döndürür.
Sadece kullanıcının üyesi olduğu posta kutularını döndürmesi dışında imap_getmailboxes() işlevine benzer.
imap_akımı
imap_open() işlevinden dönen bir IMAP akımı.
hedef
imap_open() işlevinde açıklandığı gibi normal olarak bir sunucu belirtimi olmalıdır.
kalıp
Posta kutusu hiyerarşisi içine aramanın başlayacağı yeri belirtir.
kalıp
içinde
belirtilebilecek iki özel karakter vardır:
Alt dizinlere inilmesini sağlayan '*' ve alt
dizinlere inilmemesini sağlayan '%'.
kalıp
olarak '*' posta
kutusu hiyerarşisi içindeki tüm posta kutularının listelenmesini,
'%' ise sadece tepe seviyedeki posta
kutularının listelenmesini sağlar. kalıp
olarak
'~/mail/%' belirtilirse alt dizinlere
inilmeden sadece ~/mail dizini altındaki posta kutuları
listelenir.
Posta kutusu bilgilerini içeren nesnelerden oluşan bir dizi döner. Her
nesnenin üç özelliği vardır: Posta kutusunun ismini içeren
name
, hiyerarşik ayracı içeren
delimiter
ve attributes
.
attributes
özelliği şu değerleri içerebilen bir bit
maskesidir:
LATT_NOINFERIORS
- "Çocuklar" olmaksızın posta
kutusunun kendisi (bunun altında posta kutusu bulunmaz).
LATT_NOSELECT
- Sadece bir taşıyıcıdır, bir posta
kutusu değildir - bu açılamaz.
LATT_MARKED
- Posta kutusu imlidir. Sadece
UW-IMAPD kullanır.
LATT_UNMARKED
- Posta kutusu imsizdir. Sadece
UW-IMAPD kullanır.