RetailCRM-Mirror/mailgun-php
1
0
Fork 0
mirror of https://github.com/retailcrm/mailgun-php.git synced 2025-04-04 05:33:34 +03:00
Code Issues Projects Releases Wiki Activity

Add method for updating web scheme (#834)

Browse source 
* Add method for updating web scheme

* Mailgun - https clic tracking via API

* CS FIXER
This commit is contained in:
Oleksandr Mykhailenko 2022-08-19 18:36:24 +03:00 • committed by GitHub
parent be083541bf
commit 20ab09c315
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 113 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CHANGELOG.md
View file

@ -2,6 +2,13 @@
The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.
## 3.5.3
### Added
- Ability to update web_scheme for domain
- `http` or `https` - set your open, click and unsubscribe URLs to use http or https. The default is http
## 3.5.1
### Fixed

17
README.md
View file

@ -62,6 +62,23 @@ $mg->messages()->send('example.com', [
Attention: `$domain` must match to the domain you have configured on [app.mailgun.com](https://app.mailgun.com/app/domains).
### Usage of new method for updating web scheme
```php
# Include the Autoloader (see "Libraries" for install instructions)
require 'vendor/autoload.php';
use Mailgun\Mailgun;
# Instantiate the client.
$mgClient = Mailgun::create('KEY', 'FULL_DOMAIN_URL');
$domain = "DOMAIN";
# Issue the call to the client.
$result = $mgClient->domains()->updateWebScheme($domain, 'https');
print_r($result);
```
### All usage examples
You will find more detailed documentation at [/doc](doc/index.md) and on

49
src/Api/Domain.php
View file

@ -11,6 +11,7 @@ declare(strict_types=1);
namespace Mailgun\Api;
use Exception;
use Mailgun\Assert;
use Mailgun\Model\Domain\ConnectionResponse;
use Mailgun\Model\Domain\CreateCredentialResponse;
@ -27,10 +28,12 @@ use Mailgun\Model\Domain\UpdateCredentialResponse;
use Mailgun\Model\Domain\UpdateOpenTrackingResponse;
use Mailgun\Model\Domain\UpdateUnsubscribeTrackingResponse;
use Mailgun\Model\Domain\VerifyResponse;
use Mailgun\Model\Domain\WebSchemeResponse;
use Psr\Http\Client\ClientExceptionInterface;
use Psr\Http\Message\ResponseInterface;
/**
* @see https://documentation.mailgun.com/api-domains.html
* @see https://documentation.mailgun.com/api-domains.html
*
* @author Sean Johnson <sean@mailgun.com>
*/
@ -42,6 +45,7 @@ class Domain extends HttpApi
* Returns a list of domains on the account.
*
* @return IndexResponse
* @throws ClientExceptionInterface
*/
public function index(int $limit = 100, int $skip = 0)
{
@ -63,6 +67,7 @@ class Domain extends HttpApi
* @param string $domain name of the domain
*
* @return ShowResponse|array|ResponseInterface
* @throws ClientExceptionInterface
*/
public function show(string $domain)
{
@ -91,6 +96,7 @@ class Domain extends HttpApi
* @param string $dkimKeySize Set length of your domain’s generated DKIM key
*
* @return CreateResponse|array|ResponseInterface
* @throws Exception
*/
public function create(string $domain, string $smtpPass = null, string $spamAction = null, bool $wildcard = null, bool $forceDkimAuthority = null, ?array $ips = null, ?string $pool_id = null, string $webScheme = 'http', string $dkimKeySize = '1024')
{
@ -162,6 +168,7 @@ class Domain extends HttpApi
* @param string $domain name of the domain
*
* @return DeleteResponse|array|ResponseInterface
* @throws ClientExceptionInterface
*/
public function delete(string $domain)
{
@ -180,6 +187,7 @@ class Domain extends HttpApi
* @param int $skip Number of credentials to omit from the list
*
* @return CredentialResponse
* @throws ClientExceptionInterface
*/
public function credentials(string $domain, int $limit = 100, int $skip = 0)
{
@ -202,6 +210,7 @@ class Domain extends HttpApi
* @param string $password SMTP Password. Length min 5, max 32.
*
* @return CreateCredentialResponse|array|ResponseInterface
* @throws Exception
*/
public function createCredential(string $domain, string $login, string $password)
{
@ -228,6 +237,7 @@ class Domain extends HttpApi
* @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)
{
@ -252,6 +262,7 @@ class Domain extends HttpApi
* @param string $login SMTP Username
*
* @return DeleteCredentialResponse|array|ResponseInterface
* @throws ClientExceptionInterface
*/
public function deleteCredential(string $domain, string $login)
{
@ -275,6 +286,7 @@ class Domain extends HttpApi
* @param string $domain name of the domain
*
* @return ConnectionResponse|ResponseInterface
* @throws ClientExceptionInterface
*/
public function connection(string $domain)
{
@ -294,6 +306,7 @@ class Domain extends HttpApi
* @param bool|null $noVerify disables TLS certificate and hostname verification
*
* @return UpdateConnectionResponse|array|ResponseInterface
* @throws ClientExceptionInterface
*/
public function updateConnection(string $domain, ?bool $requireTLS, ?bool $noVerify)
{
@ -313,12 +326,40 @@ class Domain extends HttpApi
return $this->hydrateResponse($response, UpdateConnectionResponse::class);
}
/**
* Update webScheme for existing domain
* See below for spam filtering parameter information.
* {@link https://documentation.mailgun.com/user_manual.html#um-spam-filter}.
*
* @see https://documentation.mailgun.com/en/latest/api-domains.html#domains
*
* @param string $domain name of the domain
* @param string $webScheme `http` or `https` - set your open, click and unsubscribe URLs to use http or https. The default is http
* @return WebSchemeResponse|array|ResponseInterface
* @throws Exception
* @throws ClientExceptionInterface
*/
public function updateWebScheme(string $domain, string $webScheme = 'http')
{
$params = [];
Assert::stringNotEmpty($domain);
Assert::stringNotEmpty($webScheme);
Assert::oneOf($webScheme, ['https', 'http']);
$params['web_scheme'] = $webScheme;
$response = $this->httpPut(sprintf('/v3/domains/%s', $domain), $params);
return $this->hydrateResponse($response, WebSchemeResponse::class);
}
/**
* Returns a single domain.
*
* @param string $domain name of the domain
*
* @return VerifyResponse|array|ResponseInterface
* @throws ClientExceptionInterface
*/
public function verify(string $domain)
{
@ -335,6 +376,7 @@ class Domain extends HttpApi
* @param string $domain name of the domain
*
* @return TrackingResponse|array|ResponseInterface
* @throws ClientExceptionInterface
*/
public function tracking(string $domain)
{
@ -353,7 +395,7 @@ class Domain extends HttpApi
*
* @return UpdateClickTrackingResponse|array|ResponseInterface
*
* @throws \Exception
* @throws Exception
*/
public function updateClickTracking(string $domain, string $active)
{
@ -377,6 +419,7 @@ class Domain extends HttpApi
* @param string $active The status for this tracking (one of: yes, no)
*
* @return UpdateOpenTrackingResponse|array|ResponseInterface
* @throws ClientExceptionInterface
*/
public function updateOpenTracking(string $domain, string $active)
{
@ -403,7 +446,7 @@ class Domain extends HttpApi
*
* @return UpdateUnsubscribeTrackingResponse|array|ResponseInterface
*
* @throws \Exception
* @throws Exception
*/
public function updateUnsubscribeTracking(string $domain, string $active, string $htmlFooter, string $textFooter)
{

18
src/Api/EmailValidation.php
View file

@ -35,12 +35,11 @@ class EmailValidation extends HttpApi
* @param bool $mailboxVerification If set to true, a mailbox verification check will be performed
* against the address. The default is False.
*
* @throws InvalidArgumentException Thrown when local validation returns an error
* @throws HttpClientException Thrown when there's an error on Client side
* @throws HttpServerException Thrown when there's an error on Server side
* @throws \Exception Thrown when we don't catch a Client or Server side Exception
*
* @return ValidateResponse|ResponseInterface
* @throws InvalidArgumentException Thrown when local validation returns an error
* @throws HttpClientException Thrown when there's an error on Client side
* @throws HttpServerException Thrown when there's an error on Server side
* @throws \Exception Thrown when we don't catch a Client or Server side Exception
*/
public function validate(string $address, bool $mailboxVerification = false)
{
@ -73,12 +72,11 @@ class EmailValidation extends HttpApi
* @param bool $syntaxOnly Perform only syntax checks or DNS and ESP specific validation as well.
* The default is True.
*
* @throws InvalidArgumentException Thrown when local validation returns an error
* @throws HttpClientException Thrown when there's an error on Client side
* @throws HttpServerException Thrown when there's an error on Server side
* @throws \Exception Thrown when we don't catch a Client or Server side Exception
*
* @return ParseResponse|ResponseInterface
* @throws InvalidArgumentException Thrown when local validation returns an error
* @throws HttpClientException Thrown when there's an error on Client side
* @throws HttpServerException Thrown when there's an error on Server side
* @throws \Exception Thrown when we don't catch a Client or Server side Exception
*/
public function parse(string $addresses, bool $syntaxOnly = true)
{

29
src/Api/HttpApi.php
View file

@ -19,6 +19,7 @@ use Mailgun\HttpClient\RequestBuilder;
use Mailgun\Hydrator\Hydrator;
use Mailgun\Hydrator\NoopHydrator;
use Psr\Http\Client as Psr18;
use Psr\Http\Client\ClientExceptionInterface;
use Psr\Http\Client\ClientInterface;
use Psr\Http\Message\ResponseInterface;
@ -113,9 +114,10 @@ abstract class HttpApi
/**
* Send a GET request with query parameters.
*
* @param string $path Request path
* @param array $parameters GET parameters
* @param array $requestHeaders Request Headers
* @param string $path Request path
* @param array $parameters GET parameters
* @param array $requestHeaders Request Headers
* @throws ClientExceptionInterface
*/
protected function httpGet(string $path, array $parameters = [], array $requestHeaders = []): ResponseInterface
{
@ -149,9 +151,10 @@ abstract class HttpApi
/**
* Send a POST request with raw data.
*
* @param string $path Request path
* @param array|string $body Request body
* @param array $requestHeaders Request headers
* @param string $path Request path
* @param array|string $body Request body
* @param array $requestHeaders Request headers
* @throws ClientExceptionInterface
*/
protected function httpPostRaw(string $path, $body, array $requestHeaders = []): ResponseInterface
{
@ -169,9 +172,10 @@ abstract class HttpApi
/**
* Send a PUT request.
*
* @param string $path Request path
* @param array $parameters PUT parameters
* @param array $requestHeaders Request headers
* @param string $path Request path
* @param array $parameters PUT parameters
* @param array $requestHeaders Request headers
* @throws ClientExceptionInterface
*/
protected function httpPut(string $path, array $parameters = [], array $requestHeaders = []): ResponseInterface
{
@ -189,9 +193,10 @@ abstract class HttpApi
/**
* Send a DELETE request.
*
* @param string $path Request path
* @param array $parameters DELETE parameters
* @param array $requestHeaders Request headers
* @param string $path Request path
* @param array $parameters DELETE parameters
* @param array $requestHeaders Request headers
* @throws ClientExceptionInterface
*/
protected function httpDelete(string $path, array $parameters = [], array $requestHeaders = []): ResponseInterface
{

2
src/Model/Domain/Domain.php
View file

@ -25,6 +25,7 @@ final class Domain
private $wildcard;
private $spamAction;
private $state;
private $webScheme;
public static function create(array $data): self
{
@ -36,6 +37,7 @@ final class Domain
$model->spamAction = $data['spam_action'] ?? null;
$model->state = $data['state'] ?? null;
$model->createdAt = isset($data['created_at']) ? new \DateTimeImmutable($data['created_at']) : null;
$model->webScheme = $data['web_scheme'] ?? null;
return $model;
}

16
src/Model/Domain/WebSchemeResponse.php Normal file
View file

@ -0,0 +1,16 @@
<?php
declare(strict_types=1);
/*
* Copyright (C) 2013 Mailgun
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace Mailgun\Model\Domain;
final class WebSchemeResponse extends AbstractDomainResponse
{
}