CakeEmail¶

送り主の選択¶

他の人々に代わってメールを送信するとき、Sender ヘッダーを使用して、元の送り主を定義することは 良い考えです。 sender() を使用して行えます。

$Email = new CakeEmail();
$Email->sender('[email protected]', 'MyApp emailer');

設定¶

以下の設定キーを使用します。

• 'from': 送信者のメールアドレスまたは配列。 CakeEmail::from() を参照。

• 'sender': 実際の送信者のメールアドレスまたは配列。 CakeEmail::sender() を参照。

• 'to': 宛先のメールアドレスまたは配列。 CakeEmail::to() を参照。

• 'cc': CCのメールアドレスまたは配列。 CakeEmail::cc() を参照。

• 'bcc': BCC のメールアドレスまたは配列。 CakeEmail::bcc() を参照。

• 'replyTo': メールの返信先のメールアドレスまたは配列。 CakeEmail::replyTo() を参照。

• 'readReceipt': 開封通知先メールアドレスまたはアドレスの配列。 CakeEmail::readReceipt() を参照。

• 'returnPath': エラーの返信先メールアドレスまたはアドレスの配列。 CakeEmail::returnPath() を参照。

• 'messageId': メッセージID。 CakeEmail::messageId() を参照。

• 'subject': メッセージのサブジェクト。 CakeEmail::subject() を参照。

• 'message': メッセージ本文。レンダリングされた本文を使用する場合は、 この項目を設定しないでください。

• 'headers': ヘッダー情報。 CakeEmail::setHeaders() を参照。

• 'viewRender': レンダリングされた本文を使用する場合は、ビュークラス名をセット。 CakeEmail::viewRender() を参照。

• 'template': レンダリングされた本文を使用する場合は、テンプレート名をセット。 CakeEmail::template() を参照。

• 'theme': テンプレートをレンダリングする際のテーマ。 CakeEmail::theme() を参照。

• 'layout': レンダリングされた本文を使用する場合、描画するレイアウトをセット。 レイアウトなしでテンプレートをレンダリングしたい場合は、このフィールドに null をセット。 CakeEmail::template() を参照。

• 'viewVars': レンダリングされた本文を使用する場合は、ビューで使用する変数の配列をセット。 CakeEmail::viewVars() を参照。

• 'attachments': 添付ファイルの一覧。 CakeEmail::attachments() を参照。

• 'emailFormat': メールの書式 (html, text または both) CakeEmail::emailFormat() を参照。

• 'transport': トランスポート名。 CakeEmail::transport() を参照。

• 'helpers': メールテンプレート内で使用するヘルパーの配列。

これらの設定の全ては 'from' を除いてオプションです。多くの設定を配列で登録する場合、 設定は、 CakeEmail::config() メソッド内で行います。そして、 トランスポートクラスの config() に渡されます。例えば、SMTP トランスポートを使用している場合、 ホスト名、ポート、その他の設定を渡します。

ヘッダーのセット¶

CakeEmail の中に、自由にヘッダーをセットできます。CakeEmail を使用する際、 独自のヘッダーにプレフィックスの X- をつけることを忘れないでください。

CakeEmail::setHeaders() と CakeEmail::addHeaders() をご覧ください。

テンプレートメールの送信¶

メールはしばしば単純なテキストメッセージを超えたものになります。それを容易にするために CakePHP は、 ビューレイヤー を使用してメールを送信することができます。

メールのテンプレートは、 あなたのアプリケーションの View ディレクトリ内の Emails と呼ばれる特別なフォルダに置かれます。メールのビューは、 普通のビューと同様にレイアウトとエレメントを使用します。

$Email = new CakeEmail();
$Email->template('welcome', 'fancy')
    ->emailFormat('html')
    ->to('[email protected]')
    ->from('[email protected]')
    ->send();

上記は、ビューとして app/View/Emails/html/welcome.ctp を使用し、 レイアウトとして app/View/Layouts/Email/html/fancy.ctp を使用します。 以下のように、マルチパートのテンプレートメールを送信することもできます。

$Email = new CakeEmail();
$Email->template('welcome', 'fancy')
    ->emailFormat('both')
    ->to('[email protected]')
    ->from('[email protected]')
    ->send();

この例では、以下のビューファイルを使用します。

• app/View/Emails/text/welcome.ctp

• app/View/Layouts/Emails/text/fancy.ctp

• app/View/Emails/html/welcome.ctp

• app/View/Layouts/Emails/html/fancy.ctp

テンプレートメールを送信する時、 text 、 html と both のうちの どれかを送信オプションとして指定します。

CakeEmail::viewVars() でビューの変数をセットできます。

$Email = new CakeEmail('templated');
$Email->viewVars(array('value' => 12345));

以下のようにメールテンプレート内で使用します。

<p>Here is your value: <b><?php echo $value; ?></b></p>

メールでも普通のビューファイルと同様にヘルパーを使用できます。 デフォルトでは、 HtmlHelper のみがロードされます。 helpers() メソッドを使うことで追加でヘルパーをロードできます。

$Email->helpers(array('Html', 'Custom', 'Text'));

ヘルパーを設定する時は、'Html' を含めて下さい。そうしなければ、メールテンプレートに ロードされません。

もし、プラグインの中でテンプレートを使用してメール送信したい場合、おなじみの プラグイン記法 を使います。

$Email = new CakeEmail();
$Email->template('Blog.new_comment', 'Blog.auto_message');

上記の例は、 Blog プラグインのテンプレートを使用しています。

いくつかのケースで、プラグインで用意されたデフォルトのテンプレートを上書きしたい場合が あるかもしれません。 CakeEmail::theme() メソッドを使って適切なテーマを使用することを CakeEmail に伝えることによって行います。

$Email = new CakeEmail();
$Email->template('Blog.new_comment', 'Blog.auto_message');
$Email->theme('TestTheme');

これは、Blog プラグインを更新せずにあなたのテーマの new_comment テンプレートで上書きできます。 テンプレートファイルは、以下のパスで作成する必要があります: APP/View/Themed/TestTheme/Blog/Emails/text/new_comment.ctp.

添付ファイルの送信¶

CakeEmail::attachments($attachments = null)¶

メールにファイルを添付することができます。添付するファイルの種類や、 宛先のメールクライアントにどのようなファイル名で送りたいのかによって 幾つかの異なる書式があります。

1. 文字列: $Email->attachments('/full/file/path/file.png') は、 file.png というファイル名でこのファイルを添付します。

2. 配列: $Email->attachments(array('/full/file/path/file.png')) は、 文字列の場合と同じ振る舞いをします。

3. キー付き配列: $Email->attachments(array('photo.png' => '/full/some_hash.png')) は、 photo.png というファイル名で some_hash.png ファイルを添付します。 受信者からは、some_hash.png ではなく photo.png として見えます。

4. ネストした配列:

   $Email->attachments(array(
       'photo.png' => array(
           'file' => '/full/some_hash.png',
           'mimetype' => 'image/png',
           'contentId' => 'my-unique-id'
       )
   ));
   

   上記は、異なる mimetype と独自のコンテンツID を添付します (添付をインラインに変換する場合にコンテンツIDをセットします)。 mimetype と contentId はこの形式のオプションです。

   4.1. contentId を指定した時、HTML 内で <img src="cid:my-content-id"> のようにファイルを使用できます。

   4.2. 添付の Content-Disposition ヘッダーを無効にするために contentDisposition オプションを使用できます。これは、outlook を使って ical の招待状をクライアントに送る時に便利です。

   4.3. file オプションの代わりに data オプションを使うと、 ファイル本文を文字列として添付することができます。これは、ファイルパスを指定せずに 添付することができます。

トランスポートの利用¶

トランスポートは、様々なプロトコルや方法で E メールを送信するために設計されたクラスです。 CakePHP は、 Mail (デフォルト)、 Debug と SMTP トランスポートをサポートします。

これらの送信方法を設定するためには、 CakeEmail::transport() メソッドを 使用するか、設定内で transport を指定する必要があります。

App::uses('AbstractTransport', 'Network/Email');

class ExampleTransport extends AbstractTransport {

    public function send(CakeEmail $Email) {
        // magic inside!
    }

}

$yourInstance = $Email->transport('your')->transportClass();
$yourInstance->myCustomMethod();
$Email->send();

アドレス検証ルールの緩和¶

CakeEmail::emailPattern($pattern = null)¶

もし、規約に準拠していないアドレスに送信するときにバリデーションに問題がある場合、 メールアドレスのバリデーションに使用するパターンを緩和することができます。 いくつかの日本の ISP に送信するときに必要になります。

$email = new CakeEmail('default');

// 規約に準拠しないアドレスに送信できるように
// メールのパターンを緩和します。
$email->emailPattern($newPattern);