CodeIgniter ユーザガイド 日本語版 Version 2.1.0


Email クラス

CodeIgniter の堅牢な Email クラスは、次のような機能に対応しています:

Email の送信

メールの送信は単純なだけでなく、送信する直前にも設定ファイルでも、メール送信の設定ができます。

以下は、どうやってメールを送信できるかを示した基本的な例です。 Note: この例では、コントローラ でメールを送信すると仮定しています。

$this->load->library('email');

$this->email->from('your@example.com', 'Your Name');
$this->email->to('someone@example.com');
$this->email->cc('another@another-example.com');
$this->email->bcc('them@their-example.com');

$this->email->subject('Email Test');
$this->email->message('Testing the email class.');

$this->email->send();

echo $this->email->print_debugger();

Email のオプションを設定する

メールの送信方法をカスタマイズできる17の設定項目が利用可能です。 以下で述べるように手動で設定することもできますし、後述するように、設定ファイルに保管された項目から自動設定することもできます:

設定項目は、email クラスの initialize メソッドに設定項目の配列を渡すことでセットすることができます。以下は、設定項目をどのようにセットできるかの例です:

$config['protocol'] = 'sendmail';
$config['mailpath'] = '/usr/sbin/sendmail';
$config['charset'] = 'iso-8859-1';
$config['wordwrap'] = TRUE;

$this->email->initialize($config);

Note: ほとんどの設定項目には、設定しなかった場合に使われる初期値があります。

設定ファイルでEmailの設定を行う

設定をするのに、上で述べた方法を使いたくない場合は、代わりに設定ファイルにその設定を書いておくことができます。 email.php という名前で新しいファイルをつくり、$config という配列をそのファイルに書くだけです。 そして、config/email.php にそのファイルを保存すると、自動的にそれが使われます。 設定ファイルで設定した場合は、$this->email->initialize() メソッドを使う必要は「ありません」。

Email クラスの設定項目

次のリストは、メールを送信する際にセットできる設定項目の全リストです。

設定項目 初期値 選択肢 説明
useragentCodeIgniterなしユーザエージェント
protocolmailmail、sendmail、 または smtpメールを送信するプロトコル
mailpath/usr/sbin/sendmailなしSendmail へのパス
smtp_host初期値なしなしSMTP サーバのアドレス
smtp_user初期値なしなしSMTP のユーザ名
smtp_pass初期値なしなしSMTP のパスワード
smtp_port25なしSMTP のポート番号
smtp_timeout5なしSMTP のタイムアウト (秒単位)
wordwrapTRUETRUE または FALSE (boolean)ワードラップの有効化設定
wrapchars76 何番目の文字で折り返すか
mailtypetexttext または htmlメールのタイプ。HTML メールを送信すると、メールは完全な Web ページとして送信されます。このとき、相対リンクや画像への相対パスがないか確かめてください。それらは動作しません。
charsetutf-8文字セット (utf-8、iso-8859-1、など)
validateFALSETRUE または FALSE (boolean)メールアドレスを検証するかどうか
priority31, 2, 3, 4, 5メールの優先度。 1 = 最高 5 = 最低 3 = 通常
crlf \n "\r\n" or "\n" or "\r" 改行文字 (RFC 822に従う場合は、"\r\n")
bcc_batch_modeFALSETRUE または FALSE (boolean) BCC バッチモードを有効にするかどうか
bcc_batch_size200なし
各 BCC バッチで送るメール件数。

Email メソッドリファレンス

$this->email->from()

送信メールアドレスと送信者の名前を設定します:

$this->email->from('you@example.com', 'あなたの名前');

$this->email->reply_to()

返信先アドレスをセットします。指定しない場合は、"from" メソッドで指定されたものが使われます。例:

$this->email->reply_to('you@example.com', 'あなたの名前');

$this->email->to()

受取人のメールアドレスをセットします(複数可)。次のように、単一のメールアドレス、カンマ区切りのリスト、あるいは配列で指定可能です:

$this->email->to('someone@example.com'); $this->email->to('one@example.com, two@example.com, three@example.com'); $list = array('one@example.com', 'two@example.com', 'three@example.com');

$this->email->to($list);

$this->email->cc()

CC のメールアドレスをセットします(複数可)。 "to" メソッドのように、単一のメールアドレス、カンマ区切りのリスト、あるいは配列で指定可能です。

$this->email->bcc()

BCC のメールアドレスをセットします(複数可)。"to" メソッドのように、単一のメールアドレス、カンマ区切りのリスト、あるいは配列で指定可能です。

$this->email->subject()

メールの件名をセットします:

$this->email->subject('これは件名です');

$this->email->message()

メールの本文をセットします:

$this->email->message('これはメッセージです');

$this->email->set_alt_message()

代替のメール本文をセットします:

$this->email->set_alt_message('これは代替のメッセージです');

これは、HTML フォーマットのメールを送信する際にオプションで指定できるメッセージです。 HTML フォーマットでない代替メッセージを指定でき、HTML メールを受け取らない相手に対して表示するようメールのヘッダに追加します。 メッセージを指定しない場合は、CodeIgniter は HTML メールからタグを取り除いて抽出したメッセージをセットします。

$this->email->clear()

メールの設定を空状態にします。 このメソッドは、ループの各サイクルでデータをリセットしながらメール送信機能を使う場合を意図しています。

foreach ($list as $name => $address)
{
    $this->email->clear();

    $this->email->to($address);
    $this->email->from('your@example.com');
    $this->email->subject('あなたの情報: '.$name);
    $this->email->message('こんにちは '.$name.'さん ご要望の情報です。');
    $this->email->send();
}

次のように引数に TRUE をセットした場合は、すべての添付も解除されます:

$this->email->clear(TRUE);

$this->email->send()

メール送信メソッド。 条件判断が利用できるよう、送信が成功したか失敗したかに基づいてブール値の TRUE か FALSE が返ります:

if ( ! $this->email->send())
{
    // エラーを生成
}

$this->email->attach()

添付ファイルを送信できます。第1引数にファイルのパスとファイル名を指定してください。 Note: URL でなく、ファイルの物理パスを使ってください。複数ファイルを添付する場合は、複数回メソッドを呼んでください。たとえば以下のようにします:

$this->email->attach('/path/to/photo1.jpg');
$this->email->attach('/path/to/photo2.jpg');
$this->email->attach('/path/to/photo3.jpg');

$this->email->send();

$this->email->print_debugger()

すべてのサーバメッセージ、メールヘッダ、メールメッセージを文字列として返します。デバッグに役立ちます。

ワードラップ設定の上書き

ワードラップが有効になっている (RFC 822 に従うことを推奨します)場合 、 email に非常に長いリンクがあると折り返されてしまい、受信した人がクリックできないようになります。 CodeIgniter では、次のようにして、メッセージの一部で手動でワードラップ設定を上書きすることができます:

通常通り折り返された
メールのテキスト。

{unwrap}http://example.com/a_long_link_that_should_not_be_wrapped.html{/unwrap}

さらに通常通り折り返
されたテキスト.

折り返したくない項目を {unwrap} {/unwrap}で挟んでください。