Docs For Class Zend_Mail_Abstract

## Class Zend_Mail_Abstract

Description

Implements interfaces:

- Countable (internal interface)
- ArrayAccess (internal interface)
- SeekableIterator (internal interface)

- abstract:
- license: Zend Framework License version 1.0
- copyright: Copyright (c) 2005-2006 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Mail/Abstract.php (line 26)

Direct descendents

Class | Description
--- | ---
Zend_Mail_Imap |
Zend_Mail_Mbox |
Zend_Mail_Pop3 |
Zend_Mail_Maildir |

Variable Summary
mixed $_has
mixed $_iterationMax
mixed $_iterationPos
Method Summary
Zend_Mail_Abstract __construct (array $params)
void __destruct ()
void close ()
int count ()
int countMessages ([int $flags = null])
Zend_Mail_Message current ()
array getCapabilities ()
Zend_Mail_Message getHeader (int $id, [int $bodyLines = 0])
Zend_Mail_Message getMessage (mixed $id)
int|array getSize ([int $id = 0])
int key ()
void next ()
void noop ()
boolean offsetExists (int $id)
Zend_Mail_Message offsetGet (int $id)
void offsetSet (id $id, mixed $value)
boolean offsetUnset (int $id)
void removeMessage ( $id)
void rewind ()
void seek (int $pos)
boolean valid ()
bool __get (string $var)
Variables
mixed $_has = array('folder' => false,
'uniqueid' => false,
'delete' => false,
'create' => false,
'top' => false) (line 31)

class capabilities with default values

- access: protected

mixed $_iterationMax = null (line 45)

maximum iteration position (= message count)

- access: protected

mixed $_iterationPos = 0 (line 40)

current iteration position

- access: protected

Methods
Constructor __construct (line 126)

Create instance with parameters

- access: public
- abstract:
- throws: Zend_Mail_Exception

Zend_Mail_Abstract __construct (array $params)

- array $params: mail reader specific parameters

Redefined in descendants as:

- Zend_Mail_Imap::__construct() : create instance with parameters
- Zend_Mail_Mbox::__construct() : Create instance with parameters Supported parameters are:
  - filename filename of mbox file
- Zend_Mail_Pop3::__construct() : create instance with parameters
- Zend_Mail_Maildir::__construct() : Create instance with parameters Supported parameters are:
  - filename filename of mbox file

Destructor __destruct (line 132)

Destructor calls close() and therefore closes the resource.

- access: public

void __destruct ()

Redefined in descendants as:

- Zend_Mail_Imap::__destruct() : public destructor
- Zend_Mail_Pop3::__destruct() : public destructor

close (line 142)

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

- access: public
- abstract:

void close ()

Redefined in descendants as:

- Zend_Mail_Imap::close() : Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.
- Zend_Mail_Mbox::close() : Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.
- Zend_Mail_Pop3::close() : Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.
- Zend_Mail_Maildir::close() : Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.

count (line 162)

Countable::count()

- access: public

int count ()

Implementation of:

Countable::count

countMessages (line 89)

Count messages with a flag or all messages in current box/folder Flags might not be supported by all mail libs (exceptions is thrown)

- return: number of messages
- access: public
- abstract:
- throws: Zend_Mail_Exception

int countMessages ([int $flags = null])

- int $flags: filter by flags

Redefined in descendants as:

- Zend_Mail_Imap::countMessages() : Count messages all messages in current box No flags are supported by POP3 (exceptions is thrown)
- Zend_Mail_Mbox::countMessages() : Count messages all messages in current box Flags are not supported (exceptions is thrown)
- Zend_Mail_Pop3::countMessages() : Count messages all messages in current box No flags are supported by POP3 (exceptions is thrown)
- Zend_Mail_Maildir::countMessages() : Count messages all messages in current box Flags are not supported (exceptions is thrown)

current (line 246)

Iterator::current()

- return: current message
- access: public

Zend_Mail_Message current ()

Implementation of:

SeekableIterator::current

getCapabilities (line 75)

Get a full list of features supported by the specific mail lib and the server

- return: list of features as array(featurename => true|false[|null])
- access: public

array getCapabilities ()
getHeader (line 117)

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

- access: public
- abstract:

Zend_Mail_Message getHeader (int $id, int $bodyLines)

- int $id: number of message
- int $bodyLines: also retrieve this number of body lines

Redefined in descendants as:

- Zend_Mail_Imap::getHeader() : get a message with only header and $bodyLines lines of body
- Zend_Mail_Mbox::getHeader() : Get a message with only header and $bodyLines lines of body
- Zend_Mail_Pop3::getHeader() : get a message with only header and $bodyLines lines of body
- Zend_Mail_Maildir::getHeader() : Get a message with only header and $bodyLines lines of body

getMessage (line 107)

Get a message with headers and body

- access: public
- abstract:

Zend_Mail_Message getMessage (mixed $id)

Redefined in descendants as:

- Zend_Mail_Imap::getMessage() : get a message with headers and body
- Zend_Mail_Mbox::getMessage() : Get a message with headers and body
- Zend_Mail_Pop3::getMessage() : get a message with headers and body
- Zend_Mail_Maildir::getMessage() : Get a message with headers and body

getSize (line 98)

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
- abstract:

int|array getSize (int $id)

- int $id: number of message

Redefined in descendants as:

- Zend_Mail_Imap::getSize() : get a list of messages with number and size
- Zend_Mail_Mbox::getSize() : Get a list of messages with number and size
- Zend_Mail_Pop3::getSize() : get a list of messages with number and size
- Zend_Mail_Maildir::getSize() : Get a list of messages with number and size

key (line 257)

Iterator::key()

- return: id of current position
- access: public

int key ()

Implementation of:

SeekableIterator::key

next (line 268)

Iterator::next()

- access: public

void next ()

Implementation of:

SeekableIterator::next

noop (line 148)

Keep the resource alive.

- access: public
- abstract:

void noop ()

Redefined in descendants as:

- Zend_Mail_Imap::noop() : Keep the server busy.
- Zend_Mail_Mbox::noop() : Waste some CPU cycles doing nothing.
- Zend_Mail_Pop3::noop() : Keep the server busy.
- Zend_Mail_Maildir::noop() : Waste some CPU cycles doing nothing.

offsetExists (line 174)

ArrayAccess::offsetExists()

- access: public

boolean offsetExists (int $id)

- int $id

Implementation of:

ArrayAccess::offsetExists

offsetGet (line 192)

ArrayAccess::offsetGet()

- return: message object
- access: public

Zend_Mail_Message offsetGet (int $id)

- int $id

Implementation of:

ArrayAccess::offsetGet

offsetSet (line 206)

ArrayAccess::offsetSet()

- access: public
- throws: Zend_Mail_Exception

void offsetSet (id $id, mixed $value)

- id $id
- mixed $value

Implementation of:

ArrayAccess::offsetSet

offsetUnset (line 218)

ArrayAccess::offsetUnset()

- return: success
- access: public

boolean offsetUnset (int $id)

- int $id

Implementation of:

ArrayAccess::offsetUnset

removeMessage (line 153)

delete a message from current box/folder

- access: public
- abstract:

void removeMessage ( $id)

- $id

Redefined in descendants as:

- Zend_Mail_Imap::removeMessage() : Remove a message from server. If you're doing that from a web enviroment you should be careful and use a uniqueid as parameter if possible to identify the message.
- Zend_Mail_Mbox::removeMessage() : stub for not supported message deletion
- Zend_Mail_Pop3::removeMessage() : Remove a message from server. If you're doing that from a web enviroment you should be careful and use a uniqueid as parameter if possible to identify the message.
- Zend_Mail_Maildir::removeMessage() : stub for not supported message deletion

rewind (line 234)

Iterator::rewind()

Rewind always gets the new count from the storage. Thus if you use the interfaces and your scripts take long you should use reset() from time to time.

- access: public

void rewind ()

Implementation of:

SeekableIterator::rewind

seek (line 294)

SeekableIterator::seek()

- access: public

void seek (int $pos)

- int $pos

Implementation of:

SeekableIterator::seek

valid (line 279)

Iterator::valid()

- access: public

boolean valid ()

Implementation of:

SeekableIterator::valid

__get (line 59)

Getter for has-properties. The standard has properties are: hasFolder, hasUniqueid, hasDelete, hasCreate, hasTop

The valid values for the has-properties are:

- true if a feature is supported
- false if a feature is not supported
- null is it's not yet known or it can't be know if a feature is supported

- return: supported or not
- access: public

bool __get (string $var)

- string $var: property name

Redefined in descendants as:

- Zend_Mail_Imap::__get() : Special handling for hasTop. The headers of the first message is retrieved if Top wasn't needed/tried yet.
- Zend_Mail_Pop3::__get() : Special handling for hasTop. The headers of the first message is retrieved if Top wasn't needed/tried yet.

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