Address.php

Go to the documentation of this file.

<?php

namespace Elgg\Email;

use Elgg\Exceptions\InvalidArgumentException;
use Laminas\Mail\Address as ZendAddress;
use Laminas\Validator\EmailAddress as EmailAddressValidator;
use Laminas\Validator\Hostname;

class Address extends ZendAddress {
    
    protected $entity = null;
    
    public function __construct($email, $name = null, $comment = null) {
        if (isset($name) && is_string($name)) {
            $name = html_entity_decode($name, ENT_QUOTES | ENT_XHTML, 'UTF-8');
        }
        
        try {
            parent::__construct($email, $name, $comment);
        } catch (\Laminas\Mail\Exception\InvalidArgumentException $e) {
            throw new InvalidArgumentException($e->getMessage(), $e->getCode(), $e);
        }
    }
    
    public function setEmail($email) {
        
        if (!is_string($email) || empty($email)) {
            throw new InvalidArgumentException('Email must be a valid email address');
        }
        
        if (preg_match("/[\r\n]/", $email)) {
            throw new InvalidArgumentException('CRLF injection detected');
        }
        
        $emailAddressValidator = new EmailAddressValidator(Hostname::ALLOW_DNS | Hostname::ALLOW_LOCAL);
        if (!$emailAddressValidator->isValid($email)) {
            $invalidMessages = $emailAddressValidator->getMessages();
            throw new InvalidArgumentException(array_shift($invalidMessages));
        }
        
        $this->email = $email;
    }
    
    public function setName($name) {
        
        if (!is_string($name)) {
            throw new InvalidArgumentException('Name must be a string');
        }
        
        if (preg_match("/[\r\n]/", $name)) {
            throw new InvalidArgumentException('CRLF injection detected');
        }
        
        $this->name = html_entity_decode($name, ENT_QUOTES | ENT_XHTML, 'UTF-8');
    }
    
    public function unsetName() {
        $this->name = null;
    }
    
    public function setEntity(\ElggEntity $entity): void {
        $this->entity = $entity;
    }
    
    public function getEntity(): ?\ElggEntity {
        return $this->entity;
    }
    
    public static function fromString($address, $comment = null): Address {
        $containsName = preg_match('/<(.*)>/', $address, $matches) == 1;
        if ($containsName) {
            $name = trim(elgg_substr($address, 0, elgg_strpos($address, '<')));
            return new static($matches[1], $name);
        }
        
        return new static(trim($address));
    }
    
    public static function fromEntity(\ElggEntity $entity): Address {
        $address = new static($entity->email, $entity->getDisplayName());
        $address->setEntity($entity);
        return $address;
    }
    
    public static function getFormattedEmailAddress($email, $name = null) {
        $mail = new static($email, $name);
        return $mail->toString();
    }
}