mailgun / mailgun-php

     *

     * @return CreateResponse|array|ResponseInterface

     */

    public function create($domain, $smtpPass, $spamAction, $wildcard)

    {

        Assert::stringNotEmpty($domain);

        Assert::stringNotEmpty($smtpPass);

        // TODO(sean.johnson): Extended spam filter input validation.

        Assert::stringNotEmpty($spamAction);

        Assert::boolean($wildcard);

        $params = [

            'name' => $domain,

            'smtp_password' => $smtpPass,

            'spam_action' => $spamAction,

            'wildcard' => $wildcard,

        ];

        $response = $this->httpPost('/v3/domains', $params);

        return $this->safeDeserialize($response, CreateResponse::class);

    }

    /**

     * Removes a domain from the account.

     *

     * @return CredentialResponse

     */

    public function credentials($domain, $limit = 100, $skip = 0)

    {

        Assert::stringNotEmpty($domain);

        Assert::integer($limit);

        Assert::integer($skip);

        $params = [

            'limit' => $limit,

            'skip' => $skip,

        ];

        $response = $this->httpGet(sprintf('/v3/domains/%s/credentials', $domain), $params);

        return $this->safeDeserialize($response, CredentialResponse::class);

    }

    /**

     * Create a new SMTP credential pair for the specified domain.

     *

     * @return CreateCredentialResponse|array|ResponseInterface

     */

    public function createCredential($domain, $login, $password)

    {

        Assert::stringNotEmpty($domain);

        Assert::stringNotEmpty($login);

        Assert::stringNotEmpty($password);

        Assert::lengthBetween($password, 5, 32, 'SMTP password must be between 5 and 32 characters.');

        $params = [

            'login' => $login,

            'password' => $password,

        ];

        $response = $this->httpPost(sprintf('/v3/domains/%s/credentials', $domain), $params);

        return $this->safeDeserialize($response, CreateCredentialResponse::class);

    }

    /**

     * Update a set of SMTP credentials for the specified domain.

     *

     * @return UpdateCredentialResponse|array|ResponseInterface

     */

    public function updateCredential($domain, $login, $pass)

    {

        Assert::stringNotEmpty($domain);

        Assert::stringNotEmpty($login);

        Assert::stringNotEmpty($pass);

        Assert::lengthBetween($pass, 5, 32, 'SMTP password must be between 5 and 32 characters.');

        $params = [

            'password' => $pass,

        ];

        $response = $this->httpPut(sprintf('/v3/domains/%s/credentials/%s', $domain, $login), $params);

        return $this->safeDeserialize($response, UpdateCredentialResponse::class);

    }

    /**

     * Remove a set of SMTP credentials from the specified domain.

     *

     * @return IndexResponse

     */

    public function index($limit = 100, $skip = 0)

    {

        Assert::integer($limit);

        Assert::integer($skip);

        Assert::greaterThan($limit, 0);

        Assert::greaterThanEq($skip, 0);

        $params = [

            'limit' => $limit,

            'skip' => $skip,

        ];

        $response = $this->httpGet('/v3/routes', $params);

        return $this->safeDeserialize($response, IndexResponse::class);

    }

    /**

     * Returns a single Route object based on its ID.

     *

     * @return CreateResponse

     */

    public function create($expression, array $actions, $description, $priority = 0)

    {

        Assert::string($expression);

        Assert::isArray($actions);

        Assert::string($description);

        Assert::integer($priority);

        $params = [

            'priority' => $priority,

            'expression' => $expression,

            'action' => $actions,

            'description' => $description,

        ];

        $response = $this->httpPost('/v3/routes', $params);

        return $this->safeDeserialize($response, CreateResponse::class);

    }

    /**

     * Updates a given Route by ID. All parameters are optional.