PEAR マニュアル
前のページ次のページ

Mail_Queue::put()

Mail_Queue::put() -- キューに新しいメールを追加する

概要

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

説明

メールキューに新しいメールを追加します。

パラメータ

string $from

送信者の e-mail アドレスを指定します

string $to

受信者の e-mail アドレスを指定します

array $hdrs

Mail_Mime::headers() から返されるような メールヘッダの配列を指定します

array $body

Mail_Mime::get() から返されるようなメールボディの配列を指定します

mixed $sec_to_send

オプション - 配信されようとする前に経過させる秒数を指定します

mixed $delete_after_send

オプション - 配信後にメールを削除するかどうかを指定します

integer $id_user

オプション - ユーザー ID を指定します。 キューにストアされ、後ほど getIdUser() を使ってメールボディオブジェクトから読み込むことができます。

返り値

returns このメールが追加されたレコードの ID、 あるいはエラー時には Mail_Queue_Error

例外・エラー

throws 投げられる例外はありません

注意

この関数は、スタティックにコールする ことはできません。

前のページホーム次のページ
Mail_Queue::get()上に戻るMail_Queue::sendMail()