Email.php

Go to the documentation of this file.

<?php

namespace Elgg;

use ElggEntity;
use ElggUser;
use InvalidParameterException;
use Elgg\Email\Address;
use Elgg\Email\Attachment;
use Zend\Mime\Part;

final class Email {

    protected $from;

    protected $to;

    protected $subject;

    protected $body;

    protected $params = [];

    protected $headers = [];
    
    protected $attachments = [];

    public static function factory(array $options = []) {
        $from = elgg_extract('from', $options);
        $to = elgg_extract('to', $options);
        $subject = elgg_extract('subject', $options);
        $body = elgg_extract('body', $options);
        $params = elgg_extract('params', $options, []);
        $headers = elgg_extract('headers', $options, []);

        $email = new self();
        $email->setFrom(self::prepareFrom($from));
        $email->setTo(self::prepareTo($to));
        $email->setSubject($subject);
        $email->setBody($body);
        $email->setParams($params);
        $email->setHeaders($headers);
        
        if (isset($params['attachments']) && is_array($params['attachments'])) {
            foreach ($params['attachments'] as $attachment) {
                $email->addAttachment($attachment);
            }
        }
        
        return $email;
    }

    public function setFrom(Address $from) {
        $this->from = $from;
        return $this;
    }

    public function getFrom() {
        return $this->from;
    }

    public function setTo(Address $to) {
        $this->to = $to;
        return $this;
    }

    public function getTo() {
        return $this->to;
    }

    public function setSubject($subject = '') {
        $this->subject = $subject;
        return $this;
    }

    public function getSubject() {
        return $this->subject;
    }

    public function setBody($body = '') {
        $this->body = $body;
        return $this;
    }

    public function getBody() {
        return $this->body;
    }

    public function setParams(array $params = []) {
        $this->params = $params;
        return $this;
    }

    public function getParams() {
        return $this->params;
    }

    public function addHeader($name, $value) {
        $this->headers[$name] = $value;
        return $this;
    }

    public function setHeaders(array $headers = []) {
        $this->headers = $headers;
        return $this;
    }

    public function getHeaders() {
        return $this->headers;
    }
    
    public function addAttachment($attachment) {
        
        if ($attachment instanceof Part) {
            $this->attachments[] = $attachment;
            return $this;
        }
        
        if ($attachment instanceof \ElggFile) {
            $this->attachments[] = Attachment::fromElggFile($attachment);
            return $this;
        }
        
        $attachment = Attachment::factory($attachment);
        if (!empty($attachment)) {
            $this->attachments[] = $attachment;
        }
        
        return $this;
    }
    
    public function getAttachments() {
        return $this->attachments;
    }

    protected static function prepareFrom($from) {
        if (empty($from)) {
            // get the site email address
            $site = elgg_get_site_entity();
            $from = new Address($site->getEmailAddress(), $site->getDisplayName());
        } else if ($from instanceof ElggEntity) {
            // If there's an email address, use it - but only if it's not from a user.
            if (!$from instanceof ElggUser && $from->email) {
                $from = new Address($from->email, $from->getDisplayName());
            } else {
                // get the site email address
                $site = elgg_get_site_entity();
                $from = new Address($site->getEmailAddress(), $site->getDisplayName());
            }
        } elseif (is_string($from)) {
            $from = Address::fromString($from);
        }
        
        if (!$from instanceof Address) {
            throw new InvalidParameterException("From address is not in a valid format");
        }

        return $from;
    }

    protected static function prepareTo($to) {
        if ($to instanceof ElggEntity) {
            $to = new Address($to->email, $to->getDisplayName());
        } elseif (is_string($to)) {
            $to = Address::fromString($to);
        }

        if (!$to instanceof Address) {
            throw new InvalidParameterException("To address is not in a valid format");
        }

        return $to;
    }
}