Mail_Queue
[ class tree: Mail_Queue ] [ index: Mail_Queue ] [ all elements ]

Class: Mail_Queue_Container

Source Location: /Mail_Queue-1.2.7/Mail/Queue/Container.php

Class Overview


Mail_Queue_Container - base class for MTA queue.


Author(s):

Version:

  • Release: @package_version@

Variables

Methods


Child classes:

Mail_Queue_Container_mdb2
Mail_Queue_Container_mdb2
Mail_Queue_Container_db
Mail_Queue_Container_db - Storage driver for fetching mail queue data from a PEAR_DB database
Mail_Queue_Container_creole
Mail_Queue_Container_creole
Mail_Queue_Container_mdb
Mail_Queue_Container_mdb

Inherited Variables

Inherited Methods


Class Details

[line 68]
Mail_Queue_Container - base class for MTA queue.

Define methods for all storage containers.



[ Top ]


Class Variables

$buffer_size =  10

[line 102]


Type:   mixed


[ Top ]

$force_preload =

[line 101]


Type:   mixed


[ Top ]

$limit =

[line 98]

Options

Type:   mixed


[ Top ]

$offset =

[line 99]


Type:   mixed


[ Top ]

$queue_data = array()

[line 77]

Array for mails in queue

Type:   array


[ Top ]

$try =

[line 100]


Type:   mixed


[ Top ]



Method Detail

countSend   [line 231]

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_mdb2::countSend()
Check how many times mail was sent.
Mail_Queue_Container_db::countSend()
Check how many times mail was sent.
Mail_Queue_Container_creole::countSend()
Check how many times mail was sent.
Mail_Queue_Container_mdb::countSend()
Check how many times mail was sent.

Parameters:

object MailBody   $mail     

[ Top ]

deleteMail   [line 281]

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_mdb2::deleteMail()
Remove from queue mail with $id identifier.
Mail_Queue_Container_db::deleteMail()
Remove from queue mail with $id identifier.
Mail_Queue_Container_creole::deleteMail()
Remove from queue mail with $id identifier.
Mail_Queue_Container_mdb::deleteMail()
Remove from queue mail with $id identifier.

Parameters:

integer   $id     Mail ID

[ Top ]

get   [line 121]

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 261]

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_mdb2::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_creole::getMailById()
Return mail by id $id (bypass mail_queue)
Mail_Queue_Container_mdb::getMailById()
Return mail by id $id (bypass mail_queue)

Parameters:

integer   $id     Mail ID

[ Top ]

getQueueCount   [line 266]

void getQueueCount( )


Overridden in child classes as:

Mail_Queue_Container_mdb2::getQueueCount()
Return the number of emails currently in the queue.
Mail_Queue_Container_db::getQueueCount()
Return the number of emails currently in the queue.

[ Top ]

setAsSent   [line 246]

bool setAsSent( object MailBody $mail)

Set mail as already sent.
  • Access: public

Overridden in child classes as:

Mail_Queue_Container_mdb2::setAsSent()
Set mail as already sent.
Mail_Queue_Container_db::setAsSent()
Set mail as already sent.
Mail_Queue_Container_creole::setAsSent()
Set mail as already sent.
Mail_Queue_Container_mdb::setAsSent()
Set mail as already sent.

Parameters:

object MailBody   $mail     object

[ Top ]

setOption   [line 212]

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 156]

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 345]

boolean _isSerialized( string $string)

Check if the string is a regular string or a serialized array
  • Access: protected

Parameters:

string   $string     

[ Top ]


Documentation generated on Thu, 30 Jun 2011 16:00:03 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.