37 lines
931B

  1. <?php
  2. /**
  3. * @link http://www.yiiframework.com/
  4. * @copyright Copyright (c) 2008 Yii Software LLC
  5. * @license http://www.yiiframework.com/license/
  6. */
  7. namespace yii\mail;
  8. use yii\base\Event;
  9. /**
  10. * MailEvent represents the event parameter used for events triggered by [[BaseMailer]].
  11. *
  12. * By setting the [[isValid]] property, one may control whether to continue running the action.
  13. *
  14. * @author Mark Jebri <mark.github@yandex.ru>
  15. * @since 2.0
  16. */
  17. class MailEvent extends Event
  18. {
  19. /**
  20. * @var \yii\mail\MessageInterface the mail message being send.
  21. */
  22. public $message;
  23. /**
  24. * @var boolean if message was sent successfully.
  25. */
  26. public $isSuccessful;
  27. /**
  28. * @var boolean whether to continue sending an email. Event handlers of
  29. * [[\yii\mail\BaseMailer::EVENT_BEFORE_SEND]] may set this property to decide whether
  30. * to continue send or not.
  31. */
  32. public $isValid = true;
  33. }