Browse Source

Fixed reference to mailer application component in docs

The application component is named "mailer" by default, not "mail".
tags/2.0.16.1
Carsten Brandt 6 years ago
parent
commit
fbadefecae
No known key found for this signature in database
GPG Key ID: BE4F41DE1DEEEED0
  1. 6
      framework/mail/BaseMessage.php
  2. 2
      framework/mail/MessageInterface.php

6
framework/mail/BaseMessage.php

@ -14,8 +14,8 @@ use yii\base\ErrorHandler;
/** /**
* BaseMessage serves as a base class that implements the [[send()]] method required by [[MessageInterface]]. * BaseMessage serves as a base class that implements the [[send()]] method required by [[MessageInterface]].
* *
* By default, [[send()]] will use the "mail" application component to send the current message. * By default, [[send()]] will use the "mailer" application component to send the current message.
* The "mail" application component should be a mailer instance implementing [[MailerInterface]]. * The "mailer" application component should be a mailer instance implementing [[MailerInterface]].
* *
* @see BaseMailer * @see BaseMailer
* *
@ -35,7 +35,7 @@ abstract class BaseMessage extends BaseObject implements MessageInterface
* Sends this email message. * Sends this email message.
* @param MailerInterface $mailer the mailer that should be used to send this message. * @param MailerInterface $mailer the mailer that should be used to send this message.
* If no mailer is given it will first check if [[mailer]] is set and if not, * If no mailer is given it will first check if [[mailer]] is set and if not,
* the "mail" application component will be used instead. * the "mailer" application component will be used instead.
* @return bool whether this message is sent successfully. * @return bool whether this message is sent successfully.
*/ */
public function send(MailerInterface $mailer = null) public function send(MailerInterface $mailer = null)

2
framework/mail/MessageInterface.php

@ -205,7 +205,7 @@ interface MessageInterface
/** /**
* Sends this email message. * Sends this email message.
* @param MailerInterface $mailer the mailer that should be used to send this message. * @param MailerInterface $mailer the mailer that should be used to send this message.
* If null, the "mail" application component will be used instead. * If null, the "mailer" application component will be used instead.
* @return bool whether this message is sent successfully. * @return bool whether this message is sent successfully.
*/ */
public function send(MailerInterface $mailer = null); public function send(MailerInterface $mailer = null);

Loading…
Cancel
Save