garethp\ews\MailAPI

Complexity

Total Complexity

21

Size/Duplication

Total Lines	200
Duplicated Lines	9 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

82.42%

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getFolderId()	0	8	2
A	setFolderId()	0	4	1
A	pickMailFolder()	0	10	2
A	formatRestrictions()	0	19	4
A	getMailItems()	0	23	3
A	getUnreadMailItems()	0	14	1
A	updateMailItem()	18	18	2
A	markMailAsRead()	0	10	2
A	sendMail()	0	16	2
A	getAttachment()	0	14	1
A	emptyTrash()	0	9	1

<?php

namespace garethp\ews;

use garethp\ews\API\Enumeration\DistinguishedFolderIdNameType;
use garethp\ews\API\Type;
use garethp\ews\API\Type\MessageType;

class MailAPI extends API
{
    /**
     * @var Type\BaseFolderIdType
     */
    protected $folderId;

    /**
     * @return Type\BaseFolderIdType
     */
    public function getFolderId()
    {
        if (!$this->folderId) {
            $this->folderId = $this->getDistinguishedFolderId('inbox');

It seems like $this->getDistinguishedFolderId('inbox') of type object<garethp\ews\API\Type\DistinguishedFolderIdType> is incompatible with the declared type object<garethp\ews\API\Type\BaseFolderIdType> of property $folderId.

        }

        return $this->folderId;

The expression $this->folderId; of type garethp\ews\API\Type\DistinguishedFolderIdType|garethp\ews\API\Type\BaseFolderIdType adds the type garethp\ews\API\Type\DistinguishedFolderIdType to the return on line 25 which is incompatible with the return type documented by garethp\ews\MailAPI::getFolderId of type garethp\ews\API\Type\BaseFolderIdType.

    }

    /**
     * @param Type\BaseFolderIdType $folderId
     */
    public function setFolderId($folderId)
    {
        $this->folderId = $folderId;
    }

    /**
     * @param string $displayName
     * @param string|Type\BaseFolderIdType $parentFolder
     */
    public function pickMailFolder($displayName = null, $parentFolder = 'inbox')
    {
        if ($displayName === null) {
            $this->folderId = $this->getDistinguishedFolderId('inbox');

It seems like $this->getDistinguishedFolderId('inbox') of type object<garethp\ews\API\Type\DistinguishedFolderIdType> is incompatible with the declared type object<garethp\ews\API\Type\BaseFolderIdType> of property $folderId.

            return;
        }

        $folder = $this->getFolderByDisplayName($displayName, $parentFolder);
        $this->folderId = $folder->getFolderId();
    }

    protected function formatRestrictions($restrictions)
    {
        foreach ($restrictions as $restrictionType => $query) {
            $formattedRestrictionType = array();
            foreach ($query as $key => $value) {
                if ($value === false) {
                    $value = 'false';
                }
                $formattedRestrictionType[] = array(
                    'FieldURI' => array('FieldURI' => API\FieldURIManager::getFieldUriByName($key, 'message')),
                    'FieldURIOrConstant' => array('Constant' => array('Value' => (string) $value))
                );
            }

            $restrictions[$restrictionType] = $formattedRestrictionType;
        }

        return $restrictions;
    }

    /**
     * Get all mail items in the inbox
     *
     * @param Type\BaseFolderIdType $folderId
     * @param array $options
     * @return Type\MessageType[]
     */
    public function getMailItems($folderId = null, $options = array())
    {
        if (!$folderId) {
            $folderId = $this->getFolderId();
        }

        $request = array(
            'Traversal' => 'Shallow',
            'ItemShape' => array(
                'BaseShape' => 'AllProperties'
            ),
            'ParentFolderIds' => $folderId->toArray(true)
        );

        if (!empty($options['Restriction'])) {
            $options['Restriction'] = $this->formatRestrictions($options['Restriction']);
        }

        $request = array_replace_recursive($request, $options);

        $request = Type::buildFromArray($request);
        return $this->getClient()->FindItem($request);
    }

    /**
     * @param Type\BaseFolderIdType $folderId
     * @param array $options
     * @return Type\MessageType[]
     */
    public function getUnreadMailItems($folderId = null, $options = array())
    {
        $unReadOption = array(
            'Restriction' => array(
                'IsEqualTo' => array(
                    'IsRead' => false
                )
            )
        );

        $options = array_replace_recursive($unReadOption, $options);

        return $this->getMailItems($folderId, $options);
    }

    /**
     * Updates a calendar item with changes
     *
     * @param $itemId Type\ItemIdType|Type
     * @param $changes
     * @return Type\MessageType[]
     */
    public function updateMailItem($itemId, $changes)
    {
        //Create the request
        $request = array(
            'ItemChange' => array(
                'ItemId' => $itemId->toArray(),
                'Updates' => API\ItemUpdateBuilder::buildUpdateItemChanges('Message', 'message', $changes)
            )
        );

        $items = $this->updateItems($request);

        if (!is_array($items)) {
            $items = array($items);
        }

        return $items;
    }

    /**
     * @param $mailItem Type\MessageType|Type\ItemIdType
     * @param $isRead boolean
     */
    public function markMailAsRead($mailItem, $isRead = true)
    {
        if ($mailItem instanceof Type\MessageType) {
            $mailItem = $mailItem->getItemId();
        }

        $this->updateMailItem($mailItem, array(
            'IsRead' => $isRead
        ));
    }

    public function sendMail(MessageType $message, $options = array())
    {
        $items = array('Message' => $message->toXmlObject());
        $defaultOptions = array(
            'MessageDisposition' => 'SendAndSaveCopy',
        );

        if ($this->getPrimarySmtpMailbox() != null) {
            $sentItems = $this->getDistinguishedFolderId('sentitems');
            $defaultOptions['SavedItemFolderId'] = $sentItems->toArray(true);
        }

        $options = array_replace_recursive($defaultOptions, $options);

        return $this->createItems($items, $options);
    }

    public function getAttachment(Type\AttachmentIdType $attachmentId)
    {
        $request = array(
            'AttachmentIds' => array(
                $attachmentId->toXmlObject()
            ),
            'AttachmentShape' => array(
                'IncludeMimeContent' => true
            )
        );

        $attachment = $this->getClient()->GetAttachment($request);
        return $attachment;
    }

    /**
     * @param array $options
     * @return API\Message\EmptyFolderResponseType
     */
    public function emptyTrash(array $options = [])
    {
        return $this->emptyFolder(
            $this->getDistinguishedFolderId(DistinguishedFolderIdNameType::DELETEDITEMS),
            'SoftDelete',
            false,
            $options
        );
    }
}