The More with symfony book

Fabien Potencier 著

Swift Mailer ライブラリのおかげで、symfony でのメールは簡単でパワフルです。

Swift Mailer を使うとメールを簡単に送信できますが、symfony ではさらに薄いラッパーをその上にかぶせて、柔軟でパワフルなメール送信を実現しています。

この章ではこれらのパワーを自由に使いこなすための方法を教えます。

symfony 1.3 には、Swift Mailer　のバージョン4.1が同梱されています。

はじめに

symfony におけるメール管理の中心は mailer オブジェクトです。他の多くの symfony コアオブジェクトと同様に、mailer はファクトリです。factories.yml ファイルで設定でき、context インスタンスを経由していつでも以下のように呼び出すことができます:

$mailer = sfContext::getInstance()->getMailer();

ほかのファクトリと違い、mailer は呼ばれたときだけロードされ、初期化されます。使わないのであれば、パフォーマンスには影響しません

このチュートリアルでは、Swift Mailer の symfony への統合について説明します。もし Swift Mailer ライブラリのすばらしい詳細を学びたければ、そちらのドキュメントを参照してください。

アクションからメールを送る

アクションから mailer インスタンスを取得するには、便利メソッドの getMailer() を呼ぶのが簡単です:

$mailer = $this->getMailer();

一番簡単な方法

sfAction::composeAndSend() メソッドを使ってメールを送るのが一番簡単です:

$this->getMailer()->composeAndSend(
  'from@example.com',
  'fabien@example.com',
  'Subject',
  'Body'
);

composeAndSend() メソッドは次の4つの引数を取ります:

• 送信者のメールアドレス(from)
• 受信者(複数も可能)のメールアドレス (to)
• メールのタイトル
• メール本文

メールアドレスを引数で受け取るメソッドでは、常に文字列を配列として渡すことが可能です:

$address = 'fabien@example.com';
$address = array('fabien@example.com' => 'Fabien Potencier');

もちろん、第2引数に配列を渡すことで、一度に複数の相手にメールを送ることもできます:

$to = array(
  'foo@example.com',
  'bar@example.com',
);
$this->getMailer()->composeAndSend('from@example.com', $to, 'Subject', 'Body');
 
$to = array(
  'foo@example.com' => 'Mr Foo',
  'bar@example.com' => 'Miss Bar',
);
$this->getMailer()->composeAndSend('from@example.com', $to, 'Subject', 'Body');

柔軟な方法

もっと柔軟な指定がしたければ、sfAction::compose() メソッドでメッセージを作成し、それを好みに合わせてカスタマイズした上で送信することもできます。

これはたとえば、次のようにメールにファイルを添付して送りたいときなどに役に立ちます:

// メッセージオブジェクトの生成
$message = $this->getMailer()
  ->compose('from@example.com', 'fabien@example.com', 'Subject', 'Body')
  ->attach(Swift_Attachment::fromPath('/path/to/a/file.zip'))
;
 
// メッセージを送る
$this->getMailer()->send($message);

もっとパワフルな方法

もっと柔軟に、メッセージオブジェクトを直接作ることもできます:

$message = Swift_Message::newInstance()
  ->setFrom('from@example.com')
  ->setTo('to@example.com')
  ->setSubject('Subject')
  ->setBody('Body')
  ->attach(Swift_Attachment::fromPath('/path/to/a/file.zip'))
;
 
$this->getMailer()->send($message);

Swift Mailer の公式マニュアル中の「メッセージの作成」と「メッセージヘッダー」セクションで、メッセージの作成に必要な知識が網羅されています。

symfony のビューを使う

アクションからメールを送るときに、パーシャルやコンポーネントを活用することも簡単です。

$message->setBody($this->getPartial('partial_name', $arguments));

設定

他の symfony ファクトリと同様に、mailer も設定ファイル factories.yml で変更できます。デフォルトの設定は以下のとおりです:

mailer:
  class: sfMailer
  param:
    logging:           %SF_LOGGING_ENABLED%
    charset:           %SF_CHARSET%
    delivery_strategy: realtime
    transport:
      class: Swift_SmtpTransport
      param:
        host:       localhost
        port:       25
        encryption: ~
        username:   ~
        password:   ~

新規にアプリケーションを作成するときは、アプリケーションにローカルな設定ファイル factories.yml が生成され、prod、env、test 環境に応じたそれぞれのデフォルト設定値でオーバーライドします。

test:
  mailer:
    param:
      delivery_strategy: none
 
dev:
  mailer:
    param:
      delivery_strategy: none

配信のための戦略

Swift Mailer の symfony への統合で最もすばらしいものの一つが、配信戦略 (delivery strategy) です。

配信戦略を使うと、symfony に対してメールをどう送るかを、設定ファイル factories.yml のなかの delivery_strategy を書くだけで変更することができるのです。

戦略の変更は、send()|sfMailer::send() メソッドの動作を変えます。デフォルトでは 4 つの異なる戦略が用意されていて、ほとんどの場合はこれらが使えるでしょう:

• realtime: メッセージはリアルタイムで直ちに送信されます。
• single_address: メッセージはすべて一つのアドレスに送信されます。
• spool: メッセージはキューに格納されます。
• none: メッセージは単に無視され、捨てられます。

リアルタイム (realtime) 戦略

リアルタイム (realtime) 戦略はデフォルトの配信戦略で、何も設定しなくて良いため一番簡単に使えます。

メールは factories.yml 設定ファイルの transport セクションで設定されたトランスポートを使って送信されます。メールのトランスポートを設定する方法については次の節をご覧ください。

単一アドレス戦略 (single_address)

単一アドレス戦略 (single_address) では、すべてのメールは delivery_address で設定された1つのアドレスに送られます。

この戦略は、開発環境において本当のユーザーに間違ってメールを送らないようにしつつも、メールの作成がちゃんとうまくいっているということを確認できるのでとても有用です。

元々のヘッダー指定 to、cc、bcc のどれに送られたメールなのかを確認できるよう、それぞれ X-Swift-To、X-Swift-Cc、X-Swift-Bcc というヘッダーが追加されます。

この時のメールは、リアルタイム (realtime) 戦略と同じトランスポートを使って送信されます。

スプール戦略 (spool)

スプール (spool) 戦略では、メッセージはキューに格納されます。

運用環境においては、これが一番良い戦略でしょう。なぜならば、Web リクエストがメールが実際に送信されるのを待つ必要がないからです。

spool クラスは設定ファイルの spool_class で指定します。symfony はデフォルトで3つのクラスをもっています:

• Swift_FileSpool: メッセージはファイルシステムに格納されます。

• Swift_DoctrineSpool: メッセージは Doctrine のモデルに格納されます。

• Swift_PropelSpool: メッセージは Propel のモデルに格納されます。

スプールが生成されるとき、コンストラクタの引数には spool_arguments で設定した値が使われます。内蔵のキュークラスに与えることができるオプションは以下になります:

• Swift_FileSpool:

  • キューファイルを格納するディレクトリの絶対パス (メッセージはこのディレクトリに格納されます)。

• Swift_DoctrineSpool:

  • メッセージを格納するのに使う Doctrine のモデル (デフォルトは MailMessage)。

  • メッセージを格納するカラム名 (デフォルトは message)。

  • 送信時にメッセージを取得するメソッド (オプション)。 キューオプションを引数として受け取ります。

• Swift_PropelSpool:

  • メッセージを格納するのに使う Propel のモデル (デフォルトは MailMessage)。

  • メッセージを格納するカラム名 (デフォルトは message)。

  • 送信時にメッセージを取得するメソッド (オプション)。 キューオプションを引数として受け取ります。

Doctrine スプールのための典型的な設定はこうなります:

# schema.yml のスキーマ設定
MailMessage:
 actAs: { Timestampable: ~ }
 columns:
   message: { type: clob, notnull: true }

# factories.yml の設定
mailer:
  class: sfMailer
  param:
    delivery_strategy: spool
    spool_class:       Swift_DoctrineSpool
    spool_arguments:   [ MailMessage, message, getSpooledMessages ]

同じ設定を Propel スプールではこう書きます:

# schema.yml のスキーマ設定
mail_message:
  message:    { type: clob, required: true }
  created_at: ~

# factories.yml の設定
dev:
  mailer:
    param:
      delivery_strategy: spool
      spool_class:       Swift_PropelSpool
      spool_arguments:   [ MailMessage, message, getSpooledMessages ]

キューに格納されたメッセージを送信するには、project:send-emails タスクを使います (このタスクはキューの実装やそのオプションとは完全に独立していることに注目してください):

$ php symfony project:send-emails

project:send-emails タスクはオプション applicationとenv を受け取ります。

project:send-emails タスクを実行するとき、メールはリアルタイム (realtime) 戦略で使われるのと同じトランスポートを使って送信されます。

project:send-emails タスクはどのマシンからでも実行できます。作成したマシンで実行することにこだわる必要はありません。これが動くのは、メッセージオブジェクトに添付ファイルを含めすべてが保存されているからです。

内蔵のキューの実装は非常に単純です。メールの送信にはリアルタイム戦略のときと変わらず、エラー管理のしくみがありません。もちろん、デフォルトのキュークラスを拡張してあなた自身のエラー管理ロジックを追加することが可能です。

project:send-emails タスクは2つの省略可能なオプションを取ります:

• message-limit: 送信するメッセージ数の上限

• time-limit: メッセージを送信する時間の上限 (秒)

2 つのオプションは組み合わせて指定することもできます:

$ php symfony project:send-emails --message-limit=10 --time-limit=20

上記のコマンドは、10通のメッセージが送信されたか、20秒経過したときに終了します。

スプール (spool) 戦略を使っているときでも、キューに格納せずにメッセージをすぐに送信したい場合もあるかもしれません。これには mailer の特別なメソッド sendNextImmediately() を使います:

$this->getMailer()->sendNextImmediately()->send($message);

上の例では、$message はキューには格納されず、直ちに送信されます。名前が示すように、sendNextImmediately() メソッドは次に 送られようとするメールだけに影響するのです。

sendNextImmediately() メソッドは配送戦略が spool 以外のときは何も変わったことはしません。

none 戦略

この戦略は、開発環境で実際のユーザーへメールが送られないようにする時に有用です。

この時もウェブデバッグツールバーにはメッセージが表示されます (Web デバッグツールバーのメーラーパネルついては、この章の後半を参照してください)。

これはまた、テスト向けにも最適な戦略です。実際にメッセージを送ることなしに、sfTesterMailer オブジェクトでメッセージの確認をすることができます (詳細については、テストに関する後のほうのセクションを参照してください)。

メールのトランスポート

メールは、実際にはトランスポートによって送信されます。

トランスポートは設定ファイルの factories.yml で設定され、デフォルトではローカルマシン上の SMTP サーバを利用します:

transport:
  class: Swift_SmtpTransport
  param:
    host:       localhost
    port:       25
    encryption: ~
    username:   ~
    password:   ~

Swift Mailer には3種類の異なるトランスポートクラスがついてきます:

• Swift_SmtpTransport: メッセージの送信に SMTP サーバーを使います。

• Swift_SendmailTransport: メッセージの送信に sendmail コマンドを使います。

• Swift_MailTransport: メッセージの送信に PHP ネイティブ関数の mail() を使います。

Swift Mailer 公式ドキュメントの 「Transport Types」 のセクションで、内蔵のトランスポートクラスとそれぞれのパラメータについて必要な情報が網羅されています。

タスクからメールを送る

symfony のタスクからメールを送るのは、タスクシステムも getMailer() メソッドを提供していることから、アクションから送る場合とそっくりです。

mailer を生成するとき、タスクシステムは現在の設定に依存します。つまり、特定のアプリケーションの設定を使いたければ、タスクは --application オプションを受け取らなければなりません (これについてもっと情報が必要であれば、タスクの章を読んでください)。

タスクはコントローラと同じ設定を使うことにご注意ください。すなわち、spool 戦略を使ってるときに配信を強制したいなら、sendNextImmediately() を呼ぶ必要があるということです:

$this->getMailer()->sendNextImmediately()->send($message);

デバッグ

昔から、メールのデバッグは悪夢でした。symfony では、Web デバッグツールバーのおかげで、非常に簡単です。

ブラウザだけを使って、現在のアクションから送信されたメッセージが何通あったかをすぐ簡単に確認することができるのです:

メールアイコンをクリックすると、送信されたメッセージがパネルのなかに、次のような形式で表示されます。

メールが送られるたびに、symfony はログにもメッセージを追加します。

テスト

もちろん、メールをテストする方法抜きに、統合は完成したとは言えませんね。

デフォルトでは、symfony は機能テストを支援するための mailer テスター (sfMailerTester) を登録します。

hasSent() メソッドは現在のリクエストで何通のメッセージが送られたかをテストします:

$browser->
  get('/foo')->
  with('mailer')->
    hasSent(1)
;

上のコードでは、URL の /foo へアクセスしたときにメールが一通だけ送信されることを確認します。

送られるそれぞれのメールは、checkHeader() と checkBody() メソッドを使うことで、さらに細かくテストできます:

$browser->
  get('/foo')->
  with('mailer')->begin()->
    hasSent(1)->
    checkHeader('Subject', '/Subject/')->
    checkBody('/Body/')->
  end()
;

checkHeader() メソッドの第2引数と checkBody() の第1引数は、以下のうちどれかになります:

• 完全に一致する文字列

• チェックのための正規表現

• マッチしないことをチェックするための否定の正規表現 (!で始まる正規表現)

デフォルトでは、チェックは最初に送られたメッセージに対して行われます。

もし複数のメッセージが送られるなら、withMessage() メソッドでどのメッセージをテストしたいかを指定できます:

$browser->
  get('/foo')->
  with('mailer')->begin()->
    hasSent(2)->
    withMessage('foo@example.com')->
    checkHeader('Subject', '/Subject/')->
    checkBody('/Body/')->
  end()
;

withMessage() は受信者のアドレスを第1引数にとります。また、複数のメールが同じ宛先に送られる場合には、第2引数にそのうち何番目のメッセージかを指定することもできます。

そして、テストが失敗した際に送信されたメッセージをダンプする debug() も重要です:

$browser->
  get('/foo')->
  with('mailer')->
  debug()
;

クラスとしてのメールメッセージ

この章の最初に、アクションからメールを送る方法を学びました。それはたぶん、symfony アプリケーションからメールを送る一番単純な方法で、2、3通の単純なメッセージを送る場合にはベストな方法でしょう。

しかし、アプリケーションが大量の異なるメールを送信しなければならないとしたら、おそらく異なる戦略をとる必要があるでしょう。

メールメッセージにクラスを使うことのオマケとして、たとえば frontend と backend などでそのメッセージをほかのアプリケーションでも使いまわせるという利点があります。

メッセージは単純な PHP オブジェクトなので、メッセージ群を組織化する明らかな方法はそれぞれについてクラスを1つ作ることです:

// lib/email/ProjectConfirmationMessage.class.php
class ProjectConfirmationMessage extends Swift_Message
{
  public function __construct()
  {
    parent::__construct('Subject', 'Body');
 
    $this
      ->setFrom(array('app@example.com' => 'My App Bot'))
      ->attach('...')
    ;
  }
}

アクションから、あるいはそれが必要などこかからメッセージを送るというのは、単に適切なメッセージクラスをインスタンス化するということになります:

$this->getMailer()->send(new ProjectConfirmationMessage());

もちろん、基底クラスを作って From ヘッダーなど共通のヘッダーを集約したり、共通の署名をつけたりするのが便利でしょう:

// lib/email/ProjectConfirmationMessage.class.php
class ProjectConfirmationMessage extends ProjectBaseMessage
{
  public function __construct()
  {
    parent::__construct('Subject', 'Body');
 
    // 特定のヘッダーやアタッチメントなどを追加
    $this->attach('...');
  }
}
 
// lib/email/ProjectBaseMessage.class.php
class ProjectBaseMessage extends Swift_Message
{
  public function __construct($subject, $body)
  {
    $body .= <<<EOF
--

Email sent by My App Bot
EOF
    ;
    parent::__construct($subject, $body);
 
    // 共通のヘッダーを設定
    $this->setFrom(array('app@example.com' => 'My App Bot'));
  }
}

もしメッセージがいくつかのモデルオブジェクトに依存しているなら、もちろんコンストラクタに引数として渡せます:

// lib/email/ProjectConfirmationMessage.class.php
class ProjectConfirmationMessage extends ProjectBaseMessage
{
  public function __construct($user)
  {
    parent::__construct('Confirmation for '.$user->getName(), 'Body');
  }
}

レシピ

Gmail からメールを送る

SMTP サーバーはないけれど Gmail のアカウントがある場合、以下のような設定を使えば Google のサーバーからメールを送ったりアーカイブしたりできます:

transport:
  class: Swift_SmtpTransport
  param:
    host:       smtp.gmail.com
    port:       465
    encryption: ssl
    username:   あなたの Gmail ユーザー名
    password:   あなたの Gmail パスワード

username と password をあなた自身のものに変えるだけで動きます。

mailer オブジェクトのカスタマイズ

mailer を設定ファイル factories.yml で設定するだけでは不十分な場合、mailer.configure イベントをリスニングすることで mailer をさらにカスタマイズできます。

このイベントに接続して mailer を変更するには、ProjectConfiguration クラスのなかで以下のように書きます:

class ProjectConfiguration extends sfProjectConfiguration
{
  public function setup()
  {
    // ...
 
    $this->dispatcher->connect(
      'mailer.configure',
      array($this, 'configureMailer')
    );
  }
 
  public function configureMailer(sfEvent $event)
  {
    $mailer = $event->getSubject();
 
    // mailerに対して何かをする
  }
}

次の節では、このテクニックを使ったパワフルな手法を紹介します。

Swift Mailer プラグインを使う

Swift Mailer プラグインを使うには、mailer.configure イベントをリスニングします (前節を参照):

public function configureMailer(sfEvent $event)
{
  $mailer = $event->getSubject();
 
  $plugin = new Swift_Plugins_ThrottlerPlugin(
    100, Swift_Plugins_ThrottlerPlugin::MESSAGES_PER_MINUTE
  );
 
  $mailer->registerPlugin($plugin);
}

Swift Mailer 公式ドキュメントの「プラグイン」の節に、最初から提供されているプラグインの情報がすべて載っています。

スプールの挙動をカスタマイズする

内蔵のスプールの実装は非常に単純なものです。それぞれのスプールはキューからランダムな順序ですべてのメールを取ってきて、送信します。

メールを送信する際の経過時間に上限 (秒) を指定することや、送信するメッセージ数の上限を指定することができます:

$spool = $mailer->getSpool();
 
$spool->setMessageLimit(10);
$spool->setTimeLimit(10);

この節では、キューに優先順位を実装する方法について学びます。これを読めば、あなた自身のロジックを実装するために必要なすべての情報が得られるでしょう。

まず、DB スキーマに priority カラムを追加します:

# Propel 用
mail_message:
  message:    { type: clob, required: true }
  created_at: ~
  priority:   { type: integer, default: 3 }
 
# Doctrine 用
MailMessage:
  actAs: { Timestampable: ~ }
  columns:
    message:  { type: clob, notnull: true }
    priority: { type: integer }

メールを送るとき、この優先順位ヘッダーを設定します (1が最優先):

$message = $this->getMailer()
  ->compose('john@doe.com', 'foo@example.com', 'Subject', 'Body')
  ->setPriority(1)
;
$this->getMailer()->send($message);

次に、デフォルトの setMessage() メソッドをオーバーライドして、MailMessage オブジェクトの優先順位を変更するようにします:

// Propel 用
class MailMessage extends BaseMailMessage
{
  public function setMessage($message)
  {
    $msg = unserialize($message);
    $this->setPriority($msg->getPriority());
 
    return parent::setMessage($message);
  }
}
 
// Doctrine 用
class MailMessage extends BaseMailMessage
{
  public function setMessage($message)
  {
    $msg = unserialize($message);
    $this->priority = $msg->getPriority();
 
    return $this->_set('message', $message);
  }
}

このメッセージがキューのなかでシリアライズされていることに注意してください。つまり優先順位の値を得るにはアンシリアライズする必要があります。

そして、メッセージ群を優先順位で並べるメソッドを作ります:

// Propel 用
class MailMessagePeer extends BaseMailMessagePeer
{
  static public function getSpooledMessages(Criteria $criteria)
  {
    $criteria->addAscendingOrderByColumn(self::PRIORITY);
 
    return self::doSelect($criteria);
  }
 
  // ...
}
 
// Doctrine 用
class MailMessageTable extends Doctrine_Table
{
  public function getSpooledMessages()
  {
    return $this->createQuery('m')
      ->orderBy('m.priority')
    ;
  }
 
  // ...
}

最後に、設定ファイルの factories.yml で、キューからメッセージを取得する際のメソッドをデフォルトからこのメソッドに変更します:

spool_arguments: [ MailMessage, message, getSpooledMessages ]

これですべてです。

project:send-emails タスクを実行するたびに、それぞれのメールは優先順位にしたがって送信されるでしょう。

スプールをどんな条件でもうけつけるようにカスタマイズする

上の例では、標準のメッセージヘッダー priority (優先順位) を使いました。

しかし、もし任意の条件を使いたいとか、送信されるメッセージのヘッダーを書き換えたくないとかいう場合は、その条件をカスタムヘッダーに格納し、実際にメールが送信される直前にそれを取り除くということもできます。まず、送信されるメッセージにカスタムヘッダーを追加します:

public function executeIndex()
{
  $message = $this->getMailer()
    ->compose('john@doe.com', 'foo@example.com', 'Subject', 'Body')
  ;
 
  $message->getHeaders()->addTextHeader('X-Queue-Criteria', 'foo');
 
  $this->getMailer()->send($message);
}

続いて、キューにメッセージを格納するときにこのヘッダーから値を得、すぐにそのヘッダーを除去します:

public function setMessage($message)
{
  $msg = unserialize($message);
 
  $headers = $msg->getHeaders();
  $criteria = $headers->get('X-Queue-Criteria')->getFieldBody();
  $this->setCriteria($criteria);
  $headers->remove('X-Queue-Criteria');
 
  return parent::_set('message', serialize($msg));
}