Skip to content

Commit

Permalink
De 1261 api ip pools endpoint (#909)
Browse files Browse the repository at this point in the history 
* Add dependabot. Change php-cs-fixer

* Domains. V4

* Merge branch 'master' of github.com:mailgun/mailgun-php

# Conflicts:
#	src/Api/DomainV4.php

* Added ips management

* Some fixes

* Psalm fixes

* Psalm fixes
  • Loading branch information
@oleksandr-mykhailenko
oleksandr-mykhailenko authored Jul 10, 2024
1 parent 4329fc6 commit 31a5aea
Show file tree
Hide file tree
Showing 3 changed files with 321 additions and 8 deletions.
3 changes: 2 additions & 1 deletion composer.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@
"nyholm/psr7": "^1.3.1",
"phpunit/phpunit": "^9.3",
"squizlabs/php_codesniffer": "^3.7",
"symfony/http-client": "^5.4 || ^6.3"
"symfony/http-client": "^5.4 || ^6.3",
"vimeo/psalm": "^4.0 || ^5.25"
},
"suggest": {
"nyholm/psr7": "PSR-7 message implementation",
Expand Down
278 changes: 271 additions & 7 deletions src/Api/DomainV4.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,12 @@
use Mailgun\Model\Domain\DeleteResponse;
use Mailgun\Model\Domain\IndexResponse;
use Mailgun\Model\Domain\ShowResponse;
use Mailgun\Model\Domain\TrackingResponse;
use Mailgun\Model\Domain\UpdateClickTrackingResponse;
use Mailgun\Model\Domain\UpdateConnectionResponse;
use Mailgun\Model\Domain\UpdateCredentialResponse;
use Mailgun\Model\Domain\UpdateOpenTrackingResponse;
use Mailgun\Model\Domain\UpdateUnsubscribeTrackingResponse;
use Mailgun\Model\Domain\VerifyResponse;
use Mailgun\Model\Domain\WebPrefixResponse;
use Mailgun\Model\Domain\WebSchemeResponse;
Expand Down Expand Up @@ -82,22 +86,23 @@ public function show(string $domain, array $requestHeaders = [])
* @param string $domain name of the domain
* @param string|null $smtpPass password for SMTP authentication
* @param string|null $spamAction `disable` or `tag` - inbound spam filtering
* @param bool|null $wildcard domain will accept email for subdomains
* @param bool|null $forceDkimAuthority force DKIM authority
* @param bool|null $wildcard
* @param bool|null $forceDkimAuthority
* @param string[] $ips an array of ips to be assigned to the domain
* @param ?string $pool_id pool id to assign to the domain
* @param string $webScheme `http` or `https` - set your open, click and unsubscribe URLs to use http or https. The default is http
* @param string $dkimKeySize Set length of your domain’s generated DKIM
* key
* @param array $requestHeaders
* @return CreateResponse|array|ResponseInterface
* @throws Exception
* @throws Exception|ClientExceptionInterface
*/
public function create(
string $domain,
string $smtpPass = null,
string $spamAction = null,
?bool $wildcard = null,
?bool $forceDkimAuthority = null,
?bool $wildcard = null,
?bool $forceDkimAuthority = null,
?array $ips = null,
?string $pool_id = null,
string $webScheme = 'http',
Expand All @@ -112,11 +117,13 @@ public function create(

if (!empty($smtpPass)) {
Assert::stringNotEmpty($smtpPass);

$params['smtp_password'] = $smtpPass;
}

if (!empty($spamAction)) {
Assert::stringNotEmpty($spamAction);

$params['spam_action'] = $spamAction;
}

Expand Down Expand Up @@ -163,8 +170,8 @@ public function create(
/**
* Removes a domain from the account.
* WARNING: This action is irreversible! Be cautious!
* @param string $domain name of the domain
* @param array $requestHeaders
* @param string $domain name of the domain
* @param array $requestHeaders
* @return DeleteResponse|array|ResponseInterface
* @throws ClientExceptionInterface
*/
Expand All @@ -177,6 +184,150 @@ public function delete(string $domain, array $requestHeaders = [])
return $this->hydrateResponse($response, DeleteResponse::class);
}

/**
* Returns a list of SMTP credentials for the specified domain.
* @param string $domain name of the domain
* @param int $limit Number of credentials to return
* @param int $skip Number of credentials to omit from the list
* @param array $requestHeaders
* @return CredentialResponse
* @throws ClientExceptionInterface
*/
public function credentials(string $domain, int $limit = 100, int $skip = 0, array $requestHeaders = [])
{
Assert::stringNotEmpty($domain);
$params = [
'limit' => $limit,
'skip' => $skip,
];

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

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

/**
* Create a new SMTP credential pair for the specified domain.
* @param string $domain name of the domain
* @param string $login SMTP Username
* @param string $password SMTP Password. Length min 5, max 32.
* @param array $requestHeaders
* @return CreateCredentialResponse|array|ResponseInterface
* @throws ClientExceptionInterface
*/
public function createCredential(string $domain, string $login, string $password, array $requestHeaders = [])
{
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, $requestHeaders);

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

/**
* Update a set of SMTP credentials for the specified domain.
*
* @param string $domain name of the domain
* @param string $login SMTP Username
* @param string $pass New SMTP Password. Length min 5, max 32.
*
* @return UpdateCredentialResponse|array|ResponseInterface
* @throws ClientExceptionInterface
*/
public function updateCredential(string $domain, string $login, string $pass, array $requestHeaders = [])
{
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, $requestHeaders);

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

/**
* Remove a set of SMTP credentials from the specified domain.
* @param string $domain name of the domain
* @param string $login SMTP Username
* @param array $requestHeaders
* @return DeleteCredentialResponse|array|ResponseInterface
* @throws ClientExceptionInterface
*/
public function deleteCredential(string $domain, string $login, array $requestHeaders = [])
{
Assert::stringNotEmpty($domain);
Assert::stringNotEmpty($login);

$response = $this->httpDelete(
sprintf(
'/v3/domains/%s/credentials/%s',
$domain,
$login
),
[],
$requestHeaders
);

return $this->hydrateResponse($response, DeleteCredentialResponse::class);
}

/**
* Returns delivery connection settings for the specified domain.
* @param string $domain name of the domain
* @param array $requestHeaders
* @return ConnectionResponse|ResponseInterface
* @throws ClientExceptionInterface
*/
public function connection(string $domain, array $requestHeaders = [])
{
Assert::stringNotEmpty($domain);

$response = $this->httpGet(sprintf('/v3/domains/%s/connection', $domain), [], $requestHeaders);

return $this->hydrateResponse($response, ConnectionResponse::class);
}

/**
* Updates the specified delivery connection settings for the specified domain.
* If a parameter is passed in as null, it will not be updated.
* @param string $domain name of the domain
* @param bool|null $requireTLS enforces that messages are sent only over a TLS connection
* @param bool|null $noVerify disables TLS certificate and hostname verification
* @param array $requestHeaders
* @return UpdateConnectionResponse|array|ResponseInterface
* @throws ClientExceptionInterface
*/
public function updateConnection(string $domain, ?bool $requireTLS, ?bool $noVerify, array $requestHeaders = [])
{
Assert::stringNotEmpty($domain);
$params = [];

if (null !== $requireTLS) {
$params['require_tls'] = $requireTLS ? 'true' : 'false';
}

if (null !== $noVerify) {
$params['skip_verification'] = $noVerify ? 'true' : 'false';
}

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

return $this->hydrateResponse($response, UpdateConnectionResponse::class);
}

/**
* Update webScheme for existing domain
* See below for spam filtering parameter information.
Expand Down Expand Up @@ -217,4 +368,117 @@ public function verify(string $domain, array $requestHeaders = [])

return $this->hydrateResponse($response, VerifyResponse::class);
}

/**
* Returns a domain tracking settings.
* @param string $domain name of the domain
* @param array $requestHeaders
* @return TrackingResponse|array|ResponseInterface
* @throws ClientExceptionInterface
*/
public function tracking(string $domain, array $requestHeaders = [])
{
Assert::stringNotEmpty($domain);

$response = $this->httpGet(sprintf('/v3/domains/%s/tracking', $domain), [], $requestHeaders);

return $this->hydrateResponse($response, TrackingResponse::class);
}

/**
* Updates a domain click tracking settings.
* @param string $domain The name of the domain
* @param string $active The status for this tracking (one of: yes, no)
* @param array $requestHeaders
* @return UpdateClickTrackingResponse|array|ResponseInterface
* @throws ClientExceptionInterface
*/
public function updateClickTracking(string $domain, string $active, array $requestHeaders = [])
{
Assert::stringNotEmpty($domain);
Assert::stringNotEmpty($active);
Assert::oneOf($active, ['yes', 'no', 'htmlonly']);

$params = [
'active' => $active,
];

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

return $this->hydrateResponse($response, UpdateClickTrackingResponse::class);
}

/**
* Updates a domain open tracking settings.
* @param string $domain The name of the domain
* @param string $active The status for this tracking (one of: yes, no)
* @param array $requestHeaders
* @return UpdateOpenTrackingResponse|array|ResponseInterface
* @throws ClientExceptionInterface
*/
public function updateOpenTracking(string $domain, string $active, array $requestHeaders = [])
{
Assert::stringNotEmpty($domain);
Assert::stringNotEmpty($active);
Assert::oneOf($active, ['yes', 'no']);

$params = [
'active' => $active,
];

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

return $this->hydrateResponse($response, UpdateOpenTrackingResponse::class);
}

/**
* Updates a domain unsubscribe tracking settings.
* @param string $domain The name of the domain
* @param string $active The status for this tracking (one of: yes, no)
* @param string $htmlFooter The footer for HTML emails
* @param string $textFooter The footer for plain text emails
* @param array $requestHeaders
* @return UpdateUnsubscribeTrackingResponse|array|ResponseInterface
* @throws ClientExceptionInterface
*/
public function updateUnsubscribeTracking(string $domain, string $active, string $htmlFooter, string $textFooter, array $requestHeaders = [])
{
Assert::stringNotEmpty($domain);
Assert::stringNotEmpty($active);
Assert::oneOf($active, ['yes', 'no', 'true', 'false']);
Assert::stringNotEmpty($htmlFooter);

$params = [
'active' => (in_array($active, ['yes', 'true'], true)) ? 'true' : 'false',
'html_footer' => $htmlFooter,
'text_footer' => $textFooter,
];

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

return $this->hydrateResponse($response, UpdateUnsubscribeTrackingResponse::class);
}

/**
* Updates a CNAME used for tracking opens and clicks.
*
* @param string $domain The name of the domain
* @param string $webPrefix The tracking CNAME for a domain
*
* @return WebPrefixResponse|array|ResponseInterface
* @throws ClientExceptionInterface
*/
public function updateWebPrefix(string $domain, string $webPrefix)
{
Assert::stringNotEmpty($domain);
Assert::stringNotEmpty($webPrefix);

$params = [
'web_prefix' => $webPrefix,
];

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

return $this->hydrateResponse($response, WebPrefixResponse::class);
}
}
48 changes: 48 additions & 0 deletions src/Api/Ip.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -220,4 +220,52 @@ public function removeIpOrUnlink(string $domain, string $ip, array $requestHeade

return $this->hydrateResponse($response, UpdateResponse::class);
}

/**
* @param array $data
* @param array $requestHeaders
* @return mixed|ResponseInterface
* @throws ClientExceptionInterface
*/
public function addNewDIPPIntoAccount(array $data, array $requestHeaders = [])
{
Assert::stringNotEmpty($data['description']);
Assert::stringNotEmpty($data['name']);

$response = $this->httpPost('/v3/ip_pools', $data, $requestHeaders);

return $this->hydrateResponse($response, UpdateResponse::class);
}

/**
* @param string $poolId
* @param array $requestHeaders
* @return mixed|ResponseInterface
* @throws ClientExceptionInterface
*/
public function loadDIPPInformation(string $poolId, array $requestHeaders = [])
{
$response = $this->httpGet(sprintf('/v3/ip_pools/%s', $poolId), [], $requestHeaders);

return $this->hydrateResponse($response, UpdateResponse::class);
}

/**
* @param string $poolId
* @param string $ip
* @param string $repPoolId
* @param array $requestHeaders
* @return mixed|ResponseInterface
* @throws ClientExceptionInterface
*/
public function deleteDIPP(string $poolId, string $ip, string $repPoolId, array $requestHeaders = [])
{
$response = $this->httpDelete(
sprintf('/v3/ip_pools/%s?', $poolId,) . http_build_query(['ip' => $ip, 'pool_id' => $repPoolId]),
[],
$requestHeaders
);

return $this->hydrateResponse($response, UpdateResponse::class);
}
}

0 comments on commit 31a5aea

Please sign in to comment.