Omines\DirectAdmin\Objects\Email\Mailbox

Complexity

Total Complexity

16

Size/Duplication

Total Lines	132
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	3
A	create()	0	11	4
A	delete()	0	4	1
A	setPassword()	0	8	1
A	getDiskLimit()	0	4	2
A	getDiskUsage()	0	4	1
A	getMailsSent()	0	4	1
A	getMailLimit()	0	4	1
A	getMailSuspended()	0	4	1
A	getData()	0	11	1

<?php

/*
 * DirectAdmin API Client
 * (c) Omines Internetbureau B.V. - https://omines.nl/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Omines\DirectAdmin\Objects\Email;

use Omines\DirectAdmin\Objects\Domain;

/**
 * Encapsulates a full mailbox with POP/IMAP/webmail access.
 *
 * @author Niels Keurentjes <niels.keurentjes@omines.com>
 */
class Mailbox extends MailObject
{
    const CACHE_DATA = 'mailbox';

    /**
     * Construct the object.
     *
     * @param string $prefix The part before the @ in the address
     * @param Domain $domain The containing domain
     * @param string|array|null $config URL encoded config string as returned by CMD_API_POP
     */
    public function __construct($prefix, Domain $domain, $config = null)
    {
        parent::__construct($prefix, $domain);
        if (isset($config)) {
            $this->setCache(self::CACHE_DATA, is_string($config) ? \GuzzleHttp\Psr7\parse_query($config) : $config);
        }
    }

    /**
     * Creates a new mailbox.
     *
     * @param Domain $domain Domain to add the account to
     * @param string $prefix Prefix for the account
     * @param string $password Password for the account
     * @param int|null $quota Quota in megabytes, or zero/null for unlimited
     * @param int|null $sendLimit Send limit, or 0 for unlimited, or null for system default
     * @return Mailbox The created mailbox
     */
    public static function create(Domain $domain, $prefix, $password, $quota = null, $sendLimit = null)
    {
        $domain->invokePost('POP', 'create', [
            'user' => $prefix,
            'passwd' => $password,
            'passwd2' => $password,
            'quota' => intval($quota) ?: 0,
            'limit' => isset($sendLimit) ? (intval($sendLimit) ?: 0) : null,
        ]);
        return new self($prefix, $domain);
    }

    /**
     * Deletes the mailbox.
     */
    public function delete()
    {
        $this->invokeDelete('POP', 'user');
    }

    /**
     * Reset the password for this mailbox.
     *
     * @param string $newPassword
     */
    public function setPassword($newPassword)
    {
        $this->invokePost('POP', 'modify', [
            'user' => $this->getPrefix(),
            'passwd' => $newPassword,
            'passwd2' => $newPassword,
        ], false);
    }

    /**
     * Returns the disk quota in megabytes.
     *
     * @return float|null
     */
    public function getDiskLimit()
    {
        return floatval($this->getData('quota')) ?: null;
    }

    /**
     * Returns the disk usage in megabytes.
     *
     * @return float
     */
    public function getDiskUsage()
    {
        return floatval($this->getData('usage'));
    }

    /**
     * Return the amount of mails sent in the current period.
     *
     * @return int
     */
    public function getMailsSent()
    {
        return intval($this->getData('sent'));
    }

    /**
     * Return the maximum number of mails that can be send each day
     *
     * @return int
     */
    public function getMailLimit()
    {
        return intval($this->getData('limit'));
    }

    /**
     * Returns if the mailbox is suspended or not
     *
     * @return bool
     */
    public function getMailSuspended()
    {
        return( strcasecmp($this->getData('suspended'),"yes" ) == 0 );
    }


    /**
     * Cache wrapper to keep mailbox stats up to date.
     *
     * @param string $key
     * @return mixed
     */
    protected function getData($key)
    {
        return $this->getCacheItem(self::CACHE_DATA, $key, function () {
            $result = $this->getContext()->invokeApiGet('POP', [
                'domain' => $this->getDomainName(),
                'action' => 'full_list',
            ]);

            return \GuzzleHttp\Psr7\parse_query($result[$this->getPrefix()]);
        });
    }
}