Zend_Mail_Storage_Abstract Class Reference

Inheritance diagram for Zend_Mail_Storage_Abstract:

Public Member Functions
	__get ($var)
	getCapabilities ()
	countMessages ()
	getSize ($id=0)
	getMessage ($id)
	getRawHeader ($id, $part=null, $topLines=0)
	getRawContent ($id, $part=null)
	__construct ($params)
	__destruct ()
	close ()
	noop ()
	removeMessage ($id)
	getUniqueId ($id=null)
	getNumberByUniqueId ($id)
	count ()
	offsetExists ($id)
	offsetGet ($id)
	offsetSet ($id, $value)
	offsetUnset ($id)
	rewind ()
	current ()
	key ()
	next ()
	valid ()
	seek ($pos)

Protected Attributes
	$_has
	$_iterationPos = 0
	$_iterationMax = null
	$_messageClass = 'Zend_Mail_Message'

Detailed Description

Definition at line 31 of file Abstract.php.

Constructor & Destructor Documentation

__construct()

__construct (   $params )

abstract

Create instance with parameters

Parameters

array

$params

mail reader specific parameters

Exceptions

Zend_Mail_Storage_Exception

__destruct()

__destruct

(

)

Destructor calls close() and therefore closes the resource.

Definition at line 159 of file Abstract.php.

    {
        $this->close();
    }

Member Function Documentation

__get()

__get

(

$var

)

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

The valid values for the has-properties are:

• true if a feature is supported
• false if a feature is not supported
• null is it's not yet known or it can't be know if a feature is supported

Parameters

string

$var

property name

Returns

bool supported or not

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Definition at line 75 of file Abstract.php.

    {
        if (strpos($var, 'has') === 0) {
            $var = strtolower(substr($var, 3));
            return isset($this->_has[$var]) ? $this->_has[$var] : null;
        }

        #require_once 'Zend/Mail/Storage/Exception.php';
        throw new Zend_Mail_Storage_Exception($var . ' not found');
    }

close()

close ( )

abstract

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

Returns

null

count()

count

(

)

Countable::count()

Returns

int

Definition at line 218 of file Abstract.php.

     {
        return $this->countMessages();
     }

countMessages()

countMessages ( )

abstract

Count messages messages in current box/folder

Returns

int number of messages

Exceptions

Zend_Mail_Storage_Exception

current()

current

(

)

Iterator::current()

Returns

Zend_Mail_Message current message

Definition at line 305 of file Abstract.php.

     {
        return $this->getMessage($this->_iterationPos);
     }

getCapabilities()

getCapabilities

(

)

Get a full list of features supported by the specific mail lib and the server

Returns

array list of features as array(featurename => true|false[|null])

Definition at line 95 of file Abstract.php.

    {
        return $this->_has;
    }

getMessage()

getMessage (   $id )

abstract

Get a message with headers and body

Parameters

int

$id

number of message

Returns

Zend_Mail_Message

getNumberByUniqueId()

getNumberByUniqueId (   $id )

abstract

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

Parameters

string

$id

unique id

Returns

int message number

Exceptions

Zend_Mail_Storage_Exception

getRawContent()

getRawContent (   $id,   $part = null  )

abstract

Get raw content of message or part

Parameters

int	$id	number of message
null | array | string	$part	path to part or null for messsage content

Returns

string raw content

getRawHeader()

getRawHeader (   $id,   $part = null,   $topLines = 0  )

abstract

Get raw header of message or part

Parameters

int	$id	number of message
null | array | string	$part	path to part or null for messsage header
int	$topLines	include this many lines with header (after an empty line)

Returns

string raw header

getSize()

getSize (   $id = 0 )

abstract

Get a list of messages with number and size

Parameters

int

$id

number of message

Returns

int|array size of given message of list with all messages as array(num => size)

getUniqueId()

getUniqueId (   $id = null )

abstract

get unique id for one or all messages

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

Parameters

int | null

$id

message number

Returns

array|string message number for given message or all messages as array

Exceptions

Zend_Mail_Storage_Exception

key()

key

(

)

Iterator::key()

Returns

int id of current position

Definition at line 316 of file Abstract.php.

     {
        return $this->_iterationPos;
     }

next()

next

(

)

Iterator::next()

Returns

void

Definition at line 327 of file Abstract.php.

     {
        ++$this->_iterationPos;
     }

noop()

noop ( )

abstract

Keep the resource alive.

Returns

null

offsetExists()

offsetExists

(

$id

)

ArrayAccess::offsetExists()

Parameters

int

$id

Returns

boolean

Definition at line 230 of file Abstract.php.

     {
        try {
            if ($this->getMessage($id)) {
                return true;
            }
        } catch(Zend_Mail_Storage_Exception $e) {}

        return false;
     }

offsetGet()

offsetGet

(

$id

)

ArrayAccess::offsetGet()

Parameters

int

$id

Returns

Zend_Mail_Message message object

Definition at line 248 of file Abstract.php.

     {
        return $this->getMessage($id);
     }

offsetSet()

offsetSet	(		$id,
			$value
	)

ArrayAccess::offsetSet()

Parameters

id	$id
mixed	$value

Exceptions

Zend_Mail_Storage_Exception

Returns

void

See also

Zend_Mail_Storage_Exception

Definition at line 262 of file Abstract.php.

     {
        #require_once 'Zend/Mail/Storage/Exception.php';
        throw new Zend_Mail_Storage_Exception('cannot write mail messages via array access');
     }

offsetUnset()

offsetUnset

(

$id

)

ArrayAccess::offsetUnset()

Parameters

int

$id

Returns

boolean success

Definition at line 278 of file Abstract.php.

     {
        return $this->removeMessage($id);
     }

removeMessage()

removeMessage (   $id )

abstract

delete a message from current box/folder

Returns

null

rewind()

rewind

(

)

Iterator::rewind()

Rewind always gets the new count from the storage. Thus if you use the interfaces and your scripts take long you should use reset() from time to time.

Returns

void

Definition at line 293 of file Abstract.php.

     {
        $this->_iterationMax = $this->countMessages();
        $this->_iterationPos = 1;
     }

seek()

seek

(

$pos

)

SeekableIterator::seek()

Parameters

int

$pos

Returns

void

Exceptions

OutOfBoundsException

Definition at line 354 of file Abstract.php.

     {
        if ($this->_iterationMax === null) {
          $this->_iterationMax = $this->countMessages();
        }

        if ($pos > $this->_iterationMax) {
            throw new OutOfBoundsException('this position does not exist');
        }
        $this->_iterationPos = $pos;
     }

valid()

valid

(

)

Iterator::valid()

Returns

boolean

Definition at line 338 of file Abstract.php.

     {
        if ($this->_iterationMax === null) {
          $this->_iterationMax = $this->countMessages();
        }
        return $this->_iterationPos && $this->_iterationPos <= $this->_iterationMax;
     }

Field Documentation

$_has

$_has

protected

Initial value:

= array('uniqueid'  => true,
                            'delete'    => false,
                            'create'    => false,
                            'top'       => false,
                            'fetchPart' => true,
                            'flags'     => false)

Definition at line 37 of file Abstract.php.

$_iterationMax

$_iterationMax = null

protected

Definition at line 54 of file Abstract.php.

$_iterationPos

$_iterationPos = 0

protected

Definition at line 48 of file Abstract.php.

$_messageClass

$_messageClass = 'Zend_Mail_Message'

protected

Definition at line 60 of file Abstract.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Mail/Storage/Abstract.php