Abstract Class Zend_Mail_Abstract

Description

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


	
			
Direct descendents
Class Description
 class Zend_Mail_Mbox
 class Zend_Mail_Pop3
Variable Summary
 mixed $_has
Method Summary
 Zend_Mail_Abstract __construct (array $params)
 void __destruct ()
 void close ()
 int countMessages ([int $flags = null])
 array getCapabilities ()
 Zend_Mail_Message getHeader (int $id, [int $bodyLines = 0])
 int|array getSize ([int $id = 0])
 void noop ()
 void removeMessage ( $id)
 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
Methods
Constructor __construct (line 117)

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:
Destructor __destruct (line 123)

Destructor calls close() and therefore closes the resource.

  • access: public
void __destruct ()

Redefined in descendants as:
close (line 133)

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_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.
countMessages (line 80)

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:
getCapabilities (line 66)

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

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:
getMessage (line 98)

Get a message with headers and body

  • access: public
  • abstract:
Zend_Mail_Message getMessage (mixed $id)

Redefined in descendants as:
getSize (line 89)

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:
noop (line 139)

Keep the resource alive.

  • access: public
  • abstract:
void noop ()

Redefined in descendants as:
removeMessage (line 145)

delete a message from current box/folder

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

Redefined in descendants as:
__get (line 50)

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_Pop3::__get() : Special handling for hasTop. The headers of the first message is retrieved if Top wasn't needed/tried yet.

Documentation generated on Fri, 30 Jun 2006 11:29:37 -0500 by phpDocumentor 1.3.0RC6