Mail_Queue::put

Mail_Queue::put() – Put a new mail into queue.

Synopsis

require_once 'Mail/Queue.php';

int Mail_Queue::put ( string $from , string $to , array $hdrs , array $body , integer $sec_to_send = 0 , bool $delete_after_send = true , integer $id_user = MAILQUEUE_SYSTEM )

Description

Injects a new mail into the mail queue.

Parameter

string $from

Sender e-mail address.

string $to

Recipient e-mail address.

array $hdrs

Array of mail headers as returned by Mail_Mime::headers().

array $body

Mail body array as returned by Mail_Mime::get().

mixed $sec_to_send

Optional - Seconds to pass before delivery is attempted.

mixed $delete_after_send

Optional - Whether or not to delete the mail after delivery.

integer $id_user

Optional - user ID. Stored in queue and readable from mail body object with getIdUser() at a later point.

Return value

returns ID of the record where this mail has been put or Mail_Queue_Error on error

Throws

throws no exceptions thrown

Note

This function can not be called statically.

Get next mail from queue. (Previous) Sends mail object returned by Mail_Queue::
get() (Next)
Last updated: Thu, 24 Jul 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

There are no user contributed notes for this page.