beyondcode / laravel-mailbox

src/InboundEmail.php

<?php

namespace BeyondCode\Mailbox;

use Carbon\Carbon;
use EmailReplyParser\EmailReplyParser;
use Illuminate\Contracts\Mail\Mailable;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Mail;
use Illuminate\Support\Str;
use ZBateson\MailMimeParser\Header\AddressHeader;
use ZBateson\MailMimeParser\Header\Part\AddressPart;
use ZBateson\MailMimeParser\Message as MimeMessage;
use ZBateson\MailMimeParser\Message\Part\MessagePart;

class InboundEmail extends Model
{
    protected $table = 'mailbox_inbound_emails';

    /** @var MimeMessage */
    protected $mimeMessage;

    protected $fillable = [
        'message',
    ];

    protected static function boot()
    {
        parent::boot();

        static::creating(function ($model) {
            $model->message_id = $model->id();
        });
    }

    public static function fromMessage($message)
    {
        return new static([
            'message' => $message,
        ]);
    }

    public function id(): string
    {
        return $this->message()->getHeaderValue('Message-Id', Str::random());
    }

    public function date(): Carbon
    {
        return Carbon::make($this->message()->getHeaderValue('Date'));

The expression return Carbon\Carbon::make($this->message()->getHeaderValue('Date')) could return the type null which is incompatible with the type-hinted return Carbon\Carbon. Consider adding an additional type-check to rule them out.

    }

    public function text(): ?string
    {
        return $this->message()->getTextContent();
    }

    public function visibleText(): ?string
    {
        return EmailReplyParser::parseReply($this->text());
    }

    public function html(): ?string
    {
        return $this->message()->getHtmlContent();
    }

    public function headerValue($headerName): ?string
    {
        return $this->message()->getHeaderValue($headerName, null);
    }

    public function subject(): ?string
    {
        return $this->message()->getHeaderValue('Subject');
    }

    public function from(): string
    {
        $from = $this->message()->getHeader('From');

        if ($from instanceof AddressHeader) {
            return $from->getEmail();

The expression return $from->getEmail() could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

        }

        return '';
    }

    public function fromName(): string
    {
        $from = $this->message()->getHeader('From');

        if ($from instanceof AddressHeader) {
            return $from->getPersonName();

The expression return $from->getPersonName() could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

        }

        return '';
    }

    /**
     * @return AddressPart[]
     */
    public function to(): array
    {
        return $this->convertAddressHeader($this->message()->getHeader('To'));
    }

    /**
     * @return AddressPart[]
     */
    public function cc(): array
    {
        return $this->convertAddressHeader($this->message()->getHeader('Cc'));
    }

    /**
     * @return AddressPart[]
     */
    public function bcc(): array
    {
        return $this->convertAddressHeader($this->message()->getHeader('Bcc'));
    }

    protected function convertAddressHeader($header): array
    {
        if ($header instanceof AddressHeader) {
            return Collection::make($header->getAddresses())->toArray();
        }

        return [];
    }

    /**
     * @return MessagePart[]
     */
    public function attachments()
    {
        return $this->message()->getAllAttachmentParts();
    }

    public function message(): MimeMessage
    {
        $this->mimeMessage = $this->mimeMessage ?: MimeMessage::from($this->message, true);

        return $this->mimeMessage;

The expression return $this->mimeMessage could return the type ZBateson\MailMimeParser\IMessage which includes types incompatible with the type-hinted return ZBateson\MailMimeParser\Message. Consider adding an additional type-check to rule them out.

    }

    public function reply(Mailable $mailable)
    {
        if ($mailable instanceof \Illuminate\Mail\Mailable) {
            $usesSymfonyMailer = version_compare(app()->version(), '9.0.0', '>');

            if ($usesSymfonyMailer) {
                $mailable->withSymfonyMessage(function (\Symfony\Component\Mime\Email $email) {
                    $email->getHeaders()->addIdHeader('In-Reply-To', $this->id());
                });
            } else {
                $mailable->withSwiftMessage(function (\Swift_Message $message) {
                    $message->getHeaders()->addIdHeader('In-Reply-To', $this->id());
                });
            }
        }

        return Mail::to($this->headerValue('Reply-To') ?: $this->from())->send($mailable);
    }

    public function forward($recipients)
    {
        return Mail::send([], [], function ($message) use ($recipients) {
            $message->to($recipients)
                ->subject($this->subject())
                ->setBody($this->body(), $this->message()->getContentType());
        });
    }

    public function body(): ?string
    {
        return $this->isHtml() ? $this->html() : $this->text();
    }

    public function isHtml(): bool
    {
        return ! empty($this->html());
    }

    public function isText(): bool
    {
        return ! empty($this->text());
    }

    public function isValid(): bool
    {
        return $this->from() !== '' && ($this->isText() || $this->isHtml());
    }

    public function isAutoReply($checkCommonSubjects = true): bool
    {
        if ($this->headerValue('x-autorespond')) {
            return true;
        }

        if (in_array($this->headerValue('precedence'), ['auto_reply', 'bulk', 'junk'])) {
            return true;
        }

        if (in_array($this->headerValue('x-precedence'), ['auto_reply', 'bulk', 'junk'])) {
            return true;
        }
        if (in_array($this->headerValue('auto-submitted'), ['auto-replied', 'auto-generated'])) {
            return true;
        }

        if ($checkCommonSubjects) {
            return Str::startsWith($this->subject(), [
                'Auto:',
                'Automatic reply',
                'Autosvar',
                'Automatisk svar',
                'Automatisch antwoord',
                'Abwesenheitsnotiz',
                'Risposta Non al computer',
                'Automatisch antwoord',
                'Auto Response',
                'Respuesta automática',
                'Fuori sede',
                'Out of Office',
                'Frånvaro',
                'Réponse automatique',
            ]);
        }

        return false;
    }
}