HumHub Documentation (unofficial)

EmailAddress extends AbstractValidator

in package

• Application

Table of Contents

Constants

DOT_ATOM  = 'emailAddressDotAtom'

INVALID  = 'emailAddressInvalid'

INVALID_FORMAT  = 'emailAddressInvalidFormat'

INVALID_HOSTNAME  = 'emailAddressInvalidHostname'

INVALID_LOCAL_PART  = 'emailAddressInvalidLocalPart'

INVALID_MX_RECORD  = 'emailAddressInvalidMxRecord'

INVALID_SEGMENT  = 'emailAddressInvalidSegment'

LENGTH_EXCEEDED  = 'emailAddressLengthExceeded'

QUOTED_STRING  = 'emailAddressQuotedString'

Properties

$messageTemplates  : array<string, string>

$messageVariables  : array<string, mixed>

$options  : array<string, mixed>

$abstractOptions  : AbstractOptions|array<string, mixed>

$defaultTranslator  : TranslatorInterface

Default translation object for all validate objects

$defaultTranslatorTextDomain  : string

Default text domain to be used with translator

$hostname  : string

$localPart  : string

$messageLength  : int

Limits the maximum returned length of an error message

$messageTemplates  : array<string, string>

$messageVariables  : array<string|int, mixed>

$mxRecord  : array<string|int, mixed>

Returns the found mx record information

$options  : array<string, mixed>

Internal options array

$value  : mixed

The value to be validated

Methods

__construct()  : mixed

Instantiates hostname validator for local use

__get()  : mixed

Magic function returns the value of the requested property, if and only if it is the value or a message variable.

__invoke()  : bool

Invoke as command

getAllow()  : int

Returns the allow option of the attached hostname validator

getDeepMxCheck()  : bool

Returns the set deepMxCheck option

getDefaultTranslator()  : TranslatorInterface|null

Get default translation object for all validate objects

getDefaultTranslatorTextDomain()  : string

Get default translation text domain for all validate objects

getDomainCheck()  : bool

Returns the set domainCheck option

getHostnameValidator()  : Hostname

Returns the set hostname validator

getMessageLength()  : int

Returns the maximum allowed message length

getMessages()  : array<string, string>

Returns array of validation failure messages

getMessageTemplates()  : array<string, string>

Returns the message templates from the validator

getMessageVariables()  : array<int, string>

Returns an array of the names of variables that are used in constructing validation failure messages

getMxCheck()  : bool

Returns the set validateMx option

getMXRecord()  : array<string|int, mixed>

Returns the found MX Record information after validation including weight for further processing

getOption()  : mixed

Returns an option

getOptions()  : array<string, mixed>

Returns all available options

getTranslator()  : TranslatorInterface|null

Return translation object

getTranslatorTextDomain()  : string

Return the translation text domain

hasDefaultTranslator()  : bool

Is there a default translation object set?

hasTranslator()  : bool

Does this validator have its own specific translator?

isMxSupported()  : bool

Whether MX checking via getmxrr is supported or not

isTranslatorEnabled()  : bool

Is translation enabled?

isValid()  : bool

Defined by Laminas\Validator\ValidatorInterface

isValueObscured()  : bool

Retrieve flag indicating whether or not value should be obfuscated in messages

setAllow()  : $this

Sets the allow option of the hostname validator to use

setDefaultTranslator()  : void

Set default translation object for all validate objects

setDefaultTranslatorTextDomain()  : void

Set default translation text domain for all validate objects

setHostnameValidator()  : $this

setMessage()  : AbstractValidator

Sets the validation failure message template for a particular key Adds the ability to set messages to the attached hostname validator

setMessageLength()  : void

Sets the maximum allowed message length

setMessages()  : $this

Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.

setOptions()  : $this

Sets one or multiple options

setTranslator()  : $this

Set translation object

setTranslatorEnabled()  : $this

Indicate whether or not translation should be enabled

setTranslatorTextDomain()  : $this

Set translation text domain

setValueObscured()  : $this

Set flag indicating whether or not value should be obfuscated in messages

useDeepMxCheck()  : $this

Use deep validation for MX records

useDomainCheck()  : $this

Sets if the domain should also be checked or only the local part of the email address

useMxCheck()  : $this

Set whether we check for a valid MX record via DNS

createMessage()  : null|string

Constructs and returns a validation failure message with the given message key and value.

error()  : void

getValue()  : mixed

Returns the validation value

idnToAscii()  : string

Safely convert UTF-8 encoded domain name to ASCII

idnToUtf8()  : string

Safely convert ASCII encoded domain name to UTF-8

isReserved()  : bool

Returns if the given host is reserved

setValue()  : void

Sets the value to be validated and clears the messages and errors arrays

splitEmailParts()  : bool

Splits the given value in hostname and local part of the email address

translateMessage()  : string

Translate a validation message

validateHostnamePart()  : bool|array<string|int, string>

Internal method to validate the hostname part of the email address

validateInternationalizedLocalPart()  : bool

validateLocalPart()  : bool

Internal method to validate the local part of the email address

validateMXRecords()  : bool|array<string|int, string>

Internal method to validate the servers MX records