Back to Joomla project (class list)

Class MailDisabledException - list of methods

Exception class defining an error for disabled mail functionality.
Package: Joomla\CMS\Mail\Exception
Copyright: (C) 2020 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Mail/Exception/MailDisabledException.php
Project: Joomla

Method Summary

public
(string $reason, string $message = '', int $code = 0, \Throwable $previous = null)

Constructor.
Parameters
  • string $reason The reason why mail is disabled.
  • string $message The Exception message to throw.
  • int $code The Exception code.
  • \Throwable $previous The previous exception used for the exception chaining.
Since
  • 4.0.0
Show source code of this method: __construct Source Code

public string
()

Method to return the reason why mail is disabled.
Returns
  • string
Since
  • 4.0.0
Show source code of this method: getReason Source Code

Properties Summary

private string
$reason
Reason mail is disabled.
Since
  • 4.0.0

Constants Summary

public string
$REASON_USER_DISABLED
Send Mail option is disabled by the user.
Since
  • 4.0.0
public string
$REASON_MAIL_FUNCTION_NOT_AVAILABLE
Mail() function is not available on the system.
Since
  • 4.0.0

Tags Summary

Since
4.0.0