Docs For Class Zend_Mail_Imap

## Class Zend_Mail_Imap

Description

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

Located in /Zend/Mail/Imap.php (line 51)

    Zend_Mail_Abstract
       |
       --Zend_Mail_Imap

Method Summary
Zend_Mail_Imap __construct (mixed $params)
void __destruct ()
void close ()
int countMessages ([mixed $flags = null])
Zend_Mail_Message getHeader (mixed $id, [mixed $bodyLines = 0])
Zend_Mail_Message getMessage (mixed $id)
int|array getSize ([mixed $id = 0])
void noop ()
void removeMessage (mixed $id)
void __get ( $var)
Variables

#### Inherited Variables

Inherited from Zend_Mail_Abstract

> Zend_Mail_Abstract::$_has
> Zend_Mail_Abstract::$_iterationMax
> Zend_Mail_Abstract::$_iterationPos

Methods
Constructor __construct (line 133)

create instance with parameters

Supported paramters are

- host hostname or ip address of IMAP server
- user username
- 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_Exception

Zend_Mail_Imap __construct (mixed $params)

Redefinition of:

Zend_Mail_Abstract::__construct()
  Create instance with parameters

Destructor __destruct (line 159)

public destructor

- access: public

void __destruct ()

Redefinition of:

Zend_Mail_Abstract::__destruct()
  Destructor calls close() and therefore closes the resource.

close (line 170)

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

- access: public

void close ()

Redefinition of:

Zend_Mail_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 66)

Count messages all messages in current box No flags are supported by POP3 (exceptions is thrown)

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

int countMessages ([mixed $flags = null])

Redefinition of:

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

getHeader (line 110)

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

- access: public

Zend_Mail_Message getHeader (mixed $id, mixed $bodyLines)

Redefinition of:

Zend_Mail_Abstract::getHeader()
  Get a message with only header and $bodyLines lines of body

getMessage (line 96)

get a message with headers and body

- access: public

Zend_Mail_Message getMessage (mixed $id)

Redefinition of:

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

getSize (line 81)

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

int|array getSize (mixed $id)

Redefinition of:

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

noop (line 181)

Keep the server busy.

- access: public

void noop ()

Redefinition of:

Zend_Mail_Abstract::noop()
  Keep the resource alive.

removeMessage (line 196)

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

void removeMessage (mixed $id)

Redefinition of:

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

__get (line 210)

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

- access: public
- see: Zend_Mail_Abstract:__get()

void __get ( $var)

- $var

Redefinition of:

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

#### Inherited Methods

Inherited From Zend_Mail_Abstract

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

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