1. class
  2. Illuminate
  3. \
  4. Validation
  5. \
  6. Rules
  7. \
  8. Email

Email

class Email implements Rule, DataAwareRule, ValidatorAwareRule (View source)

Traits

Conditionable
Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
$validateMxRecord
$preventSpoofing
$nativeValidation
$nativeValidationWithUnicodeAllowed
$rfcCompliant
$strictRfcCompliant
protected Validator $validator

The validator performing the validation.
protected array $data

The data under validation.
protected array $customRules

An array of custom rules that will be merged into the validation rules.
protected array $messages

The error message after validation, if any.
static string|array|callable|null $defaultCallback

The callback that will generate the "default" version of the file rule.

Methods

$this|TWhenReturnType
when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

from  Conditionable
$this|TUnlessReturnType
unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

from  Conditionable
static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
static Email|void
defaults(Email|callable|null $callback = null)

Set the default callback to be used for determining the email default rules.

static Email
default()

Get the default configuration of the file rule.

$this
rfcCompliant(bool $strict = false)

Ensure that the email is an RFC compliant email address.

$this
strict()

Ensure that the email is a strictly enforced RFC compliant email address.

$this
validateMxRecord()

Ensure that the email address has a valid MX record.

$this
preventSpoofing()

Ensure that the email address is not attempting to spoof another email address using invalid unicode characters.

$this
withNativeValidation(bool $allowUnicode = false)

Ensure the email address is valid using PHP's native email validation functions.

$this
rules(string|array $rules)

Specify additional validation rules that should be merged with the default rules during validation.

bool
passes(string $attribute, mixed $value)

Determine if the validation rule passes.

array
buildValidationRules()

Build the array of underlying validation rules based on the current state.

string|array
message()

Get the validation error message.

$this
setValidator(Validator $validator)

Set the current validator.

$this
setData(array $data)

Set the current data under validation.

Details

in Conditionable at line 21
$this|TWhenReturnType when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TWhenReturnType

in Conditionable at line 53
$this|TUnlessReturnType unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TUnlessReturnType

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 68
static Email|void defaults(Email|callable|null $callback = null)

Set the default callback to be used for determining the email default rules.

If no arguments are passed, the default email rule configuration will be returned.

Parameters

Email|callable|null $callback

Return Value

Email|void

at line 86
static Email default()

Get the default configuration of the file rule.

Return Value

Email

at line 101
$this rfcCompliant(bool $strict = false)

Ensure that the email is an RFC compliant email address.

Parameters

bool $strict

Return Value

$this

at line 117
$this strict()

Ensure that the email is a strictly enforced RFC compliant email address.

Return Value

$this

at line 129
$this validateMxRecord()

Ensure that the email address has a valid MX record.

Requires the PHP intl extension.

Return Value

$this

at line 141
$this preventSpoofing()

Ensure that the email address is not attempting to spoof another email address using invalid unicode characters.

Return Value

$this

at line 154
$this withNativeValidation(bool $allowUnicode = false)

Ensure the email address is valid using PHP's native email validation functions.

Parameters

bool $allowUnicode

Return Value

$this

at line 171
$this rules(string|array $rules)

Specify additional validation rules that should be merged with the default rules during validation.

Parameters

string|array $rules

Return Value

$this

at line 185
bool passes(string $attribute, mixed $value)

Determine if the validation rule passes.

Parameters

string $attribute
mixed $value

Return Value

bool

at line 214
protected array buildValidationRules()

Build the array of underlying validation rules based on the current state.

Return Value

array

at line 256
string|array message()

Get the validation error message.

Return Value

string|array

at line 267
$this setValidator(Validator $validator)

Set the current validator.

Parameters

Validator $validator

Return Value

$this

at line 280
$this setData(array $data)

Set the current data under validation.

Parameters

array $data

Return Value

$this