Class Zend_Mail_Mbox

Description

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

Zend_Mail_Abstract
   |
   --Zend_Mail_Mbox
Direct descendents
Class Description
 class Zend_Mail_Folder_Mbox
Variable Summary
 mixed $_filemtime
 mixed $_filename
 mixed $_positions
Method Summary
 Zend_Mail_Mbox __construct ($params $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)
 bool _isMboxFile (resource|string $file, [bool $fileIsString = true])
 void _openMboxFile (string $filename)
 array __sleep ()
 void __wakeup ()
Variables
mixed $_filemtime (line 57)

modification date of mbox file for __wakeup

  • access: protected
mixed $_filename (line 52)

filename of mbox file for __wakeup

  • access: protected
mixed $_positions (line 62)

start and end position of messages as array(0 => start, 1 => end)

  • access: protected

Inherited Variables

Inherited from Zend_Mail_Abstract

Zend_Mail_Abstract::$_has
Zend_Mail_Abstract::$_iterationMax
Zend_Mail_Abstract::$_iterationPos
Methods
Constructor __construct (line 183)

Create instance with parameters Supported parameters are:

  • filename filename of mbox file

  • access: public
  • throws: Zend_Mail_Exception
Zend_Mail_Mbox __construct ($params $params)
  • $params $params: array mail reader specific parameters

Redefinition of:
Zend_Mail_Abstract::__construct()
Create instance with parameters

Redefined in descendants as:
close (line 270)

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 73)

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 149)

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 129)

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 88)

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 282)

Waste some CPU cycles doing nothing.

  • access: public
void noop ()

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

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
_isMboxFile (line 202)

check if given file is a mbox file

if $file is a resource its file pointer is moved after the first line

  • return: file is mbox file
  • access: protected
bool _isMboxFile (resource|string $file, [bool $fileIsString = true])
  • resource|string $file: stream resource of name of file
  • bool $fileIsString: file is string or resource
_openMboxFile (line 233)

open given file as current mbox file

  • access: protected
  • throws: Zend_Mail_Exception
void _openMboxFile (string $filename)
  • string $filename: filename of mbox file
__sleep (line 303)

magic method for serialize()

with this method you can cache the mbox class

  • return: name of variables
  • access: public
array __sleep ()

Redefined in descendants as:
__wakeup (line 314)

magic method for unserialize()

with this method you can cache the mbox class for cache validation the mtime of the mbox file is used

  • access: public
void __wakeup ()

Redefined in descendants as:

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 Thu, 18 Jan 2007 10:01:04 -0800 by phpDocumentor 1.3.1