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_OPEN(3) 1 IMAP_OPEN(3)imap_open - Open anIMAPstream to a mailboxSYNOPSIS
resource imap_open NULL (string $mailbox, string $username, string $password, [int $options], [int $n_retries], [array $params])
DESCRIPTION
Opens an IMAP stream to a $mailbox.
This function can also be used to open streams to POP3 and NNTP servers, but some functions and features are only available on IMAP
servers.
PARAMETERS
o $mailbox
- A mailbox name consists of a server and a mailbox path on this server. The special name INBOX stands for the current users per-
sonal mailbox. Mailbox names that contain international characters besides those in the printable ASCII space have to be encoded
width imap_utf7_encode(3). The server part, which is enclosed in '{' and '}', consists of the servers name or ip address, an
optional port (prefixed by ':'), and an optional protocol specification (prefixed by '/'). The server part is mandatory in all
mailbox parameters. All names which start with { are remote names, and are in the form "{" remote_system_name [":" port] [flags]
"}" [mailbox_name] where:
o remote_system_name - Internet domain name or bracketed IP address of server.
o port - optional TCP port number, default is the default port for that service
o flags - optional flags, see following table.
o mailbox_name - remote mailbox name, default is INBOX
Optional flags for names
+---------------------------------------------+---------------------------------------------------+
| Flag | |
| | |
| | Description |
| | |
+---------------------------------------------+---------------------------------------------------+
| | |
| /service= service | |
| | |
| | mailbox access service, default is "imap" |
| | |
| | |
| /user= user | |
| | |
| | remote user name for login on the server |
| | |
| | |
| /authuser= user | |
| | |
| | remote authentication user; if specified this is |
| | the user name whose password is used (e.g. admin- |
| | istrator) |
| | |
| | |
| /anonymous | |
| | |
| | remote access as anonymous user |
| | |
| | |
| /debug | |
| | |
| | record protocol telemetry in application's debug |
| | log |
| | |
| | |
| /secure | |
| | |
| | do not transmit a plaintext password over the |
| | network |
| | |
| | |
|/imap, /imap2, /imap2bis, /imap4, /imap4rev1 | |
| | |
| | equivalent to /service=imap |
| | |
| | |
| /pop3 | |
| | |
| | equivalent to /service=pop3 |
| | |
| | |
| /nntp | |
| | |
| | equivalent to /service=nntp |
| | |
| | |
| /norsh | |
| | |
| | do not use rsh or ssh to establish a preauthenti- |
| | cated IMAP session |
| | |
| | |
| /ssl | |
| | |
| | use the Secure Socket Layer to encrypt the ses- |
| | sion |
| | |
| | |
| /validate-cert | |
| | |
| | validate certificates from TLS/SSL server (this |
| | is the default behavior) |
| | |
| | |
| /novalidate-cert | |
| | |
| | do not validate certificates from TLS/SSL server, |
| | needed if server uses self-signed certificates |
| | |
| | |
| /tls | |
| | |
| | force use of start-TLS to encrypt the session, |
| | and reject connection to servers that do not sup- |
| | port it |
| | |
| | |
| /notls | |
| | |
| | do not do start-TLS to encrypt the session, even |
| | with servers that support it |
| | |
| | |
| /readonly | |
| | |
| | request read-only mailbox open (IMAP only; |
| | ignored on NNTP, and an error with SMTP and POP3) |
| | |
+---------------------------------------------+---------------------------------------------------+
o $username
- The user name
o $password
- The password associated with the $username
o $options
- The $options are a bit mask with one or more of the following:
o OP_READONLY - Open mailbox read-only
o OP_ANONYMOUS - Don't use or update a .newsrc for news (NNTP only)
o OP_HALFOPEN - For IMAP and NNTP names, open a connection but don't open a mailbox.
o CL_EXPUNGE - Expunge mailbox automatically upon mailbox close (see also imap_delete(3) and imap_expunge(3))
o OP_DEBUG - Debug protocol negotiations
o OP_SHORTCACHE - Short ( elt-only) caching
o OP_SILENT - Don't pass up events (internal use)
o OP_PROTOTYPE - Return driver prototype
o OP_SECURE - Don't do non-secure authentication
o $n_retries
- Number of maximum connect attempts
o $params
- Connection parameters, the following (string) keys maybe used to set one or more connection parameters:
o DISABLE_AUTHENTICATOR - Disable authentication properties
RETURN VALUES
Returns an IMAP stream on success or FALSE on error.
CHANGELOG
+--------+------------------+
|Version | |
| | |
| | Description |
| | |
+--------+------------------+
| 5.3.2 | |
| | |
| | $params added |
| | |
| 5.2.0 | |
| | |
| | $n_retries added |
| | |
+--------+------------------+
EXAMPLES
Example #1
Different use of imap_open(3)
<?php
// To connect to an IMAP server running on port 143 on the local machine,
// do the following:
$mbox = imap_open("{localhost:143}INBOX", "user_id", "password");
// To connect to a POP3 server on port 110 on the local server, use:
$mbox = imap_open ("{localhost:110/pop3}INBOX", "user_id", "password");
// To connect to an SSL IMAP or POP3 server, add /ssl after the protocol
// specification:
$mbox = imap_open ("{localhost:993/imap/ssl}INBOX", "user_id", "password");
// To connect to an SSL IMAP or POP3 server with a self-signed certificate,
// add /ssl/novalidate-cert after the protocol specification:
$mbox = imap_open ("{localhost:995/pop3/ssl/novalidate-cert}", "user_id", "password");
// To connect to an NNTP server on port 119 on the local server, use:
$nntp = imap_open ("{localhost:119/nntp}comp.test", "", "");
// To connect to a remote server replace "localhost" with the name or the
// IP address of the server you want to connect to.
?>
Example #2
imap_open(3) example
<?php
$mbox = imap_open("{imap.example.org:143}", "username", "password");
echo "<h1>Mailboxes</h1>
";
$folders = imap_listmailbox($mbox, "{imap.example.org:143}", "*");
if ($folders == false) {
echo "Call failed<br />
";
} else {
foreach ($folders as $val) {
echo $val . "<br />
";
}
}
echo "<h1>Headers in INBOX</h1>
";
$headers = imap_headers($mbox);
if ($headers == false) {
echo "Call failed<br />
";
} else {
foreach ($headers as $val) {
echo $val . "<br />
";
}
}
imap_close($mbox);
?>
SEE ALSO imap_close(3).
PHP Documentation Group IMAP_OPEN(3)