imap_getacl
For the purposes of passing along the attributes as a json array, I wanted to pass the attributes as an indexed array to save on bandwidth and session storage. The human readable translation is then performed in javascript by relating each key to the proper attribute label. I also wanted a cleaner way of converting the attributes without calling another function or using a complex iteration. This puts each binary attribute into it's own array element for easy testing.
<?php
$mailboxes = imap_getmailboxes($mailbox, $username, $password);
foreach($mailboxes as $key=>$mailbox){
...
$attrs = preg_split('//',str_pad(decbin($mailbox->attributes),7,"0",STR_PAD_LEFT),8); // convert decimal to an array of attributes
array_shift($attrs); // Remove the extra element at the front of the array in position 0
...
}
?>
With temporary variables, the conversion would look like this.
<?php
$attr_binary = decbin($mailbox->attributes); // convert decimal to binary
$attr_binary = str_pad($attr_binary,7,"0",STR_PAD_LEFT); // pad with 0's on the left
$attrs = $preg_split('//',$attr_binary,8); // split into an array after each character
array_shift($attrs); // Remove the extra element at the front of the array in position 0
?>
By defining the attributes as a map to the array index, you can test as follows.
<?php
define("ATTR_NOINFERIORS",6);
define("ATTR_NOSELECT "5);
define("ATTR_MARKED ",4);
define("ATTR_UNMARKED ",3);
define("ATTR_REFERRAL ",2);
define("ATTR_HASCHILDREN ",1);
define("ATTR_HASNOCHILDREN ",0);
if ($attrs[ATTR_HASCHILDREN]){
// do something
}
?>
imap_getmailboxes
(PHP 4, PHP 5)
imap_getmailboxes — Liefert detailierte Informationen zu allen verfügbaren Postfächern
Beschreibung
array imap_getmailboxes
( resource
$imap_stream
, string $ref
, string $pattern
)Liefert Postfachinformationen
Parameter-Liste
-
imap_stream -
Eine von imap_open() zurückgegebene IMAP-Verbindung.
-
ref -
Spezifikation des gewünschten Servers wie in imap_open() beschrieben.
-
pattern -
Legt fest ab welchem Punkt der Postfachhierachie gesucht werden soll.
Zwei spezielle Zeichen können als Teil des Suchmusters
patternbenutzt werden: '*' und '%'. Mit '*' werden alle Postfächer angefordert, so können Sie z.B. nur '*' alspatternübergeben und erhalten eine Übersicht aller auf dem Server verfügbarer Postfächer. '%' liefert alle Postfächer auf einer Hierachieebene aber nicht die tiefer liegenden Postfächer. Ein einfaches '%' alspatternliefert nur die Postfächer der obersten Ebene, '~/mail/%' z.B. liefert auf einem UW_IMAP Server alle Postfächer des ~/mail Verzeichnisses aber nicht deren Unterpostfächer.
Rückgabewerte
Liefert ein Array 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 attributes. Die Eigenschaften setzen sich
als Bitmaske aus folgenden möglichen Werten zusammen:
-
LATT_NOINFERIORS- innerhalb dieses Postfachs existieren keine weiteren 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 (nur bei UW-IMAPD) -
LATT_UNMARKED- dieses Postfach ist nicht markiert (nur bei UW-IMAPD)
Beispiele
Beispiel #1 imap_getmailboxes() Beispiel
<?php
$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
or die("can't connect: " . imap_last_error());
$list = imap_getmailboxes($mbox, "{imap.example.org}", "*");
if (is_array($list)) {
foreach ($list as $key => $val) {
echo "($key) ";
echo imap_utf7_decode($val->name) . ",";
echo "'" . $val->delimiter . "',";
echo $val->attributes . "<br />\n";
}
} else {
echo "imap_getmailboxes failed: " . imap_last_error() . "\n";
}
imap_close($mbox);
?>
add a note
User Contributed Notes
imap_getmailboxes
james dot mattingly at gmail dot com
18-Jul-2011 12:19
razonklnbd at hotmail dot com
06-Jan-2008 12:49
i think it will save someones time to get mailbox list and their attributes within a formatted array
<?php
/********** Function ******************/
function getAttributesFlagArray($p_attributes){
$attrs[LATT_HASNOCHILDREN]='false';
$attrs[LATT_HASCHILDREN]='false';
$attrs[LATT_REFERRAL]='false';
$attrs[LATT_UNMARKED]='false';
$attrs[LATT_MARKED]='false';
$attrs[LATT_NOSELECT]='false';
$attrs[LATT_NOINFERIORS]='false';
$attrsX=$attrs;
foreach($attrs as $attrkey=>$attrval){
if ($p_attributes & $attrkey){
$attrsX[$attrkey]='true';
$p_attributes-=$attrkey;
}
}
return $attrsX;
}
/*********** Usages *****************/
$mboxconnstr='{imap.gmail.com:993/imap/ssl}';
// $mboxconnstr='{mail.bdways.com:143/imap/novalidate-cert}';
$mbox = imap_open($mboxconnstr, $username, $password, OP_HALFOPEN) or die("can't connect: " . imap_last_error());
echo "<h1>Mailboxes</h1>\n";
$folders = imap_getmailboxes($mbox, $mboxconnstr, "*");
if(is_array($folders)){
foreach($folders as $fkey=>$folder){
$mapname = str_replace($mboxconnstr, "", imap_utf7_decode($folder->name));
if($mapname[0] != ".") {
//$attrs[LATT_]=': NO';
$list_folders[$fkey]['name'] = $folder->name;
$list_folders[$fkey]['nameX'] = $mapname;
$list_folders[$fkey]['delimiter'] = $folder->delimiter;
$list_folders[$fkey]['attributes'] = $folder->attributes;
$list_folders[$fkey]['attr_values'] = getAttributesFlagArray($folder->attributes);
}
}
}else echo "Call failed<br />\n";
echo('<pre>'); print_r($list_folders); echo('</pre>');
?>
thanks to Mohamed Abbas mabbas_xyz at yahoo dot com for his attributes findings using imap...
Mohamed Abbas mabbas_xyz at yahoo dot com
18-Nov-2006 08:51
i am currently develop a simple IMAP client, when i call imap_getmailboxes() i receive a different values in attributes property of the mailbox object the problem is how can i manipulate these attributes to get a meaningful value,
if you make a hard search to find a solution for this, you will
not find any useful documents for this problem, let us take a closer look for this problem.
when i call imap_getmailboxes() against different IMAP servers i got these attribute values
[attributes] => 9
[attributes] => 1
[attributes] => 64
[attributes] => 32
[attributes] => 40
the documentation tell us that we check this attributes against four constants, these contents are
LATT_NOINFERIORS
LATT_NOSELECT
LATT_MARKED
LATT_UNMARKED
the value of these constants are
LATT_NOINFERIORS = 1
LATT_NOSELECT = 2
LATT_MARKED = 4
LATT_UNMARKED = 8
you can got this result by echo each constant, unfortunately the documentation not explain how we can check the attributes against the constants, after a long time of searching i find the answer in source code of c-client
(you can get the source from ftp://ftp.cac.washington.edu/imap/)
under \src\c-client you will find mail.h open it and you will find this
/* terminal node in hierarchy */
#define LATT_NOINFERIORS (long) 0x1
/* name can not be selected */
#define LATT_NOSELECT (long) 0x2
/* changed since last accessed */
#define LATT_MARKED (long) 0x4
/* accessed since last changed */
#define LATT_UNMARKED (long) 0x8
/* name has referral to remote mailbox */
#define LATT_REFERRAL (long) 0x10
/* has selectable inferiors */
#define LATT_HASCHILDREN (long) 0x20
/* has no selectable inferiors */
#define LATT_HASNOCHILDREN (long) 0x40
as you notice here these are our four constants and three additional constants
LATT_REFERRAL
LATT_HASCHILDREN
LATT_HASNOCHILDREN
then what is the value of these 3 attributes
LATT_REFERRAL 0x10 = 00010000 in binary, the bitmask value is 2^4 = 16 and so on, or simply echo this constant to get the value, then
LATT_REFERRAL = 16
LATT_HASCHILDREN = 32
LATT_HASNOCHILDREN = 64
finally the full list of constants will be
LATT_NOINFERIORS = 1
LATT_NOSELECT = 2
LATT_MARKED = 4
LATT_UNMARKED = 8
LATT_REFERRAL = 16
LATT_HASCHILDREN = 32
LATT_HASNOCHILDREN = 64
ok let's back to our attributes
[attributes] => 9
[attributes] => 1
[attributes] => 64
[attributes] => 32
[attributes] => 40
[attributes] => 9 this mean it's LATT_UNMARKED and LATT_NOINFERIORS 1+8 =9
[attributes] => 1 this mean LATT_NOINFERIORS
[attributes] => 64 this mean LATT_HASNOCHILDREN
[attributes] => 32 this mean LATT_HASCHILDREN
[attributes] => 40 this mean LATT_HASCHILDREN and LATT_UNMARKED 32+8=40
this just like linux file permission 7 mean read, write, and execute 4+2+1 read=4 write=2 execute=1
that is what i found, i hope this can help
Mohamed Abbas
Nileweb Egypt
emielbom at hotmail dot com
04-Feb-2006 07:09
i was looking for a function to test the attributes.
and it was hard to find an answer or code.
Maybe there is a function availeble, but i couldn't find it.
the first function: returns all mailboxes in on the server
The second function: returns a bitstring from the attr_number returned by getmailboxes()
The tirth function: returns an array with the active attributes on the specific mailbox
Last Line: is a combination of the functions: the output is, any map witch can hold no mail but only sub boxes...
<?php
function getFolders($mailbox, $serverString) {
$list = imap_getmailboxes($mailbox, $serverString, "*");
if (is_array($list)) {
foreach ($list as $key => $val) {
$mapname = str_replace($serverString, "", imap_utf7_decode($val->name));
if ($mapname[0] != ".") {
$list_folders[$key]['name'] = $mapname;
$list_folders[$key]['delimiter'] = $val->delimiter;
$list_folders[$key]['attributes'] = $val->attributes;
}
}
} else {
echo "imap_getmailboxes failed: " . imap_last_error() . "\n";
}
return $list_folders;
}
function IntToBin($number) {
$BitWaarde = 1;
$IntNum = $number;
$BinString = "";
if ($IntNum > 0) {
// bepaal de max bitwaarde aan de hand van $IntNum
while ($IntNum > $BitWaarde) {
$BitWaarde = $BitWaarde * 2;
}
// maken van een binaire string.
while ($BitWaarde >= 1 ) {
if ($IntNum < $BitWaarde) {
if ($BinString != "") $BinString .= "0";
} else {
$BinString .= "1";
$IntNum = $IntNum-$BitWaarde;
}
$BitWaarde = $BitWaarde / 2;
}
}
return $BinString;
}
function Attributes($BinString) {
$BinInt = (int)$BinString;
if ($BinInt >=1000){
$setAttribute['LATT_UNMARKED'] = true;
$BinInt = $BinInt-1000;
} else $setAttribute['LATT_UNMARKED'] = false;
if ($BinInt >=100){
$setAttribute['LATT_MARKED'] = true;
$BinInt = $BinInt-100;
} else $setAttribute['LATT_MARKED'] = false;
if ($BinInt >=10){
$setAttribute['LATT_NOSELECT'] = true;
$BinInt = $BinInt-10;
} else $setAttribute['LATT_NOSELECT'] = false;
if ($BinInt >=1){
$setAttribute['LATT_NOINFERIORS'] = true;
$BinInt = $BinInt-1;
} else $setAttribute['LATT_NOINFERIORS'] = false;
return $setAttribute;
}
foreach (getFolders($mailbox, $config['Server_string']) as $key => $val) {
$Attr = Attributes(IntToBin((int)$val['attributes']));
if (!$Attr['LATT_NOINFERIORS']) {
echo "<option value='".$val['name']."'>".$val['name']."</option>";
}
}
?>
ad-rotator.com
04-May-2004 01:17
In case you print_r() or var_dump() the object and see an int for attribute, these are the constant integers for the bitmask.
1 LATT_NOINFERIORS
2 LATT_NOSELECT
4 LATT_MARKED
8 LATT_UNMARKED
foom at fuhm dot NO_supercalifragilisticexpialidocious_SPAM dot net
27-Aug-2001 05:42
The list of mailbox attributes in this document is very misleading. In particular the explanation of noinferiors is just wrong. It does not mean that the mailbox currently has no children, it means that it *cannot* have children ever. Also, it is untrue that marked and unmarked are only used by UW-IMAP. They are in the official IMAP specification and are used by at least Courier-imap as well.
One thing to watch out for, however, is broken IMAP servers which do send \Noinferiors when they mean that there are currently no children.
From the IMAP4rev1 specs (RFC 2060):
\Noinferiors
It is not possible for any child levels of hierarchy to exist
under this name; no child levels exist now and none can be
created in the future.
\Noselect
It is not possible to use this name as a selectable mailbox.
\Marked
The mailbox has been marked "interesting" by the server; the
mailbox probably contains messages that have been added since
the last time the mailbox was selected.
\Unmarked
The mailbox does not contain any additional messages since the
last time the mailbox was selected.