CakePHP3のメール送信の処理・テンプレート使用・添付ファイル送信も解説

2018/07/29 2019/03/31

CakePHP3でメールを送信する処理を解説

　
CakePHP3でメールを送信する処理を解説します。
　
　

CakePHP3のメール送信処理の設定ファイル

　
まず最初に、CakePHP3のメール処理設定の確認です。
CakePHP3のメールの送信処理の設定情報は、「/config/app.php」にあります。190行目辺りでしょうか。
　

    'EmailTransport' => [
        'default' => [
            'className' => 'Mail',
            /*
             * The following keys are used in SMTP transports:
             */
            'host' => 'localhost',
            'port' => 25,
            'timeout' => 30,
            'username' => null,
            'password' => null,
            'client' => null,
            'tls' => null,
            'url' => env('EMAIL_TRANSPORT_DEFAULT_URL', null),
        ],
    ],

'EmailTransport' => [

'default' => [

'className' => 'Mail',

* The following keys are used in SMTP transports:

'host' => 'localhost',

'port' => 25,

'timeout' => 30,

'username' => null,

'password' => null,

'client' => null,

'tls' => null,

'url' => env('EMAIL_TRANSPORT_DEFAULT_URL', null),

　
上記はデフォルトの設定ですが、今回は上記の通り「’className’ => ‘Mail’」になっている状態での想定で解説をします。
　
　
この設定についても解説をしておくと、「className」に指定する値は、「Mail」「Smtp」「Debug」のいずれかです。
　
「Mail」が指定されている場合は、PHPの mail()関数を使用してメールを送信します。
「Smtp」が指定されている場合は、指定されてある SMTPサーバを使用してメールを送信します。
「Debug」が指定されている場合は、デバッグ用の処理として実行され、実際にメールの送信は行いません。
　
「host」から「url」までの設定は、「’className’ => ‘Smtp’」の設定となっている場合のみ有効です。
それ以外の時は使われませんのでデフォルトのままで問題ありません。
　

SMTPで送信するときは「Email」の設定が必要な場合も

　
「’className’ => ‘Smtp’」を設定している場合は、下記の「Email」の設定もする必要がある場合があります。
　
下記の設定の「from」が実際に送信するメールアドレスを設定します。
　

    'Email' => [
        'default' => [
            'transport' => 'default',
            'from' => 'you@localhost',
            //'charset' => 'utf-8',
            //'headerCharset' => 'utf-8',
        ],
    ],

'Email' => [

'default' => [

'transport' => 'default',

'from' => 'you@localhost',

//'charset' => 'utf-8',

//'headerCharset' => 'utf-8',

　
fromの値が実際に送信するメールアドレスになっていない場合は、メールの送信を拒否するメールサーバも多くありますので、この設定も確認します。
　
　

CakePHP3でメールを送信する基本形

　
CakePHP3で一番簡単な方法でメールを送信する場合は、以下のように設定します。
まずは、この設定でメールが送信できるかどうかを確認しましょう。
　

<?php
namespace App\Controller;
use App\Controller\AppController;

// メール送信
use Cake\Mailer\Email;

class InquiriesController extends AppController
{

       （中略）

    // メール送信フォーム
    public function form()

       （中略）

        // メール送信処理
        $email = new Email("default");

        // 入力者へのメール
        $email->setFrom(["from@example.com"=>"送信元名"])
              ->setTo("to@example.com")
              ->setCc("cc@example.com")
              ->setBcc("bcc@example.com")
              ->setSubject("お問合せありがとうございます。")
              ->send("お問い合わせの本文です");

       （後略）

<?php

namespace App\Controller;

use App\Controller\AppController;

// メール送信

use Cake\Mailer\Email;

class InquiriesController extends AppController

{

（中略）

// メール送信フォーム

public function form()

（中略）

// メール送信処理

$email = new Email("default");

// 入力者へのメール

$email->setFrom(["from@example.com"=>"送信元名"])

->setTo("to@example.com")

->setCc("cc@example.com")

->setBcc("bcc@example.com")

->setSubject("お問合せありがとうございます。")

->send("お問い合わせの本文です");

（後略）

　
まず、6行目の Emailクラスをロードする処理を記述します。
　
19行目で、Emailクラスのインスタンスを作成します。
作成したインスタンスに対して、22行目からあるように、メソッド・チェーンで必要なプロパティを設定していきます。
　
上記では setFrom()、setTo()、setCc()、setBcc()、setSubject()を使用していますが、これは、CakePHP3.4以降の仕様です。
　
CakePHP3.4より前のバージョンでは、from()、to()、cc()、bcc()、subject()を使用します。
　
setCc()、setBcc()の設定が必要ない場合は、設定の行ごと削除します。
「setCc("")」のように、nullを設定するとエラーになります。
　
　
また、19行目でインスタンスを作成する処理は、下記の様に記述することもできます。
　

        $email = new Email();
        $email->setProfile("default");

1 2	$email = new Email(); $email->setProfile("default");

　
上記で書いている setProfile()は、他の設定と同じく CakePHP3.4以降の仕様です。
CakePHP3.4より前のバージョンでは、profile()を使用します。
　
　
また、設定名の「default」を渡す代わりに、オプションの配列をロードすることもできます。
　

        $email = new Email(["from" => "from@example.com", "transport" => "送信元名"]);
// もしくは
        $email = new Email();
        $email->setProfile(["from" => "from@example.com", "transport" => "送信元名"]);

$email = new Email(["from" => "from@example.com", "transport" => "送信元名"]);

// もしくは

$email = new Email();

$email->setProfile(["from" => "from@example.com", "transport" => "送信元名"]);

CakePHP3でメールを送信する際にテンプレートを使用する

　
メールフォーム（お問い合わせフォーム）などでメールを送信する場合は、メールの本文をプログラムの中に記述することはありません。
メールの本文は、テンプレートファイルとして別ファイルにし、そのファイルに変数を編集することでメールの本文を完成させます。
　
ここでは、テンプレートファイルを利用してメールを送信する方法を解説します。
　
　
テンプレートを指定する場合は、下記の 2～4行目のように setTemplate()、setLayout()、emailFormat()で指定します。
　

        $email->setFrom(["from@example.com"=>"送信元名"])
              ->setTemplate("inquiriesForm")
              ->setLayout("inquiriesFormLayout")
              ->emailFormat("text")
              ->setTo("to@example.com")
              ->setCc("cc@example.com")
              ->setBcc("bcc@example.com")
              ->setSubject("お問合せありがとうございます。")
              ->viewVars(["name"=>$this->request->data['name'],
                          "ruby"=>$this->request->data['ruby']])
              ->send("お問い合わせの本文です");

$email->setFrom(["from@example.com"=>"送信元名"])

->setTemplate("inquiriesForm")

->setLayout("inquiriesFormLayout")

->emailFormat("text")

->setTo("to@example.com")

->setCc("cc@example.com")

->setBcc("bcc@example.com")

->setSubject("お問合せありがとうございます。")

->viewVars(["name"=>$this->request->data['name'],

"ruby"=>$this->request->data['ruby']])

->send("お問い合わせの本文です");

　
2行目の「setTemplate()」でテンプレートファイルを指定し、3行目の「setLayout()」でレイアウトファイルを指定します。
レイアウトファイルを指定しない場合は「setTemplate()」のみの設定で OKです。
　
テンプレートファイルを上記のように「inquiriesForm」と指定する場合は、下記のファイルが使われます。
/src/Template/Email/text/inquiries_form.ctp
　
レイアウトファイルを上記のように「inquiriesFormLayout」と指定する場合は、下記のファイルが使われます。
src/Template/Layout/Email/text/inquiriesFormLayout.ctp
　
上記のように複数単語の組み合わせでファイルを指定する場合は注意が必要です。
テンプレートファイルの指定が、「inquiriesForm」の場合の実ファイルは「inquiries_form.ctp」となります。
「inquiriesForm.ctp」では、「ファイルがありません」というエラーになります。
　
しかし、テンプレートファイルの指定が、「inquiriesFormLayout」の場合の実ファイルは「inquiriesFormLayout.ctp」となります。
「inquiries_form_layout.ctp」では、「ファイルがありません」というエラーになります。
　
　
4行目の「emailFormat()」で指定する引数は「text」です。
　
これは「text」タイプのメールを送信することを指定していることになります。
「html」とすると「html」タイプのメールを送信し、「both」とすると「text」「html」の両方を使うマルチパートのメールを送信します。
　
「html」タイプのテンプレートファイルは、以下のものになります。
src/Template/Email/html/inquiries_form.ctp
src/Template/Layout/Email/html/inquiriesFormLayout.ctp
　
　
ちなみに、CakePHP3.4以降は上記で解説したように「setTemplate()」「setLayout()」で設定します。
ですが、CakePHP3.4より前のバージョンでは、「template(“inquiriesForm”, “inquiriesFormLayout”)」のように、「template()」で指定します。1つ目の引数がテンプレートのファイルで、2つ目がレイアウトのファイルです。
　
　
9行目、10行目が、テンプレートに編集する値を指定している箇所です。
　
「viewVars()」を使って値を指定します。
値の指定は連想配列で「変数名 => 値」のように指定します。
上記の例では、「名前」として入力された「name」という値と、「ふりがな」として入力された「ruby」という値を編集している想定です。
　
　
また、テンプレートファイル「inquiries_form.ctp」の中身は以下のようになります。
「viewVars()」で指定した変数が編集されます。
　

<?php
echo "なまえ　：" . $name . "\n";
echo "ふりがな：" . $ruby . "\n";
echo $content;

<?php

echo "なまえ　：" . $name . "\n";

echo "ふりがな：" . $ruby . "\n";

echo $content;

　
また、「$content」には、「send()」で指定した引数の文字列が編集されます。
上記の例では「お問い合わせの本文です」の文字列が入ります。
　
　
「send()」はメールを送信する処理そのものですので、「viewVars()」なども含め設定情報は全て、「send()」より前に記述します。
（私は「send()」の後に「viewVars()」を書いていて、何で動かないのか、しばらく悩んでいました。）
　
また、上記の例では「send()」に引数を入れていますが、テンプレートに編集する値をすべて「viewVars()」で指定しているのであれば、「send()」に引数を指定する必要はありません。
　
　
レイアウトファイル「inquiriesFormLayout.ctp」の中身は以下のようになります。
「$this->fetch(‘content’)」を記述した場所に、テンプレートファイルの中身が編集されます。
　

<?php
echo $this->fetch('content');

1 2	<?php echo $this->fetch('content');

CakePHP3でメールを送信する際に添付ファイルを一緒に送信する方法

　
CakePHP3でメール送信時に添付ファイルを一緒に送信する場合は「attachments()」を使用します。
　

        $email->setFrom(["from@example.com"=>"送信元名"])
              ->setTemplate("inquiriesForm")
              ->emailFormat("text")
              ->setTo("to@example.com")
              ->setSubject("お問合せありがとうございます。")
              ->viewVars(["name"=>$this->request->data['name'],
                          "ruby"=>$this->request->data['ruby']])
              ->setAttachments("/xampp/htdocs/webroot/img/example.gif")
              ->send("お問い合わせの本文です");

$email->setFrom(["from@example.com"=>"送信元名"])

->setTemplate("inquiriesForm")

->emailFormat("text")

->setTo("to@example.com")

->setSubject("お問合せありがとうございます。")

->viewVars(["name"=>$this->request->data['name'],

"ruby"=>$this->request->data['ruby']])

->setAttachments("/xampp/htdocs/webroot/img/example.gif")

->send("お問い合わせの本文です");

　
　
一番ベーシックな「attachments()」の使い方が上記の記述方法です。
引数として、添付するファイルをフルパスで指定します。
　
この場合の「フルパス」はサーバのルートからのフルパスです。
ドキュメントルートからのフルパスではありません。
　
また、指定したファイルがない場合はエラーとなりますので、実処理上はファイルのありなしのチェックが必要です。
ただ、「null」を指定した場合は、「webroot」という 0バイトのファイルが添付されてきます。
　
　
ちなみに、CakePHP3.4以降は上記で解説したように「setAttachments()」で設定します。
ですが、CakePHP3.4より前のバージョンでは、「attachments()」で指定します。
　
　
下記の様に配列として指定することで複数のファイルを添付することができます。
動作は前項の文字列として指定した場合と同じです。
　

              ->setAttachments(["/xampp/htdocs/webroot/img/example.gif",
                                "/xampp/htdocs/webroot/img/example2.gif"])

1 2	->setAttachments(["/xampp/htdocs/webroot/img/example.gif", "/xampp/htdocs/webroot/img/example2.gif"])

　
　
下記の様に連想配列でファイルを指定すると、ファイル名は、キーとして指定したファイル名で添付されます。
　

              ->setAttachments(["abc.gif"=>"/xampp/htdocs/webroot/img/example.gif",
                                "def.gif"=>"/xampp/htdocs/webroot/img/example2.gif"])

1 2	->setAttachments(["abc.gif"=>"/xampp/htdocs/webroot/img/example.gif", "def.gif"=>"/xampp/htdocs/webroot/img/example2.gif"])

　
ファイル名の重複や日本語ファイル名などによる不具合を避けるために、アップロードされたファイル名を付けなおしている場合などは、このようにして元のファイル名を付けなおして送信する、といった処理が必要になるでしょう。
　
　
さらに、下記の様に「mimetype」「contentId」を付与する方法もあります。
　

              ->setAttachments(["abc.gif"=>[
                                "file" =>"/xampp/htdocs/webroot/img/_black.gif",
                                "mimetype" => "image/gif",
                                "contentId" => "12345"]])

->setAttachments(["abc.gif"=>[

"file" =>"/xampp/htdocs/webroot/img/_black.gif",

"mimetype" => "image/gif",

"contentId" => "12345"]])

CakePHP3でメールを送信する方法についての解説まとめ

　
これまで解説した内容があれば、メールフォーム（お問い合わせフォーム）からメールを送信する処理は作成できるかと思います。
　
今回は、SMTPサーバに接続する方法や、メールトランスポートを使用する方法などは解説していませんので、それらの解説についてはまたいずれ解説記事を書く予定です。
　
　

- CakePHP 3.x 4.x CakePHP3

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP3のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。ユーザ新規登録の流れを紹介しつつテンプレートファイルがどこにあるか、設定情報ファイルがどこにあるか、を説明しつつカスタマイズの方法を解説します。

: CakePHP3の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その３

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその3で記事を更新する際のファイルの取り回しなどについてを解説。

: CakePHP 2.3　Search Pluginで検索処理　その４前方一致検索、後方一致検索、不等号による検索、between句による範囲検索

CakePHPの検索プラグイン Search Pluginの検索処理の中で前方一致検索、後方一致検索、不等号による検索、between句による範囲検索の解説です。

: CakePHP3でテーブルにカラム（項目）を追加したときに変更するポイントのまとめ

CakePHP3でシステム開発をする際、途中でカラムを追加した場合に何を変更すればいいかを確認。カラムを追加する前後で Bakeした結果を比較し、変更になった点をリストアップした。

: CakePHP3のHtmlHelperのLink設定のまとめ。mailto、URL、Root／Homeのリンクなども

CakePHP3でHtmlHelperを使ってリンクの設定をする方法のまとめ。基本形からURLを指定、class、id、targetを指定、mailtoのリンク、画像をアンカーに、JavaScriptのダイアログなどの解説。

: CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数

CakePHP3で特定フォルダのパスの定数を解説。root、DocumentRoot、app、config、webroot、tests、tmp、cache、vendor、コア、コアの srcが設定済み。realpath()関数を使うと柔軟なパス指定が可能。

: CakePHPを学ぶ際にはオブジェクト指向を学ぼう

CakePHPはオブジェクト指向で書かれていますので、CakePHPを学ぶにはオブジェクト指向も学びましょう。

: CakePHPで同一テーブル内の値を比較する条件でレコードを取得する方法

CakePHPの同一テーブルにある項目の値を比較し条件に合致するレコードを取得する方法を解説。［”項目名”=>”値”]ではなく[”項目名 = 項目名”］と書くところがポイント。

: MySQL、CakePHP 2.3で「tinyint(1)」の Boolean型の動作を再確認

MySQL＋CakePHPの環境で「tinyint(1)」を利用する際の動作を検証。「tinyint(1)」の Boolean型について CakePHPでは自動処理が実施されていることを確認しました。