Docs For Class Mail_Queue

$buffer_size = 10

[line 74]

Type:

mixed

[ Top ]

$force_preload =

[line 73]

Type:

mixed

[ Top ]

$limit =

[line 70]

Options

Type:

mixed

[ Top ]

$offset =

[line 71]

Type:

mixed

[ Top ]

$queue_data = array()

[line 49]

Array for mails in queue

Type:

array

[ Top ]

$try =

[line 72]

Type:

mixed

[ Top ]

countSend [line 196]

mixed countSend(
object MailBody
$mail)

Check how many times mail was sent.

Return: Integer or false if error.
Access: public

Overridden in child classes as:

Mail_Queue_Container_creole::countSend(): Check how many times mail was sent.

Mail_Queue_Container_db::countSend(): Check how many times mail was sent.

Mail_Queue_Container_mdb::countSend(): Check how many times mail was sent.

Mail_Queue_Container_mdb2::countSend(): Check how many times mail was sent.

Parameters:

object MailBody $mail —

[ Top ]

deleteMail [line 241]

bool deleteMail(
integer
$id)

Remove from queue mail with $id identifier.

Return: True on success ale false.
Access: public

Overridden in child classes as:

Mail_Queue_Container_creole::deleteMail(): Remove from queue mail with $id identifier.

Mail_Queue_Container_db::deleteMail(): Remove from queue mail with $id identifier.

Mail_Queue_Container_mdb::deleteMail(): Remove from queue mail with $id identifier.

Mail_Queue_Container_mdb2::deleteMail(): Remove from queue mail with $id identifier.

Parameters:

integer $id — Mail ID

[ Top ]

get [line 93]

mixed get(
)

Get next mail from queue. When exclude first time preload all queue

Return: MailBody object on success else Mail_Queue_Error
Access: public

[ Top ]

getMailById [line 226]

mixed getMailById(
integer
$id)

Return mail by id $id (bypass mail_queue)

Return: Mail object or false on error.
Access: public

Overridden in child classes as:

Mail_Queue_Container_creole::getMailById(): Return mail by id $id (bypass mail_queue)

Mail_Queue_Container_db::getMailById(): Return mail by id $id (bypass mail_queue)

Mail_Queue_Container_mdb::getMailById(): Return mail by id $id (bypass mail_queue)

Mail_Queue_Container_mdb2::getMailById(): Return mail by id $id (bypass mail_queue)

Parameters:

integer $id — Mail ID

[ Top ]

setAsSent [line 211]

bool setAsSent(
object MailBody
$mail)

Set mail as already sent.

Access: public

Overridden in child classes as:

Mail_Queue_Container_creole::setAsSent(): Set mail as already sent.

Mail_Queue_Container_db::setAsSent(): Set mail as already sent.

Mail_Queue_Container_mdb::setAsSent(): Set mail as already sent.

Mail_Queue_Container_mdb2::setAsSent(): Set mail as already sent.

Parameters:

object MailBody $mail — object

[ Top ]

setOption [line 177]

void setOption(
[integer
$limit = MAILQUEUE_ALL], [integer
$offset = MAILQUEUE_START], [integer
$try = MAILQUEUE_TRY], [boolean
$force_preload = false])

Set common option

Mail_Queue_Container::setOption()

Access: public

Parameters:

integer	`$limit`	—	Optional - Number of mails loaded to queue
integer	`$offset`	—	Optional - You could also specify offset
integer	`$try`	—	Optional - how many times should system try sent each mail
boolean	`$force_preload`	—	Optional - FIXME

[ Top ]

skip [line 121]

void skip(
)

Remove the current (problematic) mail from the buffer, but don't delete it from the db: it might be a temporary issue.

[ Top ]

_isSerialized [line 303]

boolean _isSerialized(
string
$string)

Check if the string is a regular string or a serialized array

Access: protected

Parameters:

string $string —

[ Top ]

Class: Mail_Queue_Container

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$buffer_size = 10

$force_preload =

$limit =

$offset =

$queue_data = array()

$try =

Method Detail

countSend [line 196]

Parameters:

deleteMail [line 241]

Parameters:

get [line 93]

getMailById [line 226]

Parameters:

setAsSent [line 211]

Parameters:

setOption [line 177]

Parameters:

skip [line 121]

_isSerialized [line 303]

Parameters: