diff --git a/docs/en/core-libraries/email.md b/docs/en/core-libraries/email.md index 8d26de55e8..5aca778ef2 100644 --- a/docs/en/core-libraries/email.md +++ b/docs/en/core-libraries/email.md @@ -103,39 +103,39 @@ Defining delivery profiles allows you to consolidate common email settings into re-usable profiles. Your application can have as many profiles as necessary. The following configuration keys are used: -- `'from'`: Mailer or array of sender. See `Mailer::setFrom()`. -- `'sender'`: Mailer or array of real sender. See `Mailer::setSender()`. -- `'to'`: Mailer or array of destination. See `Mailer::setTo()`. -- `'cc'`: Mailer or array of carbon copy. See `Mailer::setCc()`. -- `'bcc'`: Mailer or array of blind carbon copy. See `Mailer::setBcc()`. -- `'replyTo'`: Mailer or array to reply the e-mail. See `Mailer::setReplyTo()`. -- `'readReceipt'`: Mailer address or an array of addresses to receive the +- `from`: Mailer or array of sender. See `Mailer::setFrom()`. +- `sender`: Mailer or array of real sender. See `Mailer::setSender()`. +- `to`: Mailer or array of destination. See `Mailer::setTo()`. +- `cc`: Mailer or array of carbon copy. See `Mailer::setCc()`. +- `bcc`: Mailer or array of blind carbon copy. See `Mailer::setBcc()`. +- `replyTo`: Mailer or array to reply the e-mail. See `Mailer::setReplyTo()`. +- `readReceipt`: Mailer address or an array of addresses to receive the receipt of read. See `Mailer::setReadReceipt()`. -- `'returnPath'`: Mailer address or an array of addresses to return if have +- `returnPath`: Mailer address or an array of addresses to return if have some error. See `Mailer::setReturnPath()`. -- `'messageId'`: Message ID of e-mail. See `Mailer::setMessageId()`. -- `'subject'`: Subject of the message. See `Mailer::setSubject()`. -- `'message'`: Content of message. Do not set this field if you are using rendered content. -- `'priority'`: Priority of the email as numeric value (usually from 1 to 5 with 1 being the highest). -- `'headers'`: Headers to be included. See `Mailer::setHeaders()`. -- `'viewRenderer'`: If you are using rendered content, set the view classname. +- `messageId`: Message ID of e-mail. See `Mailer::setMessageId()`. +- `subject`: Subject of the message. See `Mailer::setSubject()`. +- `message`: Content of message. Do not set this field if you are using rendered content. +- `priority`: Priority of the email as numeric value (usually from 1 to 5 with 1 being the highest). +- `headers`: Headers to be included. See `Mailer::setHeaders()`. +- `viewRenderer`: If you are using rendered content, set the view classname. See `ViewBuilder::setClassName()`. -- `'template'`: If you are using rendered content, set the template name. See +- `template`: If you are using rendered content, set the template name. See `ViewBuilder::setTemplate()`. -- `'theme'`: Theme used when rendering template. See `ViewBuilder::setTheme()`. -- `'layout'`: If you are using rendered content, set the layout to render. See +- `theme`: Theme used when rendering template. See `ViewBuilder::setTheme()`. +- `layout`: If you are using rendered content, set the layout to render. See `ViewBuilder::setTemplate()`. -- `'autoLayout'`: If you want to render a template without layout, set this field to +- `autoLayout`: If you want to render a template without layout, set this field to `false`. See `ViewBuilder::disableAutoLayout()`. -- `'viewVars'`: If you are using rendered content, set the array with +- `viewVars`: If you are using rendered content, set the array with variables to be used in the view. See `Mailer::setViewVars()`. -- `'attachments'`: List of files to attach. See `Mailer::setAttachments()`. -- `'emailFormat'`: Format of email (html, text or both). See `Mailer::setEmailFormat()`. -- `'transport'`: Transport configuration name. See [Email Transport](#email-transport). -- `'log'`: Log level to log the email headers and message. `true` will use +- `attachments`: List of files to attach. See `Mailer::setAttachments()`. +- `emailFormat`: Format of email (html, text or both). See `Mailer::setEmailFormat()`. +- `transport`: Transport configuration name. See [Email Transport](#email-transport). +- `log`: Log level to log the email headers and message. `true` will use LOG_DEBUG. See [Logging Levels](../core-libraries/logging#logging-levels). Note that logs will be emitted under the scope named `email`. See also [Logging Scopes](../core-libraries/logging#logging-scopes). -- `'helpers'`: Array of helpers used in the email template. +- `helpers`: Array of helpers used in the email template. `ViewBuilder::setHelpers()`/`ViewBuilder::addHelpers()`. > [!NOTE] diff --git a/docs/ja/core-libraries/email.md b/docs/ja/core-libraries/email.md index 2f6be689ce..42542324cb 100644 --- a/docs/ja/core-libraries/email.md +++ b/docs/ja/core-libraries/email.md @@ -53,6 +53,8 @@ $mailer->setSender('app@example.com', 'MyApp emailer'); > 別の人の代わりにメール送信するときに送り主 (envelope sender) をセットするのは良い考えです。 > これは、配信失敗に関するメッセージの受信を防ぐことができます。 + + ## 設定 メーラーのプロファイルとメールのトランスポートは、アプリケーションの @@ -84,41 +86,43 @@ $mailer->setProfile(['from' => 'me@example.org', 'transport' => 'my_custom']); $mailer = new Mailer(['from' => 'me@example.org', 'transport' => 'my_custom']); ``` + + ### 設定プロファイル 配信プロファイルを定義すると、再利用可能なプロファイルに共通のメール設定を統合することができます。 アプリケーションは、必要な数のプロファイルを持つことができます。次の設定キーが使用されます。 -- `'from'`: 送信者のメールアドレスまたは配列。 `Mailer::setFrom()` を参照。 -- `'sender'`: 実際の送信者のメールアドレスまたは配列。 `Mailer::setSender()` を参照。 -- `'to'`: 宛先のメールアドレスまたは配列。 `Mailer::setTo()` を参照。 -- `'cc'`: CC のメールアドレスまたは配列。 `Mailer::setCc()` を参照。 -- `'bcc'`: BCC のメールアドレスまたは配列。 `Mailer::setCcc()` を参照。 -- `'replyTo'`: メールの返信先のメールアドレスまたは配列。 `Mailer::setReplyTo()` を参照。 -- `'readReceipt'`: 開封通知先メールアドレスまたはアドレスの配列。 `Mailer::setReadReceipt()` を参照。 -- `'returnPath'`: エラーの返信先メールアドレスまたはアドレスの配列。 `Mailer::setReturnPath()` を参照。 -- `'messageId'`: メールのメッセージID。 `Mailer::setMessageId()` を参照。 -- `'subject'`: メッセージのサブジェクト。 `Mailer::setSubject()` を参照。 -- `'message'`: メッセージ本文。レンダリングされた本文を使用する場合は、 この項目を設定しないでください。 -- `'priority'`: メールの優先度 (数値。通常は 1 から 5 で、1 が最高)。 -- `'headers'`: ヘッダー情報。 `Mailer::setHeaders()` を参照。 -- `'viewRender'`: レンダリングされた本文を使用する場合は、ビュークラス名をセット。 +- `from`: 送信者のメールアドレスまたは配列。 `Mailer::setFrom()` を参照。 +- `sender`: 実際の送信者のメールアドレスまたは配列。 `Mailer::setSender()` を参照。 +- `to`: 宛先のメールアドレスまたは配列。 `Mailer::setTo()` を参照。 +- `cc`: CC のメールアドレスまたは配列。 `Mailer::setCc()` を参照。 +- `bcc`: BCC のメールアドレスまたは配列。 `Mailer::setCcc()` を参照。 +- `replyTo`: メールの返信先のメールアドレスまたは配列。 `Mailer::setReplyTo()` を参照。 +- `readReceipt`: 開封通知先メールアドレスまたはアドレスの配列。 `Mailer::setReadReceipt()` を参照。 +- `returnPath`: エラーの返信先メールアドレスまたはアドレスの配列。 `Mailer::setReturnPath()` を参照。 +- `messageId`: メールのメッセージID。 `Mailer::setMessageId()` を参照。 +- `subject`: メッセージのサブジェクト。 `Mailer::setSubject()` を参照。 +- `message`: メッセージ本文。レンダリングされた本文を使用する場合は、 この項目を設定しないでください。 +- `priority`: メールの優先度 (数値。通常は 1 から 5 で、1 が最高)。 +- `headers`: ヘッダー情報。 `Mailer::setHeaders()` を参照。 +- `viewRender`: レンダリングされた本文を使用する場合は、ビュークラス名をセット。 `Mailer::viewRender()` を参照。 -- `'template'`: レンダリングされた本文を使用する場合は、テンプレート名をセット。 +- `template`: レンダリングされた本文を使用する場合は、テンプレート名をセット。 `ViewBuilder::setTemplate()` を参照。 -- `'theme'`: テンプレートをレンダリングする際のテーマ。 `ViewBuilder::setTheme()` を参照。 -- `'layout'`: レンダリングされた本文を使用する場合、描画するレイアウトをセット。 +- `theme`: テンプレートをレンダリングする際のテーマ。 `ViewBuilder::setTheme()` を参照。 +- `layout`: レンダリングされた本文を使用する場合、描画するレイアウトをセット。 レイアウトなしでテンプレートをレンダリングしたい場合は、このフィールドに null をセット。 `ViewBuilder::setTemplate()` を参照。 -- `'viewVars'`: レンダリングされた本文を使用する場合は、ビューで使用する変数の配列をセット。 +- `viewVars`: レンダリングされた本文を使用する場合は、ビューで使用する変数の配列をセット。 `Mailer::setViewVars()` を参照。 -- `'attachments'`: 添付ファイルの一覧。 `Mailer::setAttachments()` を参照。 -- `'emailFormat'`: メールの書式 (html, text または both) `Mailer::setEmailFormat()` を参照。 -- `'transport'`: トランスポート名。 トランスポート設定を参照。 -- `'log'`: メールヘッダーとメッセージをログに記録するログレベル。 +- `attachments`: 添付ファイルの一覧。 `Mailer::setAttachments()` を参照。 +- `emailFormat`: メールの書式 (html, text または both) `Mailer::setEmailFormat()` を参照。 +- `transport`: トランスポート名。 トランスポート設定を参照。 +- `log`: メールヘッダーとメッセージをログに記録するログレベル。 `true` なら LOG_DEBUG を使用します。 [Logging Levels](../core-libraries/logging#logging-levels) を参照。 ログはスコープ名 `email` で出力されることに注意してください。 [Logging Scopes](../core-libraries/logging#logging-scopes) を参照。 -- `'helpers'`: メールテンプレート内で使用するヘルパーの配列。 `ViewBuilder::setHelpers()` 。 +- `helpers`: メールテンプレート内で使用するヘルパーの配列。 `ViewBuilder::setHelpers()` 。 > [!NOTE] > メールアドレスや配列で使用する上記のキーの値 (from, to, cc 他)は、関連するメソッドの第一引数として