Docs for page Queue.php

Classes:

Mail_Queue - base class for mail queue managment.

Page Details:

| PEAR :: Mail :: Queue | +----------------------------------------------------------------------+ | Copyright (c) 1997-2008 Radek Maciaszek, Lorenzo Alberton | +----------------------------------------------------------------------+ | All rights reserved. | | | | Redistribution and use in source and binary forms, with or without | | modification, are permitted provided that the following conditions | | are met: | | | | * Redistributions of source code must retain the above copyright | | notice, this list of conditions and the following disclaimer. | | * Redistributions in binary form must reproduce the above copyright | | notice, this list of conditions and the following disclaimer in | | the documentation and/or other materials provided with the | | distribution. | | * The names of its contributors may be used to endorse or promote | | products derived from this software without specific prior written | | permission. | | | | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS | | FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE | | COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, | | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, | | BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN | | ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | | POSSIBILITY OF SUCH DAMAGE. | +----------------------------------------------------------------------+

Author: Lorenzo Alberton <l.alberton@quipo.it>
Author: Radek Maciaszek <chief@php.net>
Version: CVS: $Id: Queue.php 309130 2011-03-11 17:34:24Z till $
Link: http://pear.php.net/package/Mail_Queue
License: The BSD License

Includes:

require_once('Mail/Queue/Error.php') [line 111]
Mail_Queue_Error

MAILQUEUE_ALL [line 60]

MAILQUEUE_ALL = -1

You can specify how many mails will be loaded to queue else object use this constant for load all mails from db.

MAILQUEUE_ERROR [line 78]

MAILQUEUE_ERROR = -1

MAILQUEUE_ERROR constants

MAILQUEUE_ERROR_CANNOT_CONNECT [line 83]

MAILQUEUE_ERROR_CANNOT_CONNECT = -6

MAILQUEUE_ERROR_CANNOT_INITIALIZE [line 81]

MAILQUEUE_ERROR_CANNOT_INITIALIZE = -4

MAILQUEUE_ERROR_CANNOT_SEND_MAIL [line 86]

MAILQUEUE_ERROR_CANNOT_SEND_MAIL = -9

MAILQUEUE_ERROR_NO_CONTAINER [line 80]

MAILQUEUE_ERROR_NO_CONTAINER = -3

MAILQUEUE_ERROR_NO_DRIVER [line 79]

MAILQUEUE_ERROR_NO_DRIVER = -2

MAILQUEUE_ERROR_NO_OPTIONS [line 82]

MAILQUEUE_ERROR_NO_OPTIONS = -5

MAILQUEUE_ERROR_NO_RECIPIENT [line 87]

MAILQUEUE_ERROR_NO_RECIPIENT = -10

MAILQUEUE_ERROR_QUERY_FAILED [line 84]

MAILQUEUE_ERROR_QUERY_FAILED = -7

MAILQUEUE_ERROR_UNEXPECTED [line 85]

MAILQUEUE_ERROR_UNEXPECTED = -8

MAILQUEUE_ERROR_UNKNOWN_CONTAINER [line 88]

MAILQUEUE_ERROR_UNKNOWN_CONTAINER = -11

MAILQUEUE_START [line 54]

MAILQUEUE_START = 0

This is special constant define start offset for limit sql queries to get mails.

MAILQUEUE_SYSTEM [line 66]

MAILQUEUE_SYSTEM = -1

When you put new mail to queue you could specify user id who send e-mail.

Else you could use system id: MAILQUEUE_SYSTEM or user unknown id: MAILQUEUE_UNKNOWN

MAILQUEUE_TRY [line 73]

MAILQUEUE_TRY = 25

This constant tells Mail_Queue how many times should try to send mails again if was any errors before.

MAILQUEUE_UNKNOWN [line 67]

MAILQUEUE_UNKNOWN = -2

File: Queue.php