Files
espocrm/application/Espo/Core/Field/EmailAddress.php
bsiggel 127fa6503b chore: Update copyright year from 2025 to 2026 across core files
- Updated copyright headers in 3,055 core application files
- Changed 'Copyright (C) 2014-2025' to 'Copyright (C) 2014-2026'
- Added 123 new files from EspoCRM core updates
- Removed 4 deprecated files
- Total changes: 61,637 insertions, 54,283 deletions

This is a routine maintenance update for the new year 2026.
2026-02-07 16:05:21 +01:00

153 lines
3.6 KiB
PHP
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM Open Source CRM application.
* Copyright (C) 2014-2026 EspoCRM, Inc.
* Website: https://www.espocrm.com
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License version 3.
*
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
namespace Espo\Core\Field;
use InvalidArgumentException;
use const FILTER_VALIDATE_EMAIL;
/**
* An email address value. Immutable.
*/
class EmailAddress
{
private string $address;
private bool $isOptedOut = false;
private bool $isInvalid = false;
/**
* @throws InvalidArgumentException
*/
public function __construct(string $address)
{
if ($address === '') {
throw new InvalidArgumentException("Empty email address.");
}
if (!filter_var($address, FILTER_VALIDATE_EMAIL)) {
throw new InvalidArgumentException("Not valid email address '$address'.");
}
$this->address = $address;
}
/**
* Get an address.
*/
public function getAddress(): string
{
return $this->address;
}
/**
* Whether opted-out.
*/
public function isOptedOut(): bool
{
return $this->isOptedOut;
}
/**
* Whether invalid.
*/
public function isInvalid(): bool
{
return $this->isInvalid;
}
/**
* Clone set invalid.
*/
public function invalid(): self
{
$obj = $this->clone();
$obj->isInvalid = true;
return $obj;
}
/**
* Clone set not invalid.
*/
public function notInvalid(): self
{
$obj = $this->clone();
$obj->isInvalid = false;
return $obj;
}
/**
* Clone set opted-out.
*/
public function optedOut(): self
{
$obj = $this->clone();
$obj->isOptedOut = true;
return $obj;
}
/**
* Clone set not opted-out.
*/
public function notOptedOut(): self
{
$obj = $this->clone();
$obj->isOptedOut = false;
return $obj;
}
/**
* Create from an address.
*
* @throws InvalidArgumentException
*/
public static function create(string $address): self
{
return new self($address);
}
private function clone(): self
{
$obj = new self($this->address);
$obj->isInvalid = $this->isInvalid;
$obj->isOptedOut = $this->isOptedOut;
return $obj;
}
}