MailDisabledException

Extends RuntimeException

Exception class defining an error for disabled mail functionality.

final
since

4.0.0

package

Joomla CMS

Methods

__construct

Constructor.

__construct( reason,  message = '',  code, \Throwable previous = null) : 
since

4.0.0

Arguments

reason

stringThe reason why mail is disabled.

message

stringThe Exception message to throw.

code

intThe Exception code.

previous

Throwable|nullThe previous exception used for the exception chaining.

Response

mixed

getReason

Method to return the reason why mail is disabled.

getReason() : 
since

4.0.0

Response

string

Constants

REASON_USER_DISABLED

Send Mail option is disabled by the user.

Value 'user_disabled'
since

4.0.0

Type(s)

string

REASON_MAIL_FUNCTION_NOT_AVAILABLE

Mail() function is not available on the system.

Value 'mail_function_not_available'
since

4.0.0

Type(s)

string

Properties

reason

Reason mail is disabled.

since

4.0.0

Type(s)

string