Documentation >
Content management >
Field types >
Field type reference >
EmailAddress field type

EmailAddress field type¶

The EmailAddress field type represents an email address, in the form of a string.

Name	Internal name	Expected input type
`EmailAddress`	`ezemail`	`string`

PHP API field type¶

Value object¶

Properties¶

The Value class of this field type contains the following properties:

Property	Type	Description
`$email`	`string`	This property is used for the input string provided as email address.

// Value object content example

use Ibexa\Core\FieldType\EmailAddress\Type;

// Instantiates an EmailAddress Value object with default value (empty string)
$emailaddressValue = new Type\Value();

// Email definition
$emailaddressValue->email = "[email protected]";

Constructor¶

The EmailAddress\Value constructor initializes a new value object with the value provided. It accepts a string as input.

// Constructor example

use Ibexa\Core\FieldType\EmailAddress\Type;
 
// Instantiates an EmailAddress Value object
$emailaddressValue = new Type\Value( "[email protected]" );

String representation¶

String representation of the field type's value object is the email address contained in it.

Example: [email protected]

Hash format¶

Hash value for this field type's Value is simply the email address as a string.

Example: [email protected]

Validation¶

This field type uses the EmailAddressValidator validator as a resource which tests the string supplied as input against a pattern, to make sure that a valid email address has been provided. If the validations fail, a ValidationError is thrown, specifying the error message.

Settings¶

This field type doesn't support settings.