IMAP_MAILBOXMSGINFO(3) 1 IMAP_MAILBOXMSGINFO(3)imap_mailboxmsginfo - Get information about the current mailboxSYNOPSIS
object imap_mailboxmsginfo (resource $imap_stream)
DESCRIPTION
Checks the current mailbox status on the server. It is similar to imap_status(3), but will additionally sum up the size of all messages in
the mailbox, which will take some additional time to execute.
PARAMETERS
o $
imap_stream -An IMAP stream returned by imap_open(3).
RETURN VALUES
Returns the information in an object with following properties:
Mailbox properties
+--------+----------------------------------------+
| Date | |
| | |
| | date of last change (current datetime) |
| | |
|Driver | |
| | |
| | driver |
| | |
|Mailbox | |
| | |
| | name of the mailbox |
| | |
| Nmsgs | |
| | |
| | number of messages |
| | |
|Recent | |
| | |
| | number of recent messages |
| | |
|Unread | |
| | |
| | number of unread messages |
| | |
|Deleted | |
| | |
| | number of deleted messages |
| | |
| Size | |
| | |
| | mailbox size |
| | |
+--------+----------------------------------------+
Returns FALSE on failure.
EXAMPLES
Example #1
imap_mailboxmsginfo(3) example
<?php
$mbox = imap_open("{imap.example.org}INBOX", "username", "password")
or die("can't connect: " . imap_last_error());
$check = imap_mailboxmsginfo($mbox);
if ($check) {
echo "Date: " . $check->Date . "<br />
" ;
echo "Driver: " . $check->Driver . "<br />
" ;
echo "Mailbox: " . $check->Mailbox . "<br />
" ;
echo "Messages: " . $check->Nmsgs . "<br />
" ;
echo "Recent: " . $check->Recent . "<br />
" ;
echo "Unread: " . $check->Unread . "<br />
" ;
echo "Deleted: " . $check->Deleted . "<br />
" ;
echo "Size: " . $check->Size . "<br />
" ;
} else {
echo "imap_mailboxmsginfo() failed: " . imap_last_error() . "<br />
";
}
imap_close($mbox);
?>
PHP Documentation Group IMAP_MAILBOXMSGINFO(3)
Check Out this Related Man Page
IMAP_CREATEMAILBOX(3) 1 IMAP_CREATEMAILBOX(3)imap_createmailbox - Create a new mailboxSYNOPSIS
bool imap_createmailbox (resource $imap_stream, string $mailbox)
DESCRIPTION
Creates a new mailbox specified by $mailbox.
PARAMETERS
o $
imap_stream -An IMAP stream returned by imap_open(3).
o $mailbox
- The mailbox name, see imap_open(3) for more information. Names containing international characters should be encoded by
imap_utf7_encode(3)RETURN VALUES
Returns TRUE on success or FALSE on failure.
EXAMPLES
Example #1
imap_createmailbox(3) example
<?php
$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
or die("can't connect: " . imap_last_error());
$name1 = "phpnewbox";
$name2 = imap_utf7_encode("phpnewbox"); // phpnewb&w7Y-x
$newname = $name1;
echo "Newname will be '$name1'<br />
";
// we will now create a new mailbox "phptestbox" in your inbox folder,
// check its status after creation and finally remove it to restore
// your inbox to its initial state
if (@imap_createmailbox($mbox, imap_utf7_encode("{imap.example.org}INBOX.$newname"))) {
$status = @imap_status($mbox, "{imap.example.org}INBOX.$newname", SA_ALL);
if ($status) {
echo "your new mailbox '$name1' has the following status:<br />
";
echo "Messages: " . $status->messages . "<br />
";
echo "Recent: " . $status->recent . "<br />
";
echo "Unseen: " . $status->unseen . "<br />
";
echo "UIDnext: " . $status->uidnext . "<br />
";
echo "UIDvalidity:" . $status->uidvalidity . "<br />
";
if (imap_renamemailbox($mbox, "{imap.example.org}INBOX.$newname", "{imap.example.org}INBOX.$name2")) {
echo "renamed new mailbox from '$name1' to '$name2'<br />
";
$newname = $name2;
} else {
echo "imap_renamemailbox on new mailbox failed: " . imap_last_error() . "<br />
";
}
} else {
echo "imap_status on new mailbox failed: " . imap_last_error() . "<br />
";
}
if (@imap_deletemailbox($mbox, "{imap.example.org}INBOX.$newname")) {
echo "new mailbox removed to restore initial state<br />
";
} else {
echo "imap_deletemailbox on new mailbox failed: " . implode("<br />
", imap_errors()) . "<br />
";
}
} else {
echo "could not create new mailbox: " . implode("<br />
", imap_errors()) . "<br />
";
}
imap_close($mbox);
?>
SEE ALSO imap_renamemailbox(3), imap_deletemailbox(3).
PHP Documentation Group IMAP_CREATEMAILBOX(3)