Email クラスメソッド

forge($setup = null, array $config = array())

forge は、設定または与えられた入力を基に新しい Email_Driver インスタンス を返却します。

静的 はい
パラメータ
パラメータ デフォルト 説明
$setup mixed
null
デフォルト設定は null です。設定グループ名または設定配列。
$config mixed
null
その場でデフォルト設定の変更を行うための追加の設定配列。
返り値 新しい Email_Driver のインスタンス
// シンプルな例:
$email = \Email::forge();

// グループから設定を読み込む
$email = \Email::forge('my_defaults');

// 設定を与える
$email = \Email::forge(array(
	'driver' => 'smtp',
));

// グループから読み込んだ配列を動的に上書きする
$email = \Email::forge('my_defaults', array(
	'driver' => 'smtp',
));

Email ドライバメソッド

Email_Driver を拡張した全てのドライバがこれらのメソッドを持ちます。 準備して動作させるのにはこれらで十分でしょう。

body($body)

body は、入力を文字列に変換しメッセージを本文にセットします。

静的 いいえ
パラメータ
パラメータ デフォルト 説明
$body string 必須 メッセージ本文。
返り値 $this
$email->body('This is my message.');

// または View に渡す
$email->body(\View::forge('my/view', $data);

alt_body($alt_body)

alt_body は、入力を文字列に変換しメッセージを代替本文にセットします。

静的 いいえ
パラメータ
パラメータ デフォルト 説明
$alt_body string 必須 メッセージ本文。
返り値 $this
$email->alt_body('This is my alternative message.');

// または View に渡す
$email->alt_body(\View::forge('my/alt/view', $data);

priority($priority)

priority メソッドは、メールの優先度をセットします。

静的 いいえ
パラメータ
パラメータ デフォルト 説明
$priority string 必須 優先度: 全てのメール優先度をご覧ください
返り値 $this
$email->priority(\Email::P_HIGHEST);

html_body($html, $generate_alt = null, $auto_attach = null)

html_body メソッドは、メッセージ本文をセットし任意で代替本文を作成します。インライン画像を指定した場合、自動的にインラインで添付されます。

注意してください: (設定から) デフォルトでは自動添付は有効になっています。これを無効にするには、false を与えるか設定の設定値を変更してください。

静的 いいえ
パラメータ
パラメータ デフォルト 説明
$html string 必須 メールの html 。
$generate_alt bool
null
代替のメッセージ本文を作成するかどうかの論理値。null の場合、デフォルトの設定が使われます。
$auto_attach bool
null
埋め込んだ画像の添付を true または false でセットします。null の場合、デフォルトの設定が使われます。
返り値 $this
$email->html_body(\View::forge('welcome/email', $data));
// 代替本文を作成しない
$email->html_body(\View::forge('welcome/email', $data), false);

// 代替本文を作成するが、自動で画像を添付しない。
$email->html_body(\View::forge('welcome/email', $data), true, false);

from($email, $name = false)

from メソッドは、送信者 (from) のメールアドレスと名前をセットします。

静的 いいえ
パラメータ
パラメータ デフォルト 説明
$email string 必須 送信者のメールアドレス。
$name string
false
送信者の名前。
返り値 $this
$email->from('me@example.com', 'My Name');

subject($subject)

subject メソッドは、表題をセットします。

静的 いいえ
パラメータ
パラメータ デフォルト 説明
$subject string 必須 メールの表題。
返り値 $this
$email->subject('This is my subject');

to($email, $name = false)

to メソッドは、受信者 (to) のメールアドレスまたはその配列を追加します。

静的 いいえ
パラメータ
パラメータ デフォルト 説明
$email string|array 必須 受信者のメールアドレス。
$name string
false
受信者の名前。$email が配列の場合は無視されます。
返り値 $this
// 1 つのメールアドレスを追加
$email->to('me@example.com', 'My Name');

// 複数のメールアドレスを追加
$email->to(array(
	'me@example.com',
	// 名前と一緒に
	'me@example.com' => 'His/Her name.',
));

cc($email, $name = false)

cc メソッドは、受信者 (cc) のメールアドレスまたはその配列を追加します。

静的 いいえ
パラメータ
パラメータ デフォルト 説明
$email string|array 必須 受信者のメールアドレス。
$name string
false
受信者の名前。$email が配列の場合は無視されます。
返り値 $this
// 1 つのメールアドレスを追加
$email->cc('me@example.com', 'My Name');

// 複数のメールアドレスを追加
$email->cc(array(
	'me@example.com',
	// 名前と一緒に
	'me@example.com' => 'His/Her name.',
));

bcc($email, $name = false)

bcc メソッドは、受信者 (bcc) のメールアドレスまたはその配列を追加します。

静的 いいえ
パラメータ
パラメータ デフォルト 説明
$email string|array 必須 受信者のメールアドレス。
$name string
false
受信者の名前。$email が配列の場合は無視されます。
返り値 $this
// 1 つのメールアドレスを追加
$email->bcc('me@example.com', 'My Name');

// 複数のメールアドレスを追加
$email->bcc(array(
	'me@example.com',
	// 名前と一緒に
	'me@example.com' => 'His/Her name.',
));

reply_to($email, $name = false)

reply_to メソッドは、返信先 (reply to) のメールアドレスまたはその配列を追加します。

静的 いいえ
パラメータ
パラメータ デフォルト 説明
$email string|array 必須 返信先のメールアドレス。
$name string
false
返信先の名前。$email が配列の場合は無視されます。
返り値 $this
// 1 つのメールアドレスを追加
$email->reply_to('me@example.com', 'My Name');

// 複数のメールアドレスを追加
$email->reply_to(array(
	'me@example.com',
	// 名前と一緒に
	'me@example.com' => 'His/Her name.',
));

header($header, $value = null)

header メソッドは、メールヘッダにカスタムヘッダを追加します。

静的 いいえ
パラメータ
パラメータ デフォルト 説明
$header string|array 必須 ヘッダの種類またはヘッダの配列。
$value string
null
ヘッダの値。
返り値 $this
// 1 つのカスタムヘッダを追加
$email->header('X-SMTPAP', 'XXXXXXXX');

// 複数のカスタムヘッダを追加
$email->reply_to(array(
	'X-SMTPAP' => 'XXXXXX',
	'X-SMTPAP2' => 'XXXXXA',
));

clear_recipients()

clear_recipients メソッドは、受信者の一覧 (to 、cc や bcc) を空にします。

静的 いいえ
パラメータ なし
返り値 $this
// 1 つのメールアドレスを追加
$email->bcc('me@example.com', 'My Name');

// 複数のメールアドレスを追加
$email->to(array(
	'me@example.com',
	// 名前と一緒に
	'me@example.com' => 'His/Her name.',
));

// それらをリセットする
$email->clear_recipients();

clear_addresses()

clear_addresses メソッドは、受信者と返信先の一覧 (to 、cc 、bcc や reply to) を空にします。

静的 いいえ
パラメータ なし
返り値 $this
// 1 つのメールアドレスを追加
$email->reply_to('me@example.com', 'My Name');

// 複数のメールアドレスを追加
$email->to(array(
	'me@example.com',
	// 名前と一緒に
	'me@example.com' => 'His/Her name.',
));

// それらをリセットする
$email->clear_addresses();

clear_to()

clear_to メソッドは、受信者の一覧 (to) を空にします。

静的 いいえ
パラメータ なし
返り値 $this
// 複数のメールアドレスを追加
$email->to(array(
	'me@example.com',
	// 名前と一緒に
	'me@example.com' => 'His/Her name.',
));

// それらをリセットする
$email->clear_to();

clear_cc()

clear_cc メソッドは、受信者の一覧 (cc) を空にします。

静的 いいえ
パラメータ なし
返り値 $this
// 複数のメールアドレスを追加
$email->cc(array(
	'me@example.com',
	// 名前と一緒に
	'me@example.com' => 'His/Her name.',
));

// それらをリセットする
$email->clear_cc();

clear_bcc()

clear_bcc メソッドは、受信者の一覧 (bcc) を空にします。

静的 いいえ
パラメータ なし
返り値 $this
// 複数のメールアドレスを追加
$email->bcc(array(
	'me@example.com',
	// 名前と一緒に
	'me@example.com' => 'His/Her name.',
));

// それらをリセットする
$email->clear_bcc();

clear_reply_to()

clear_reply_to メソッドは、返信先の一覧 (reply to) を空にします。

静的 いいえ
パラメータ なし
返り値 $this
// 複数のメールアドレスを追加
$email->reply_to(array(
	'me@example.com',
	// 名前と一緒に
	'me@example.com' => 'His/Her name.',
));

// それらをリセットする
$email->clear_reply_to();

attach($file, $inline = false, $cid = null, $mime = null, $name = null)

attach メソッドは、ファイルを添付します。

このメソッドは、(config/email.php の) attach_paths 配列にセットされた添付パスの中にあるファイルを検索します。

静的 いいえ
パラメータ
パラメータ デフォルト 説明
$file string
false
同封したいファイルのパス。
$inline bool
false
インラインでファイルを添付するかどうか。
$cid string
null
コンテンツ ID 。インライン画像として添付する場合に使われます。
$mime string
null
デフォルトでは、mimetype は core/config/mimes の配列から検索されます。それを上書きするために、これを使用します。
$name string
null
上書きする添付名。
返り値 $this
// 1 つを添付
$email->attach(DOCROOT.'attachments/report.pdf');

// 画像をインラインで添付
$email->attach(DOCROOT.'assets/img/mail/header.png', true, 'cid:headerimage');
// この画像は、 <img src="cid:headerimage" /> となるだろう

string_attach($contents, $filename, $cid = null, $inline = false, $mime = null)

string_attach メソッドは、文字列の入力をファイルとして添付します。

静的 いいえ
パラメータ
パラメータ デフォルト 説明
$contents string 必須 添付する内容。
$filename string 必須 使用するファイル名。
$cid string
null
コンテンツ識別子。インライン画像として添付する場合に使われます。
$inline bool
false
インラインでファイルを添付するかどうか。
$mime string
null
デフォルトでは、mimetype は core/config/mimes の配列から検索されます。それを上書きするために、これを使用します。
返り値 $this
// 1 つを添付
$email->string_attach('This is a textfile', 'test.txt');

clear_attachments()

clear_attachments メソッドは、添付配列を空にします。

静的 いいえ
パラメータ なし
返り値 $this
// なんらかの添付を追加する
$email->string_attach('This is a textfile', 'test.txt');
$email->attach(DOCROOT.'uploads/attach.pdf');

// 添付を空にする
$email->clear_attachments();

send($validate = null)

send メソッドは、メールを送信します。

静的 いいえ
パラメータ
パラメータ デフォルト 説明
$validate bool
null
メールアドレスのバリデートを実行するかどうか。指定がない場合、設定の設定値が使われます。
返り値 boolean
try{
	$email->send();
}
catch(\EmailSendingFailedException $e)
{
	// ドライバがメールを送信できなかった。
}
catch(\EmailValidationFailedException $e)
{
	// 1 つ以上のメールアドレスがバリデーションで失敗した。
}

get_invalid_addresses()

get_invalid_addresses メソッドは、バリデーションをパスしないメールアドレスを返却します。

静的 いいえ
パラメータ なし
返り値 $this
try{
	$email->send();
}
catch(\EmailSendingFailedException $e)
{
	// ドライバがメールを送信できなかった。
}
catch(\EmailValidationFailedException $e)
{
	// 1 つ以上のメールアドレスがバリデーションで失敗した。
	$these_failed = $email->get_invalid_addresses();
}

return_path($email)

return_path メソッドは、差し戻し先 (return-path) のメールアドレスを追加します。

静的 いいえ
パラメータ
パラメータ デフォルト 説明
$email string 必須 差し戻し先のメールアドレス。
返り値 $this
$email->return_path('bounces@example.com');

pipelining($pipelining = true)

pipelining メソッドは、パイプライン (一度に複数のメッセージを送信すること) を可能にします。 これをサポートしていないドライバでは、このメソッドは何もしません。パイプラインはデフォルトで無効になっています。

静的 いいえ
パラメータ
パラメータ デフォルト 説明
$pipelining boolean
true
パイプラインを有効にするかどうか。
返り値 $this
$email->pipelining(true);

Email getters

get_from()

get_from メソッドは、設定された "from" のメールアドレスを返却します。

静的 いいえ
パラメータ なし
返り値 string
// from() でセットされたメールアドレスを返す
$from = $email->get_from();

get_to()

get_to メソッドは、設定された "to" のメールアドレスを返却します。

静的 いいえ
パラメータ なし
返り値 array
// to() でセットされたメールアドレスを返す
$to = $email->get_to();

get_cc()

get_cc メソッドは、設定された "cc" のメールアドレスを返却します。

静的 いいえ
パラメータ なし
返り値 array
// cc() でセットされたメールアドレスを返す
$cc = $email->get_cc();

get_bcc()

get_bcc メソッドは、設定された "bcc" のメールアドレスを返却します。

静的 いいえ
パラメータ なし
返り値 array
// bcc() でセットされたメールアドレスを返す
$bcc = $email->get_bcc();

get_reply_to()

get_reply_to メソッドは、設定された "reply_to" のメールアドレスを返却します。

静的 いいえ
パラメータ なし
返り値 string
// reply_to() でセットされたメールアドレスを返す
$reply_to = $email->get_reply_to();

get_body()

get_body メソッドは、メールの本文を返却します。

静的 いいえ
パラメータ なし
返り値 string
// メールの本文を返す
$text = $email->get_body();

get_subject()

get_subject メソッドは、設定されたメールの "subject" (表題) を返却します。

静的 いいえ
パラメータ なし
返り値 string
// subject() でセットされた表題を返す
$subject = $email->get_subject();