イントロダクションIntroduction
Laravelは人気の高いSwiftMailerライブラリーのクリーンでシンプルなAPIを提供しています。SMTP、Mailgun、SparkPost、Amazon SES、PHPのmail
機能、sendmail
ドライバーを提供しており、選択したローカルやクラウドベースのサービスを使い、素早くメール送信が開始できるようにしています。Laravel provides a clean, simple API over the popular SwiftMailer[https://swiftmailer.symfony.com/] library with drivers for SMTP, Mailgun, SparkPost, Amazon SES, PHP's mail
function, and sendmail
, allowing you to quickly get started sending mail through a local or cloud based service of your choice.
ドライバの動作要件Driver Prerequisites
MailgunとSparkPostなどAPIベースドライバはシンプルでSMTPサーバよりも高速です。可能であれば、こうしたドライバを使用しましょう。APIドライバはすべて、Guzzle HTTPライブラリを必要としますので、Composerパッケージマネージャでインストールしてください。The API based drivers such as Mailgun and SparkPost are often simpler and faster than SMTP servers. If possible, you should use one of these drivers. All of the API drivers require the Guzzle HTTP library, which may be installed via the Composer package manager:
composer require guzzlehttp/guzzle
MailgunドライバMailgun Driver
Mailgunドライバを使用する場合、最初にGuzzleをインストールしてください。それからconfig/mail.php
設定ファイル中のdriver
オプションをmailgun
に設定してください。次にconfig/services.php
設定ファイルが以下のオプションを含んでいるか確認してください。To use the Mailgun driver, first install Guzzle, then set the driver
option in your config/mail.php
configuration file to mailgun
. Next, verify that your config/services.php
configuration file contains the following options:
'mailgun' => [
'domain' => 'your-mailgun-domain',
'secret' => 'your-mailgun-key',
],
SparkPostドライバSparkPost Driver
SparkPostドライバを使用するには、最初にGuzzleをインストールし、次にconfig/mail.php
設定ファイル中のdriver
オプションをsparkpost
に設定してください。config/services.php
設定ファイルに以下のオプションが含まれているか確認してください。To use the SparkPost driver, first install Guzzle, then set the driver
option in your config/mail.php
configuration file to sparkpost
. Next, verify that your config/services.php
configuration file contains the following options:
'sparkpost' => [
'secret' => 'your-sparkpost-key',
],
SESドライバSES Driver
Amazon SESドライバを使う場合、Amazon AWS SDK for PHPをインストールしてください。composer.json
ファイルのrequire
セクションに以下の行を追加し、composer update
コマンドを実行します。To use the Amazon SES driver you must first install the Amazon AWS SDK for PHP. You may install this library by adding the following line to your composer.json
file's require
section and running the composer update
command:
"aws/aws-sdk-php": "~3.0"
次にconfig/mail.php
設定ファイルのdriver
オプションをses
に設定します。それからconfig/services.php
設定ファイルが以下の内容になっているか確認してください。Next, set the driver
option in your config/mail.php
configuration file to ses
and verify that your config/services.php
configuration file contains the following options:
'ses' => [
'key' => 'your-ses-key',
'secret' => 'your-ses-secret',
'region' => 'ses-region', // e.g. us-east-1
],
Mailable概論Generating Mailables
Laravelではアプリケーションが送信する、各種メールタイプを"mailable"クラスとして表します。これらのクラスは、app/Mail
ディレクトリに保存します。アプリケーションにこのディレクトリが存在していなくても、心配ありません。make:mail
コマンドを使用して、最初にmailableクラスを生成する時に、作成されます。In Laravel, each type of email sent by your application is represented as a "mailable" class. These classes are stored in the app/Mail
directory. Don't worry if you don't see this directory in your application, since it will be generated for you when you create your first mailable class using the make:mail
command:
php artisan make:mail OrderShipped
MailableプログラミングWriting Mailables
全mailableクラスの設定は、build
メソッド中で行います。このメソッド中でメールのプレゼンテーションとデリバリーを設定する、from
、subject
、view
、attach
など様々なメソッドを呼び出します。All of a mailable class' configuration is done in the build
method. Within this method, you may call various methods such as from
, subject
, view
, and attach
to configure the email's presentation and delivery.
Senderの設定Configuring The Sender
from
メソッドの使用Using The from
Method
最初に、メールの送信者の設定を見てみましょう。言い換えれば、"from"により、メールを送信する人を指定します。送信者の設定には2つの方法があります。最初にmailableクラスのbuild
メソッドの中で、from
メソッドを使う方法です。First, let's explore configuring the sender of the email. Or, in other words, who the email is going to be "from". There are two ways to configure the sender. First, you may use the from
method within your mailable class' build
method:
/**
* メッセージの生成
*
* @return $this
*/
public function build()
{
return $this->from('example@example.com')
->view('emails.orders.shipped');
}
グローバルfrom
アドレスの使用Using A Global from
Address
もし、アプリケーションで同じ"from"アドレスを全メールで使用するのであれば、生成する全mailableクラスでfrom
メソッドを呼び出すのは面倒です。代わりに、グローバルな"from"アドレスをconfig/mail.php
設定ファイルで指定しましょう。このアドレスは、mailableクラスの中で、"from"アドレスが指定されなかった場合に使用されます。However, if your application uses the same "from" address for all of its emails, it can become cumbersome to call the from
method in each mailable class you generate. Instead, you may specify a global "from" address in your config/mail.php
configuration file. This address will be used if no other "from" address is specified within the mailable class:
'from' => ['address' => 'example@example.com', 'name' => 'App Name'],
ビューの設定Configuring The View
mailableクラスのbuild
メソッドの中で、メールの中身をレンダーする時に使用するテンプレートをview
メソッドにより指定できます。各メールでは内容をレンダーするのにBlade テンプレートを通常使用しますので、メールのHTMLを構築する時にBladeテンプレートエンジンのパワーと利便性をフルに利用できます。Within a mailable class' build
method, you may use the view
method to specify which template should be used when rendering the email's contents. Since each email typically uses a Blade template[/docs/{{version}}/blade] to render its contents, you have the full power and convenience of the Blade templating engine when building your email's HTML:
/**
* メッセージの生成
*
* @return $this
*/
public function build()
{
return $this->view('emails.orders.shipped');
}
">Tip!! メール用テンプレートをすべて設置する、
resources/views/emails
ディレクトリを作成することができます。しかし、resources/views
ディレクトリの中であれば、好きな場所へ自由に設置できます。{tip} You may wish to create aresources/views/emails
directory to house all of your email templates; however, you are free to place them wherever you wish within yourresources/views
directory.
平文テキストメールPlain Text Emails
平文テキスト版のメールを定義したいときは、text
メソッドを使います。view
メソッドと同様に、text
メソッドは、メールの内容をレンダーするために使用する、テンプレート名を引数に取ります。メッセージのHTML版と平文テキスト版の両方を定義することも可能です。If you would like to define a plain-text version of your email, you may use the text
method. Like the view
method, the text
method accepts a template name which will be used to render the contents of the email. You are free to define both a HTML and plain-text version of your message:
/**
* メッセージの生成
*
* @return $this
*/
public function build()
{
return $this->view('emails.orders.shipped')
->text('emails.orders.shipped_plain');
}
ビューデータView Data
publicプロパティ使用Via Public Properties
通常、メールのHTMLをレンダーする時には、ビューへ使用するデータを渡します。ビューでデータを使用できるようにするには、2つの方法があります。まず、mailableクラスで定義したpublicプロパティは、ビューで自動的に利用できます。そのため、たとえばmailableクラスのコンストラクタへデータを渡し、そのデータをクラス上のプロパティとして定義できます。Typically, you will want to pass some data to your view that you can utilize when rendering the email's HTML. There are two ways you may make data available to your view. First, any public property defined on your mailable class will automatically be made available to the view. So, for example, you may pass data into your mailable class' constructor and set that data to public properties defined on the class:
<?php
namespace App\Mail;
use App\Order;
use Illuminate\Bus\Queueable;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;
class OrderShipped extends Mailable
{
use Queueable, SerializesModels;
/**
* 注文インスタンス
*
* @var Order
*/
public $order;
/**
* 新しいメッセージインスタンスの生成
*
* @return void
*/
public function __construct(Order $order)
{
$this->order = $order;
}
/**
* メッセージの生成
*
* @return $this
*/
public function build()
{
return $this->view('emails.orders.shipped');
}
}
データをpublicプロパティにセットしたら、自動的にビューで使用できるようになり、Bladeテンプレート中で、他のデータと同様にアクセスできます。Once the data has been set to a public property, it will automatically be available in your view, so you may access it like you would access any other data in your Blade templates:
<div>
Price: {{ $order->price }}
</div>
with
メソッド使用Via The with
Method:
メールのデータフォーマットをテンプレートへ渡す前にカスタマイズしたい場合は、with
メソッドを使いデータをビューへ渡すことができます。通常、この場合もデータをmailableクラスのコンストラクタで渡すことになるでしょう。しかし、自動的にテンプレートで使用可能にならないように、protected
かprivate
プロパティへデータをセットしてください。それから、テンプレートで使用したいデータの配列を引数として、with
メソッドを呼び出してください。If you would like to customize the format of your email's data before it is sent to the template, you may manually pass your data to the view via the with
method. Typically, you will still pass data via the mailable class' constructor; however, you should set this data to protected
or private
properties so the data is not automatically made available to the template. Then, when calling the with
method, pass an array of data that you wish to make available to the template:
<?php
namespace App\Mail;
use App\Order;
use Illuminate\Bus\Queueable;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;
class OrderShipped extends Mailable
{
use Queueable, SerializesModels;
/**
* 注文インスタンス
*
* @var Order
*/
protected $order;
/**
* 新しいメッセージインスタンスの生成
*
* @return void
*/
public function __construct(Order $order)
{
$this->order = $order;
}
/**
* メッセージの生成
*
* @return $this
*/
public function build()
{
return $this->view('emails.orders.shipped')
->with([
'orderName' => $this->order->name,
'orderPrice' => $this->order->price,
]);
}
}
with
メソッドへ渡したデータは、ビューで自動的に使用可能になり、Bladeテンプレートの他のデータと同様にアクセスできます。Once the data has been passed to the with
method, it will automatically be available in your view, so you may access it like you would access any other data in your Blade templates:
<div>
Price: {{ $orderPrice }}
</div>
添付Attachments
メールへ添付するには、attach
メソッドをmailableクラスのbuild
メソッド中で呼び出します。attach
メソッドは最初の引数に、ファイルのフルパスを取ります。To add attachments to an email, use the attach
method within the mailable class' build
method. The attach
method accepts the full path to the file as its first argument:
/**
* メッセージの生成
*
* @return $this
*/
public function build()
{
return $this->view('emails.orders.shipped')
->attach('/path/to/file');
}
ファイルをメッセージ添付する場合、attach
メソッドの第2引数として配列を渡し、表示名やMIMEタイプを指定することもできます。When attaching files to a message, you may also specify the display name and / or MIME type by passing an array
as the second argument to the attach
method:
/**
* メッセージの生成
*
* @return $this
*/
public function build()
{
return $this->view('emails.orders.shipped')
->attach('/path/to/file', [
'as' => 'name.pdf',
'mime' => 'application/pdf',
]);
}
Rawデータ添付Raw Data Attachments
attachData
メソッドは添付内容のバイト文字列をそのまま添付する場合に使用します。たとえば、メモリ中でPDFを生成し、それをディスクに書き出さずに、メールへ添付したい場合にこのメソッドを使用できます。attachData
メソッドはrawデータバイトを最初の引数に取り、ファイル名を第2引数に、オプションの配列を第3引数に取ります。The attachData
method may be used to attach a raw string of bytes as an attachment. For example, you might use this method if you have generated a PDF in memory and want to attach it to the email without writing it to disk. The attachData
method accepts the raw data bytes as its first argument, the name of the file as its second argument, and an array of options as its third argument:
/**
* メッセージの生成
*
* @return $this
*/
public function build()
{
return $this->view('emails.orders.shipped')
->attachData($this->pdf, 'name.pdf', [
'mime' => 'application/pdf',
]);
}
インライン添付Inline Attachments
インライン画像をメールに埋め込むのは、通常手間がかかります。しかし、Laravelは画像をメールに付け、最適なCIDを得る便利な方法を提供しています。インラインイメージを埋め込むには、メールビューの中で$message
変数のembed
メソッドを使ってください。Laravelでは全メールテンプレートで、$message
変数が使用できるようになっていますので、この変数を渡すことについては心配する必要はありません。Embedding inline images into your emails is typically cumbersome; however, Laravel provides a convenient way to attach images to your emails and retrieving the appropriate CID. To embed an inline image, use the embed
method on the $message
variable within your email template. Laravel automatically makes the $message
variable available to all of your email templates, so you don't need to worry about passing it in manually:
<body>
ここに画像:
<img src="{{ $message->embed($pathToFile) }}">
</body>
Note:
Markdownメッセージでは、$message
変数は使用できません。{note}$message
variable is not available in markdown messages.
添付Rawデータの埋め込みEmbedding Raw Data Attachments
メールテンプレートへ埋め込むrawデータ文字列を既に用意してある場合は、$message
変数のembedData
メソッドを使ってください。If you already have a raw data string you wish to embed into an email template, you may use the embedData
method on the $message
variable:
<body>
ここにrawデータからの画像:
<img src="{{ $message->embedData($data, $name) }}">
</body>
SwiftMailerメッセージのカスタマイズCustomizing The SwiftMailer Message
Mailable
ベースクラスのwithSwiftMessage
クラスにより、メッセージ送信前にSwiftMailerメッセージインスタンスを直接呼び出すコールバクを登録できます。これにより配信する前に、メッセージを送信する機会を得られます。The withSwiftMessage
method of the Mailable
base class allows you to register a callback which will be invoked with the raw SwiftMailer message instance before sending the message. This gives you an opportunity to customize the message before it is delivered:
/**
* メッセージの生成
*
* @return $this
*/
public function build()
{
$this->view('emails.orders.shipped');
$this->withSwiftMessage(function ($message) {
$message->getHeaders()
->addTextHeader('Custom-Header', 'HeaderValue');
});
}
Markdown MailableMarkdown Mailables
Markdown mailableメッセージにより、事前に構築したテンプレートとメール通知のコンポーネントの利点をMailable中で利用できます。メッセージをMarkdownで記述すると、Laravelは美しいレスポンシブHTMLテンプレートをレンダーすると同時に、自動的に平文テキスト版も生成します。Markdown mailable messages allow you to take advantage of the pre-built templates and components of mail notifications in your mailables. Since the messages are written in Markdown, Laravel is able to render beautiful, responsive HTML templates for the messages while also automatically generating a plain-text counterpart.
Markdown Mailableの生成Generating Markdown Mailables
対応するMarkdownテンプレートを指定し、Mailableを生成するには、make:mail
Artisanコマンドを--markdown
オプション付きで使用します。To generate a mailable with a corresponding Markdown template, you may use the --markdown
option of the make:mail
Artisan command:
php artisan make:mail OrderShipped --markdown=emails.orders.shipped
次に、build
メソッド内で、Mailableを設定します。view
メソッドの代わりに、markdown
メソッドを呼び出します。markdown
メソッドはMarkdownテンプレートの名前とテンプレートで使用するデータの配列を引数に取ります。Then, when configuring the mailable within its build
method, call the markdown
method instead of the view
method. The markdown
methods accepts the name of the Markdown template and an optional array of data to make available to the template:
/**
* メッセージの生成
*
* @return $this
*/
public function build()
{
return $this->from('example@example.com')
->markdown('emails.orders.shipped');
}
Markdown Messageの記述Writing Markdown Messages
Markdown MailableではBladeコンポーネントとMarkdown記法が利用でき、メールメッセージを簡単に構築できると同時に、Laravelが用意しているコンポーネントも活用できます。Markdown mailables use a combination of Blade components and Markdown syntax which allow you to easily construct mail messages while leveraging Laravel's pre-crafted components:
@component('mail::message')
# 発送のお知らせ
商品が発送されました!
@component('mail::button', ['url' => $url])
注文の確認
@endcomponent
ありがとうございました。<br>
{{ config('app.name') }} 様
@endcomponent
{tip} Do not use excess indentation when writing Markdown emails. Markdown parsers will render indented content as code blocks.
">Tip!! Markdownメールを書く場合は、過剰なインデントを付けないでください。Markdownは段付をコードブロックとしてパースします。
ButtonコンポーネントButton Component
ボタンコンポーネントは中央寄せのボタンリンクをレンダーします。このコンポーネントは引数として、url
とオプションのcolor
を受け取ります。サポートしている色はblue
、green
、red
です。メッセージに好きなだけのボタンコンポーネントを追加できます。The button component renders a centered button link. The component accepts two arguments, a url
and an optional color
. Supported colors are blue
, green
, and red
. You may add as many button components to a message as you wish:
@component('mail::button', ['url' => $url, 'color' => 'green'])
注文の確認
@endcomponent
PanelコンポーネントPanel Component
パネルコンポーネントは、メッセージの他の部分とは少し異なった背景色のパネルの中に、指定されたテキストブロックをレンダーします。これにより、指定するテキストに注目を集められます。The panel component renders the given block of text in a panel that has a slightly different background color than the rest of the message. This allows you to draw attention to a given block of text:
@component('mail::panel')
ここはパネルの内容です。
@endcomponent
TableコンポーネントTable Component
テーブルコンポーネントは、MarkdownテーブルをHTMLテーブルへ変換します。このコンポーネントはMarkdownテーブルを内容として受け入れます。デフォルトのMarkdownテーブルの記法を使った、文字寄せをサポートしています。The table component allows you to transform a Markdown table into an HTML table. The component accepts the Markdown table as its content. Table column alignment is supported using the default Markdown table alignment syntax:
@component('mail::table')
| Laravel | テーブル | 例 |
| ------------- |:-------------:| --------:|
| Col 2 is | 中央寄せ | $10 |
| Col 3 is | 右寄せ | $20 |
@endcomponent
コンポーネントのカスタマイズCustomizing The Components
自身のアプリケーション向きにカスタマイズできるように、Markdownメールコンポーネントは全てエクスポートできます。コンポーネントをエクスポートするには、vendor:publish
Artisanコマンドを使い、laravel-mail
アセットを公開します。You may export all of the Markdown mail components to your own application for customization. To export the components, use the vendor:publish
Artisan command to publish the laravel-mail
asset tag:
php artisan vendor:publish --tag=laravel-mail
ディレクトリ下に、html
とmarkdown
ディレクトリがあります。各ディレクトリは名前が示す形式で、利用できるコンポーネント全てのレスポンシブなプレゼンテーションを持っています。html
ディレクトリ下のコンポーネントはHTMLバージョンのメールを生成するために使用され、markdown
ディレクトリ下のコンポーネントは平文テキストバージョンを生成するために使用されます。これらのコンポーネントはお好きなように自由にカスタマイズしてください。This command will publish the Markdown mail components to the resources/views/vendor/mail
directory. The mail
directory will contain a html
and a markdown
directory, each containing their respective representations of every available component. The components in the html
directory are used to generate the HTML version of your email, and their counterparts in the markdown
directory are used to generate the plain-text version. You are free to customize these components however you like.
CSSのカスタマイズCustomizing The CSS
コンポーネントをエクスポートすると、resources/views/vendor/mail/html/themes
ディレクトリに、default.css
ファイルが用意されます。このファイル中のCSSをカスタマイズすれば、Markdownメールメッセージ変換後のHTML形式の中に、インラインCSSとして自動的に取り込まれます。After exporting the components, the resources/views/vendor/mail/html/themes
directory will contain a default.css
file. You may customize the CSS in this file and your styles will automatically be in-lined within the HTML representations of your Markdown mail messages.
">Tip!! Markdownコンポーネント全体の新しいテーマを作成したい場合は、
html/themes
の中に新しいCSSファイルを記述し、theme
オプションを変更します。{tip} If you would like to build an entirely new theme for the Markdown components, write a new CSS file within thehtml/themes
directory and change thetheme
option of your
ブラウザでのMailableプレビューPreviewing Mailables In The Browser
mailableのテンプレートをデザインしているとき、Bladeテンプレートのようにブラウザでレンダし、簡単にレビューできると便利です。そのため、Laravelでは、ルートのクロージャやコントローラから直接mailableを返すことができます。mailableが返されるとレンダされ、ブラウザに表示されますので、実際のメールアドレスへ送る必要はなく、素早くレビューできます。When designing a mailable's template, it is convenient to quickly preview the rendered mailable in your browser like a typical Blade template. For this reason, Laravel allows you to return any mailable directly from a route Closure or controller. When a mailable is returned, it will be rendered and displayed in the browser, allowing you to quickly preview its design without needing to send it to an actual email address:
Route::get('/mailable', function () {
$invoice = App\Invoice::find(1);
return new App\Mail\InvoicePaid($invoice);
});
メール送信Sending Mail
メッセージを送信するには、Mail
ファサードのto
メソッドを使います。to
メソッドはメールアドレス、ユーザーインスタンス、もしくはユーザーのコレクションを引数に取ります。一つのオブジェクト、もしくはオブジェクトのコレクションを渡すと、メーラは自動的にそれらのemail
とname
プロパティを使用します。そのため、オブジェクトで、その属性を確実に使用可能にしてください。送信先を指定し終えたら、mailableクラスのインスタンスをsend
メソッドへ渡してください。To send a message, use the to
method on the Mail
facade[/docs/{{version}}/facades]. The to
method accepts an email address, a user instance, or a collection of users. If you pass an object or collection of objects, the mailer will automatically use their email
and name
properties when setting the email recipients, so make sure these attributes are available on your objects. Once you have specified your recipients, you may pass an instance of your mailable class to the send
method:
<?php
namespace App\Http\Controllers;
use App\Order;
use App\Mail\OrderShipped;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Mail;
use App\Http\Controllers\Controller;
class OrderController extends Controller
{
/**
* 注文の配送
*
* @param Request $request
* @param int $orderId
* @return Response
*/
public function ship(Request $request, $orderId)
{
$order = Order::findOrFail($orderId);
// 配送処理…
Mail::to($request->user())->send(new OrderShipped($order));
}
}
もちろん、メール送信時に"to"で受取人を指定するだけに限りません。"to"、"cc"、"bcc"による受取人をすべて一つのメソッドチェーンで呼び出せます。Of course, you are not limited to just specifying the "to" recipients when sending a message. You are free to set "to", "cc", and "bcc" recipients all within a single, chained method call:
Mail::to($request->user())
->cc($moreUsers)
->bcc($evenMoreUsers)
->send(new OrderShipped($order));
キュー使用メールQueueing Mail
メールメッセージのキューイングQueueing A Mail Message
メールメッセージを送ることにより、アプリケーションのレスポンス時間が極端に長くなり得るため、多くの開発者はメールメッセージをバックグランドで送信するためにキューイングすることを選びます。Laravelの統一されたキューAPIを使うことで、簡単に実現できます。メールメッセージをキューへ送るには、Mail
ファサードへ、受取人の指定の後に、queue
メソッドを使います。Since sending email messages can drastically lengthen the response time of your application, many developers choose to queue email messages for background sending. Laravel makes this easy using its built-in unified queue API[/docs/{{version}}/queues]. To queue a mail message, use the queue
method on the Mail
facade after specifying the message's recipients:
Mail::to($request->user())
->cc($moreUsers)
->bcc($evenMoreUsers)
->queue(new OrderShipped($order));
このメソッドはバックグラウンドでメールを送信するため、自動的にジョブをキューに投入する面倒を見ます。もちろん、この機能を使用する前にキューの設定を行う必要があります。This method will automatically take care of pushing a job onto the queue so the message is sent in the background. Of course, you will need to configure your queues[/docs/{{version}}/queues] before using this feature.
遅延メッセージキューDelayed Message Queueing
メッセージを投入するキューを指定したい場合、laterOn
メソッドを使用します。最初の引数に、later
メソッドは、メッセージを送信する時間を示すDateTime
インスタンスを受け取ります。If you wish to delay the delivery of a queued email message, you may use the later
method. As its first argument, the later
method accepts a DateTime
instance indicating when the message should be sent:
$when = now()->addMinutes(10);
Mail::to($request->user())
->cc($moreUsers)
->bcc($evenMoreUsers)
->later($when, new OrderShipped($order));
特定のキューに投入Pushing To Specific Queues
make:mail
コマンドにより生成されたmailableクラスにはすべて、Illuminate\Bus\Queueable
トレイトが使用されています。接続とキュー名を指定する、onQueue
とonConnection
メソッドをすべてのmailableクラスインスタンスで呼び出せます。Since all mailable classes generated using the make:mail
command make use of the Illuminate\Bus\Queueable
trait, you may call the onQueue
and onConnection
methods on any mailable class instance, allowing you to specify the connection and queue name for the message:
$message = (new OrderShipped($order))
->onConnection('sqs')
->onQueue('emails');
Mail::to($request->user())
->cc($moreUsers)
->bcc($evenMoreUsers)
->queue($message);
デフォルトとしてキュー投入Queueing By Default
いつもMailableクラスをキューへ投入したければ、クラスへShouldQueue
契約を実装してください。それで、メール送信時にsend
メソッドを呼びだせば、そのMailableクラスは契約が実装されていますので、いつもキューイングされます。If you have mailable classes that you want to always be queued, you may implement the ShouldQueue
contract on the class. Now, even if you call the send
method when mailing, the mailable will still be queued since it implements the contract:
use Illuminate\Contracts\Queue\ShouldQueue;
class OrderShipped extends Mailable implements ShouldQueue
{
//
}
メールとローカル開発Mail & Local Development
メールを送信するアプリケーションを開発している間は、実際のメールアドレスにメールを送信したくはありません。Laravelはメールメッセージを実際に送信することをローカルでの開発期間の間、「無効」にする様々な方法を用意しています。When developing an application that sends email, you probably don't want to actually send emails to live email addresses. Laravel provides several ways to "disable" the actual sending of emails during local development.
LogドライバLog Driver
メールを送信する代わりに、log
メールドライバで、すべてのメールメッセージを確認のためにログファイルへ書き込こめます。アプリケーションの設定に関する詳細は、設定のドキュメントを確認してください。Instead of sending your emails, the log
mail driver will write all email messages to your log files for inspection. For more information on configuring your application per environment, check out the configuration documentation[/docs/{{version}}/configuration#environment-configuration].
全メールの送信先指定Universal To
Laravelが提供するもう一つの解決策は、フレームワークが送信する全メールの共通受け取り先を設定する方法です。この方法を使うと送信メッセージに指定した実際のアドレスの代わりに、アプリケーションが送る全メールを特定のアドレスに送信します。この方法を使用する場合、config/mail.php
設定ファイルでto
オプションを指定します。Another solution provided by Laravel is to set a universal recipient of all emails sent by the framework. This way, all the emails generated by your application will be sent to a specific address, instead of the address actually specified when sending the message. This can be done via the to
option in your config/mail.php
configuration file:
'to' => [
'address' => 'example@example.com',
'name' => 'Example'
],
MailtrapMailtrap
最後の方法はMailtrapのようなサービスを使い、smtp
ドライバで本当のメールクライアントにより内容を確認できる「ダミー」のメールボックスへメールメッセージを送る方法です。このアプローチの利点は最終的なメールをMailtrapのメッセージビュアーで実際に確認できることです。Finally, you may use a service like Mailtrap[https://mailtrap.io] and the smtp
driver to send your email messages to a "dummy" mailbox where you may view them in a true email client. This approach has the benefit of allowing you to actually inspect the final emails in Mailtrap's message viewer.
イベントEvents
Laravelはメールメッセージ送信の過程で、イベントを2つ発行します。MessageSending
イベントは、メッセージが送信される前に発行され、一方のMessageSent
イベントは、メッセージを送った後に発行されます。2つのイベントは、キューした時点でなく、メールが送信された時に発行されることを覚えておいてください。これらに対するイベントリスナは、EventServiceProvider
で定義できます。Laravel fires two events during the process of sending mail messages. The MessageSending
event is fired prior to a message being sent, while the MessageSent
event is fired after a message has been sent. Remember, these events are fired when the mail is being sent, not when it is queued. You may register an event listener for this event in your EventServiceProvider
:
/**
* アプリケーションへマッピングするイベントリスナ
*
* @var array
*/
protected $listen = [
'Illuminate\Mail\Events\MessageSending' => [
'App\Listeners\LogSendingMessage',
],
'Illuminate\Mail\Events\MessageSent' => [
'App\Listeners\LogSentMessage',
],
];