Recipient.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Mail;

use ILIAS\Data\Result\Ok;
use ILIAS\Data\Result\Error;
use ILIAS\Data\Result;
use ILIAS\LegalDocuments\Conductor;
use ilObjUser;
use ilMailOptions;

final readonly class Recipient
{
    public function __construct(
        private int $user_id,
        private ?ilObjUser $user,
        private ilMailOptions $mail_options,
        private Conductor $legal_documents
    ) {
    }

    public function getUserId(): int
    {
        return $this->user_id;
    }

    public function getMailOptions(): ilMailOptions
    {
        return $this->mail_options;
    }

    public function isUser(): bool
    {
        return !is_null($this->user);
    }

    public function isUserActive(): bool
    {
        return $this->user->getActive();
    }

    public function isUserExpired(): bool
    {
        return !$this->user->checkTimeLimit();
    }

    public function evaluateInternalMailReadability(): Result
    {
        if ($this->isUserExpired()) {
            return new Error('Account expired.');
        }

        return $this->legal_documents->userCanReadInternalMail()->applyTo(new Ok($this->user));
    }

    public function userWantsToReceiveExternalMails(): bool
    {
        return $this->mail_options->getIncomingType() === ilMailOptions::INCOMING_EMAIL ||
            $this->mail_options->getIncomingType() === ilMailOptions::INCOMING_BOTH;
    }

    public function onlyToExternalMailAddress(): bool
    {
        return $this->mail_options->getIncomingType() === ilMailOptions::INCOMING_EMAIL;
    }

    public function getExternalMailAddress(): array
    {
        return $this->mail_options->getExternalEmailAddresses();
    }
}