## Zend_Mail_Storage_Imap

Description

Implements interfaces:

- Zend_Mail_Storage_Folder_Interface

- 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/Imap.php (line 56)

    Zend_Mail_Storage_Abstract
       |
       --Zend_Mail_Storage_Imap

Variable Summary
string $_currentFolder
null|Zend_Mail_Protocol_Imap $_protocol
Method Summary
Zend_Mail_Storage_Imap __construct (array $params)
null close ()
int countMessages ()
Zend_Mail_Storage_Folder getCurrentFolder ()
Zend_Mail_Storage_Folder getFolders ([string $rootFolder = null])
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)
null selectFolder (Zend_Mail_Storage_Folder|string $globalName)
Variables
string $_currentFolder = '' (line 68)

name of current folder

- access: protected

null|Zend_Mail_Protocol_Imap $_protocol (line 62)

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

create instance with parameters

Supported paramters are

- user username
- host hostname or ip address of IMAP server [optional, default = 'localhost']
- password password for user 'username' [optional, default = '']
- port port for IMAP server [optional, default = 110]
- ssl 'SSL' or 'TLS' for secure sockets
- folder select this folder [optional, default = 'INBOX']

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

Zend_Mail_Storage_Imap __construct (array $params)

- array $params: mail reader specific parameters

Redefinition of:

Zend_Mail_Storage_Abstract::__construct()
  Create instance with parameters

close (line 205)

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

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

getCurrentFolder (line 317)

get Zend_Mail_Storage_Folder instance for current folder

- return: instance of current folder
- access: public
- throws: Zend_Mail_Storage_Exception

Zend_Mail_Storage_Folder getCurrentFolder ()

Implementation of:

Zend_Mail_Storage_Folder_Interface::getCurrentFolder()
  get Zend_Mail_Storage_Folder instance for current folder

getFolders (line 246)

get root folder or given folder

- return: root or wanted folder
- access: public
- throws: Zend_Mail_Storage_Exception
- throws: Zend_Mail_Protocol_Exception

Zend_Mail_Storage_Folder getFolders ([string $rootFolder = null])

- string $rootFolder: get folder structure for given folder, else root

Implementation of:

Zend_Mail_Storage_Folder_Interface::getFolders()
  get root folder or given folder

getMessage (line 111)

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

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

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

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

Keep the server busy.

- access: public

null noop ()

Redefinition of:

Zend_Mail_Storage_Abstract::noop()
  Keep the resource alive.

removeMessage (line 231)

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

null removeMessage (int $id)

- int $id: number of message

Redefinition of:

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

selectFolder (line 301)

select given folder

folder must be selectable!

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

null selectFolder (Zend_Mail_Storage_Folder|string $globalName)

- Zend_Mail_Storage_Folder|string $globalName: global name of folder or instance for subfolder

Implementation of:

Zend_Mail_Storage_Folder_Interface::selectFolder()
  select given folder

#### 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:51:23 -0800 by phpDocumentor 1.3.1