MailEvent.php 844 B

1234567891011121314151617181920212223242526272829303132333435
  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\base;
  8. /**
  9. * ActionEvent represents the event parameter used for an action event.
  10. *
  11. * By setting the [[isValid]] property, one may control whether to continue running the action.
  12. *
  13. * @author Mark Jebri <[email protected]>
  14. * @since 2.0
  15. */
  16. class MailEvent extends Event
  17. {
  18. /**
  19. * @var \yii\mail\MessageInterface mail message being send
  20. */
  21. public $message;
  22. /**
  23. * @var boolean if message send was successful
  24. */
  25. public $isSuccessful;
  26. /**
  27. * @var boolean whether to continue sending an email. Event handlers of
  28. * [[\yii\mail\BaseMailer::EVENT_BEFORE_SEND]] may set this property to decide whether
  29. * to continue send or not.
  30. */
  31. public $isValid = true;
  32. }