API Documentation

Mail/Storage/Pop3.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Mail
subpackage
Storage
version
$Id: Pop3.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Mail_Storage_Pop3

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Mail_Storage_Pop3
jump to top

Extends from
Zend_Mail_Storage_Abstract
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Mail
subpackage
Storage
Properties
$_protocol
Methods
countMessages
getSize
getMessage
getRawHeader
getRawContent
__construct
close
noop
removeMessage
getUniqueId
getNumberByUniqueId
__get

Description

Properties

$_protocol
jump to class

null|Zend_Mail_Protocol_Pop3 $_protocol = ''

protocol handler

Details

$_protocol
null|Zend_Mail_Protocol_Pop3
visibility
protected
default
final
false
static
false

Methods

__construct
jump to class

__construct( $params $params ) :

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

Arguments
$params
$params
array mail reader specific parameters
Details
visibility
public
final
false
static
false
throws
throws

__get
jump to class

__get( string $var ) : string

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

Arguments
$var
string
Output
string
Details
visibility
public
final
false
static
false
see
Zend_Mail_Storage_Abstract:__get()
throws

close
jump to class

close( ) : null

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

Output
null
Details
visibility
public
final
false
static
false

countMessages
jump to class

countMessages( ) : int

Count messages all messages in current box

Output
int
number of messages
Details
visibility
public
final
false
static
false
throws
throws

getMessage
jump to class

getMessage( int $id ) : Zend_Mail_Message

Fetch a message

Arguments
$id
int
number of message
Output
Zend_Mail_Message
Details
visibility
public
final
false
static
false
throws

getNumberByUniqueId
jump to class

getNumberByUniqueId( string $id ) : int

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

Arguments
$id
string
unique id
Output
int
message number
Details
visibility
public
final
false
static
false
throws

getRawContent
jump to class

getRawContent(  $id,  $part = null ) :
Arguments
$id
$part
Details
visibility
public
final
false
static
false

getRawHeader
jump to class

getRawHeader(  $id,  $part = null,  $topLines = 0 ) :
Arguments
$id
$part
$topLines
Details
visibility
public
final
false
static
false

getSize
jump to class

getSize( int $id = 0 ) : int|array

get a list of messages with number and size

Arguments
$id
int
number of message
Output
int|array
size of given message of list with all messages as array(num => size)
Details
visibility
public
final
false
static
false
throws

getUniqueId
jump to class

getUniqueId( int|null $id = null ) : array|string

get unique id for one or all messages

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

Arguments
$id
intnull
message number
Output
array|string
message number for given message or all messages as array
Details
visibility
public
final
false
static
false
throws

noop
jump to class

noop( ) : null

Keep the server busy.

Output
null
Details
visibility
public
final
false
static
false
throws

removeMessage
jump to class

removeMessage( int $id ) : null

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.

Arguments
$id
int
number of message
Output
null
Details
visibility
public
final
false
static
false
throws
Documentation was generated by DocBlox.