Class: Mail_Queue_Container_db

Source Location: /Mail_Queue-1.2.2/Queue/Container/db.php

Class Overview

Mail_Queue_Container
   |
   --Mail_Queue_Container_db

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

Author(s):

Radek Maciaszek <chief at php.net>

Version:

$Id: db.php,v 1.22 2007/10/22 21:41:51 quipo Exp $

Variables

Methods

Inherited Variables

Class: Mail_Queue_Container

Mail_Queue_Container::$buffer_size
Mail_Queue_Container::$force_preload
Mail_Queue_Container::$limit
Mail_Queue_Container::$offset
Mail_Queue_Container::$queue_data
Mail_Queue_Container::$try

Inherited Methods

Class: Mail_Queue_Container

Mail_Queue_Container::countSend(): Check how many times mail was sent.
Mail_Queue_Container::deleteMail(): Remove from queue mail with $id identifier.
Mail_Queue_Container::get(): Get next mail from queue. When exclude first time preload all queue
Mail_Queue_Container::getMailById(): Return mail by id $id (bypass mail_queue)
Mail_Queue_Container::setAsSent(): Set mail as already sent.
Mail_Queue_Container::setOption(): Set common option
Mail_Queue_Container::skip(): Remove the current (problematic) mail from the buffer, but don't delete it from the db: it might be a temporary issue.
Mail_Queue_Container::_isSerialized(): Check if the string is a regular string or a serialized array

Class Details

[line 44]
Mail_Queue_Container_db - Storage driver for fetching mail queue data from a PEAR_DB database

Author: Radek Maciaszek <chief@php.net>
Version: $Id: db.php,v 1.22 2007/10/22 21:41:51 quipo Exp $
Access: public

[ Top ]

Class Variables

$db =

[line 52]

Reference to the current database connection.

Type:

object PEAR_DB

[ Top ]

$mail_table = 'mail_queue'

[line 58]

Table for sql database

Type:

string

[ Top ]

$sequence = null

[line 63]

Var: the name of the sequence for this table

Type:

string

[ Top ]

Method Detail

Mail_Queue_Container_db (Constructor) [line 79]

Mail_Queue_Container_db Mail_Queue_Container_db(
mixed
$options)

Constructor

Mail_Queue_Container_db()

Access: public

Parameters:

mixed $options — An associative array of option names and their values. See DB_common::setOption for more information about connection options.

[ Top ]

countSend [line 241]

mixed countSend(
object Mail_Queue_Body
$mail)

Check how many times mail was sent.

Return: Integer or Mail_Queue_Error class if error.
Access: public

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

Parameters:

object Mail_Queue_Body $mail —

[ Top ]

deleteMail [line 343]

bool deleteMail(
integer
$id)

Remove from queue mail with $id identifier.

Return: True on success else Mail_Queue_Error class
Access: public

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

Parameters:

integer $id — Mail ID

[ Top ]

getMailById [line 304]

mixed getMailById(
integer
$id)

Return mail by id $id (bypass mail_queue)

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

Overrides Mail_Queue_Container::getMailById() (Return mail by id $id (bypass mail_queue))

Parameters:

integer $id — Mail ID

[ Top ]

put [line 189]

mixed put(
string
$time_to_send, integer
$id_user, string
$ip, 
$sender, 
$recipient, 
$headers, string
$body, [bool
$delete_after_send = true], string
$from, string
$to, string
$hdrs)

Put new mail in queue and save in database.

Mail_Queue_Container::put()

Return: ID of the record where this mail has been put or Mail_Queue_Error on error
Access: public

Parameters:

string	`$time_to_send`	—	When mail have to be send
integer	`$id_user`	—	Sender id
string	`$ip`	—	Sender ip
string	`$from`	—	Sender e-mail
string	`$to`	—	Reciepient e-mail
string	`$hdrs`	—	Mail headers (in RFC)
string	`$body`	—	Mail body (in RFC)
bool	`$delete_after_send`	—	Delete or not mail from db after send
	`$sender`	—
	`$recipient`	—
	`$headers`	—

[ Top ]

setAsSent [line 272]

bool setAsSent(
object Mail_Queue_Body
$mail)

Set mail as already sent.

Access: public

Overrides Mail_Queue_Container::setAsSent() (Set mail as already sent.)

Parameters:

object Mail_Queue_Body $mail — object

[ Top ]