はじめに - Email パッケージ - FuelPHP ドキュメント

Email パッケージ

Email パッケージは、 php のメール関数、 sendmail 、または SMTP のいずれかを利用して、メールを送信するインターフェースを提供します。パッケージのサポート:

プレーンテキストメール
HTML メールとオプションの代替本文
添付ファイル
インラインの添付ファイル。

インストール

Email パッケージは、本体 (1.1 以降) に含まれています。アプリケーションの設定ファイルの中、または必要な時に呼び出して、パッケージを有効にする必要があります。

'always_load' => array(
	'packages' => array(
		'email',
	),
),

// または Controller の中で:

\Package::load('email');

構成

app/config/email.php にある設定ファイルを作成 (または package からコピー) します。そして、必要な設定項目を変更します。

注意してください: Email パッケージがあなたの email 設定を読み込みます、従って設定を読み込むことは必要はありません。

一般的な構成

パラメータ	型	デフォルト	説明
defaults	array	`array( /* デフォルト設定の配列 */ )`	デフォルト設定項目は、すべての設定グループに使用されます。あなたの設定グループは、これらの値を上書きします。
default_setup	string	`'default'`	何も指定されない場合に使用するデフォルト設定。
setups	array	`array( 'default' => array(), )`	デフォルト設定と一緒にする設定の配列。あなたの設定を追加するか、またはデフォルト設定のグループを変更します。

グループの構成

パターン	型	デフォルト	説明
useragent	string	`'FuelPHP, PHP 5.3 Framework'`	ユーザエージェント。
driver	string	`'mail'`	使うドライバ。 mail 、 smtp 、 sendmail 、mailgun または noop (ただログを書き込むだけ) 。小文字で指定します。
is_html	boolean	`false`	HTML 形式のメール、もしくはテキスト形式のメールのどちらかで送信します。
encode_headers	boolean	`true`	メールの表題と受信者名をエンコードするかどうか。 mbstring 拡張モジュールが必要となります。
charset	string	`'utf-8'`	メールメッセージの文字セットを指定します。
encoding	string	`'8bit'`	メールメッセージのエンコードを指定します。 7bit 、 8bit 、 quoted printable 文字列と base64 が使用できます。
priority	string	`\Email::P_NORMAL`	次のように、メールの優先度を指定することができます。 \Email::P_LOWEST \Email::P_LOW \Email::P_NORMAL \Email::P_HIGH \Email::P_HIGHEST
from.email	string\|false	`false`	デフォルトの from メールアドレスにセットします。
from.name	string\|false	`false`	デフォルトの from 名をセットします。
validate	bool	`true`	アドレスを検証したくない場合は、 false に設定します。送信に失敗する可能性があります。
auto_attach	bool	`true`	HTML 本文から (背景) 画像を自動的に添付するかどうかを指定します。
generate_alt	bool	`true`	HTML 本文から alt (代替テキスト) を自動的に生成するかどうかを指定します。
wordwrap	int\|false	`76`	ワードラップのサイズ。 0 以下の場合は折り返されます。 base64 または quoted printable 文字列を使用している場合、この設定は無視されます。
sendmail_path	string	`'/usr/sbin/sendmail'`	sendmail のパス。
smtp.host	string	`''`	SMTP ホスト。
smtp.port	int	`25`	SMTP ポート。
smtp.username	string	`''`	SMTP ユーザ名。
smtp.password	string	`''`	SMTP パスワード。
smtp.timeout	int	`5`	SMTP のタイムアウトの値。送信処理中にタイムアウトが発生する場合はこの値を増やしてください。
smtp.starttls	bool	`false`	SMTP サーバが STARTTLS コマンドを必要とするかどうか。
newline	string	`"\n"`	新しい行。
attach_paths	array	`array('');`	添付ファイルのパスの配列。添付ファイルを加える時、ドライバはこれらのパスを調べて、最初に見つけたものを添付します。絶対パスを許可するために、そこに空 ('') を入れたままにしておいてください。
return_path	string\|false	`false`	デフォルトの return-path メールアドレスにセットします。
remove_html_comments	bool	`true`	true の場合、 HTML 本文内のすべてのコメントは削除されます。
relative_protocol_replacement	string\|false	`false`	文字列を設定すると、すべての相対プロトコル URI(http:// の代わりに // で始まる) は、ここで指定する値に置き換えられます。いくつかの電子メールクライアント (Outlook!) は、相対プロトコル URI をサポートしていないために、それらを http:// もしくは https:// にそれらを変換することができます。
mandrill.key	string	`'api_key'`	あなたの Mandrill API キー。
mandrill.message_options	array	`array()`	Mandrill のドキュメントを確認してください。 (メッセージ構造体を探してください)
mandrill.send_options.async	bool	`false`	バックグラウンド送信を有効にします。
mandrill.send_options.ip_pool	string	`null`	メッセージを送信するために使用されるべき専用の IP プールの名前
mandrill.send_options.send_at	string	`null`	このメッセージを YYYY-MM-DD HH:MM:SS 形式の UTC タイムスタンプとして送信する必要がある場合。

マンドリルドライバを使用する場合は mandrill/mandrill コンポーザーパッケージをインストールしてください。

Mailgun の構成

パラメータ	型	デフォルト	説明
key	string	`'YOUR KEY'`	あなたの mailgun アカウントのキー。
domain	string	`'YOUR DOMAIN'`	あなたのウェブサイトのドメイン