## Zend_Mail_Storage_Pop3

Description

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

Located in /Zend/Mail/Storage/Pop3.php (line 46)

    Zend_Mail_Storage_Abstract
       |
       --Zend_Mail_Storage_Pop3

Variable Summary
null|Zend_Mail_Protocol_Pop3 $_protocol
Method Summary
Zend_Mail_Storage_Pop3 __construct ($params $params)
null close ()
int countMessages ()
Zend_Mail_Message getMessage (int $id)
void getRawContent ( $id, [ $part = null])
void getRawHeader ( $id, [ $part = null], [ $topLines = 0])
int|array getSize ([int $id = 0])
null noop ()
null removeMessage (int $id)
string __get (string $var)
Variables
null|Zend_Mail_Protocol_Pop3 $_protocol (line 52)

protocol handler

- access: protected

#### Inherited Variables

Inherited from Zend_Mail_Storage_Abstract

> Zend_Mail_Storage_Abstract::$_has
> Zend_Mail_Storage_Abstract::$_iterationMax
> Zend_Mail_Storage_Abstract::$_iterationPos

Methods
Constructor __construct (line 150)

create instance with parameters

Supported paramters are

- host hostname or ip address of POP3 server
- user username
- password password for user 'username' [optional, default = '']
- port port for POP3 server [optional, default = 110]
- ssl 'SSL' or 'TLS' for secure sockets

- access: public
- throws: Zend_Mail_Storage_Exception
- throws: Zend_Mail_Protocol_Exception

Zend_Mail_Storage_Pop3 __construct ($params $params)

- $params $params: array mail reader specific parameters

Redefinition of:

Zend_Mail_Storage_Abstract::__construct()
  Create instance with parameters

close (line 179)

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

- access: public

null close ()

Redefinition of:

Zend_Mail_Storage_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 62)

Count messages all messages in current box

- return: number of messages
- access: public
- throws: Zend_Mail_Storage_Exception
- throws: Zend_Mail_Protocol_Exception

int countMessages ()

Redefinition of:

Zend_Mail_Storage_Abstract::countMessages()
  Count messages messages in current box/folder

getMessage (line 88)

Fetch a message

- access: public
- throws: Zend_Mail_Protocol_Exception

Zend_Mail_Message getMessage (int $id)

- int $id: number of message

Redefinition of:

Zend_Mail_Storage_Abstract::getMessage()
  Get a message with headers and body

getRawContent (line 124)

- access: public

void getRawContent ( $id, [ $part = null])

- $id
- $part

Redefinition of:

Zend_Mail_Storage_Abstract::getRawContent()
  Get raw content of message or part

getRawHeader (line 106)

- access: public

void getRawHeader ( $id, [ $part = null], $topLines)

- $id
- $part
- $topLines

Redefinition of:

Zend_Mail_Storage_Abstract::getRawHeader()
  Get raw header of message or part

getSize (line 75)

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
- throws: Zend_Mail_Protocol_Exception

int|array getSize (int $id)

- int $id: number of message

Redefinition of:

Zend_Mail_Storage_Abstract::getSize()
  Get a list of messages with number and size

noop (line 190)

Keep the server busy.

- access: public
- throws: Zend_Mail_Protocol_Exception

null noop ()

Redefinition of:

Zend_Mail_Storage_Abstract::noop()
  Keep the resource alive.

removeMessage (line 204)

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.

- access: public
- throws: Zend_Mail_Protocol_Exception

null removeMessage (int $id)

- int $id: number of message

Redefinition of:

Zend_Mail_Storage_Abstract::removeMessage()
  delete a message from current box/folder

__get (line 218)

Special handling for hasTop. The headers of the first message is retrieved if Top wasn't needed/tried yet.

- access: public
- throws: Zend_Mail_Storage_Exception
- see: Zend_Mail_Storage_Abstract:__get()

string __get (string $var)

- string $var

Redefinition of:

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

#### Inherited Methods

Inherited From Zend_Mail_Storage_Abstract

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

Documentation generated on Wed, 21 Feb 2007 11:57:29 -0800 by phpDocumentor 1.3.1