Smiling Souls

Steeped in the delicious tea like leaves of anthroposophy for the evolving soul.

Mail_IMAP::$mailboxInfo

The Mail_IMAP::$mailboxInfo property contains information about the current mailbox.

Note: Calling on Mail_IMAP::getMailboxInfo() with the $rtn argument true returns the contents of the Mail_IMAP::$mailboxInfo property.

Associative Indice Data type Description
host str The current server, connection string as passed to imap_open(). This indice is created automatically if a URI is used to connect. This information is used internally in Mail_IMAP::getMailboxes() as the host argument.
folder str The current folder. This indice is created automatically if a URI is used to connect.
user str The current user name. This indice is created automatically if a URI is used to connect.
Unread int The count of message flagged as unread. This indice is created automatically if a URI is used to connect and the $get_info argument of Mail_IMAP::__construct() or Mail_IMAP::connect() is TRUE.
Deleted int The count of messages flagged as deleted. This indice is created automatically if a URI is used to connect and the $get_info argument of Mail_IMAP::__construct() or Mail_IMAP::connect() is TRUE.
Nmsgs int The number of messages. This indice is created automatically if a URI is used to connect and the $get_info argument of Mail_IMAP::__construct() or Mail_IMAP::connect() is TRUE.
Recent str The number of messages flagged as recent. This indice is created automatically if a URI is used to connect and the $get_info argument of Mail_IMAP::__construct() or Mail_IMAP::connect() is TRUE.
Size int The size of the mailbox in bytes. This indice is created automatically if a URI is used to connect and the $get_info argument of Mail_IMAP::__construct() or Mail_IMAP::connect() is TRUE.
Date str The date of last change. This indice is created automatically if a URI is used to connect and the $get_info argument of Mail_IMAP::__construct() or Mail_IMAP::connect() is TRUE.
Driver str The type of driver (imap, pop3, nntp). This indice is created automatically if a URI is used to connect and the $get_info argument of Mail_IMAP::__construct() or Mail_IMAP::connect() is TRUE.
Mailbox str The name of the mailbox. This indice is created automatically if a URI is used to connect and the $get_info argument of Mail_IMAP::__construct() or Mail_IMAP::connect() is TRUE.
MESSAGE array Message quota. This indice is created when Mail_IMAP::getQuota() is called and the $rtn argument is FALSE.
STORAGE array Storage quota. This indice is created when Mail_IMAP::getQuota() is called and the $rtn argument is FALSE.

Additionally, if Mail_IMAP::getMailboxes() is called and the $rtn argument is FALSE, new associative indices are created, each named for a mailbox on the server, for instance, INBOX.Trash, INBOX.Sent, INBOX.Drafts and INBOX. The number of indices and their names are wholly dependant upon the mailboxes on the server.

Comments

There are no comments posted at this time.

Leave a Comment

Simple HTML is allowed: <code>, <b>, <i>, <u>, <var>, <strong>, <em>, <blockquote>, <ul>, <ol>, <li>, <p> (no attributes). All spacing and line breaks in your comment will be preserved.

* All comments are moderated and are subject to approval.
Your comment will appear once it has been approved.
Posting multiple times will not expedite the approval process.

Comments are closed at this time.

© Copyright 2014 Hot Toddy, All Rights Reserved.