Class Zend_Mail_Mbox

Description

Located in /Zend/Mail/Mbox.php (line 42)

Zend_Mail_Abstract
   |
   --Zend_Mail_Mbox
Method Summary
Zend_Mail_Mbox __construct (mixed $params)
void close ()
int countMessages ([int $flags = null])
Zend_Mail_Message getHeader (int $id, [int $bodyLines = 0])
int|array getSize ([int $id = 0])
void noop ()
void removeMessage ( $id)
Variables
Methods
Constructor __construct (line 173)

Create instance with parameters Supported parameters are:

  • filename filename of mbox file

  • access: public
  • throws: Zend_Mail_Exception
Zend_Mail_Mbox __construct (mixed $params)

Redefinition of:
Zend_Mail_Abstract::__construct()
Create instance with parameters
close (line 212)

Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.

  • access: public
void close ()

Redefinition of:
Zend_Mail_Abstract::close()
Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.
countMessages (line 63)

Count messages all messages in current box Flags are not supported (exceptions is thrown)

  • return: number of messages
  • access: public
  • throws: Zend_Mail_Exception
int countMessages ([int $flags = null])
  • int $flags: filter by flags

Redefinition of:
Zend_Mail_Abstract::countMessages()
Count messages with a flag or all messages in current box/folder Flags might not be supported by all mail libs (exceptions is thrown)
getHeader (line 139)

Get a message with only header and $bodyLines lines of body

  • access: public
Zend_Mail_Message getHeader (int $id, int $bodyLines)
  • int $id: number of message
  • int $bodyLines: also retrieve this number of body lines

Redefinition of:
Zend_Mail_Abstract::getHeader()
Get a message with only header and $bodyLines lines of body
getMessage (line 119)

Get a message with headers and body

  • access: public
Zend_Mail_Message getMessage (int $id)
  • int $id: number of message

Redefinition of:
Zend_Mail_Abstract::getMessage()
Get a message with headers and body
getSize (line 78)

Get a list of messages with number and size

  • return: size of given message of list with all messages as array(num => size)
  • access: public
int|array getSize (int $id)
  • int $id: number of message

Redefinition of:
Zend_Mail_Abstract::getSize()
Get a list of messages with number and size
noop (line 224)

Waste some CPU cycles doing nothing.

  • access: public
void noop ()

Redefinition of:
Zend_Mail_Abstract::noop()
Keep the resource alive.
removeMessage (line 233)

stub for not supported message deletion

  • access: public
void removeMessage ( $id)
  • $id

Redefinition of:
Zend_Mail_Abstract::removeMessage()
delete a message from current box/folder

Inherited Methods

Inherited From Zend_Mail_Abstract

Zend_Mail_Abstract::__construct()
Zend_Mail_Abstract::close()
Zend_Mail_Abstract::count()
Zend_Mail_Abstract::countMessages()
Zend_Mail_Abstract::current()
Zend_Mail_Abstract::getCapabilities()
Zend_Mail_Abstract::getHeader()
Zend_Mail_Abstract::getMessage()
Zend_Mail_Abstract::getSize()
Zend_Mail_Abstract::key()
Zend_Mail_Abstract::next()
Zend_Mail_Abstract::noop()
Zend_Mail_Abstract::offsetExists()
Zend_Mail_Abstract::offsetGet()
Zend_Mail_Abstract::offsetSet()
Zend_Mail_Abstract::offsetUnset()
Zend_Mail_Abstract::removeMessage()
Zend_Mail_Abstract::rewind()
Zend_Mail_Abstract::seek()
Zend_Mail_Abstract::valid()
Zend_Mail_Abstract::__destruct()
Zend_Mail_Abstract::__get()

Documentation generated on Sun, 29 Oct 2006 21:27:58 -0600 by phpDocumentor 1.3.0RC6