Class Zend_Mail_Storage_Pop3

Description

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

Zend_Mail_Storage_Abstract
   |
   --Zend_Mail_Storage_Pop3
Variable Summary
Method Summary
 Zend_Mail_Storage_Pop3 __construct ($params $params)
 null close ()
 int countMessages ()
 int getNumberByUniqueId (string $id)
 void getRawContent ( $id, [ $part = null])
 void getRawHeader ( $id, [ $part = null], [ $topLines = 0])
 int|array getSize ([int $id = 0])
 array|string getUniqueId ([int|null $id = null])
 null noop ()
 null removeMessage (int $id)
 string __get (string $var)
Variables
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

  • throws: Zend_Mail_Protocol_Exception
  • throws: Zend_Mail_Storage_Exception
  • access: public
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 181)

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
  • throws: Zend_Mail_Protocol_Exception
  • throws: Zend_Mail_Storage_Exception
  • access: public
int countMessages ()

Redefinition of:
Zend_Mail_Storage_Abstract::countMessages()
Count messages messages in current box/folder
getMessage (line 88)

Fetch a message

  • throws: Zend_Mail_Protocol_Exception
  • access: public
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
getNumberByUniqueId (line 243)

get a message number from a unique id

I.e. if you have a webmailer that supports deleting messages you should use unique ids as parameter and use this method to translate it to message number right before calling removeMessage()

  • return: message number
  • throws: Zend_Mail_Storage_Exception
  • access: public
int getNumberByUniqueId (string $id)
  • string $id: unique id

Redefinition of:
Zend_Mail_Storage_Abstract::getNumberByUniqueId()
get a message number from a unique id
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 = 0])
  • $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)
  • throws: Zend_Mail_Protocol_Exception
  • access: public
int|array getSize ([int $id = 0])
  • int $id: number of message

Redefinition of:
Zend_Mail_Storage_Abstract::getSize()
Get a list of messages with number and size
getUniqueId (line 220)

get unique id for one or all messages

if storage does not support unique ids it's the same as the message number

  • return: message number for given message or all messages as array
  • throws: Zend_Mail_Storage_Exception
  • access: public
array|string getUniqueId ([int|null $id = null])
  • int|null $id: message number

Redefinition of:
Zend_Mail_Storage_Abstract::getUniqueId()
get unique id for one or all messages
noop (line 192)

Keep the server busy.

  • throws: Zend_Mail_Protocol_Exception
  • access: public
null noop ()

Redefinition of:
Zend_Mail_Storage_Abstract::noop()
Keep the resource alive.
removeMessage (line 206)

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.

  • throws: Zend_Mail_Protocol_Exception
  • access: public
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 268)

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

  • see: Zend_Mail_Storage_Abstract:__get()
  • throws: Zend_Mail_Storage_Exception
  • access: public
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::getNumberByUniqueId()
 Zend_Mail_Storage_Abstract::getRawContent()
 Zend_Mail_Storage_Abstract::getRawHeader()
 Zend_Mail_Storage_Abstract::getSize()
 Zend_Mail_Storage_Abstract::getUniqueId()
 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 Sun, 27 May 2007 23:26:43 -0700 by phpDocumentor 1.3.2