PHP Class Mailgun\Api\HttpApi

Author: Tobias Nyholm ([email protected])

Protected Properties

Property	Type	Description
$requestBuilder	Mailgun\RequestBuilder
$serializer	Mailgun\Deserializer\ResponseDeserializer

Method	Description
__construct ( Http\Client\HttpClient $httpClient, RequestBuilder $requestBuilder, Mailgun\Deserializer\ResponseDeserializer $deserializer )

Method	Description
createJsonBody ( array $parameters ) : null \| string	Create a JSON encoded version of an array of parameters.
httpDelete ( string $path, array $parameters = [], array $requestHeaders = [] ) : Psr\Http\Message\ResponseInterface	Send a DELETE request with JSON-encoded parameters.
httpGet ( string $path, array $parameters = [], array $requestHeaders = [] ) : Psr\Http\Message\ResponseInterface	Send a GET request with query parameters.
httpPost ( string $path, array $parameters = [], array $requestHeaders = [] ) : Psr\Http\Message\ResponseInterface	Send a POST request with JSON-encoded parameters.
httpPostRaw ( string $path, array \| string $body, array $requestHeaders = [] ) : Psr\Http\Message\ResponseInterface	Send a POST request with raw data.
httpPut ( string $path, array $parameters = [], array $requestHeaders = [] ) : Psr\Http\Message\ResponseInterface	Send a PUT request with JSON-encoded parameters.
safeDeserialize ( Psr\Http\Message\ResponseInterface $response, string $className )	Attempts to safely deserialize the response into the given class.

public __construct ( Http\Client\HttpClient $httpClient, RequestBuilder $requestBuilder, Mailgun\Deserializer\ResponseDeserializer $deserializer )
$httpClient	Http\Client\HttpClient
$requestBuilder	Mailgun\RequestBuilder
$deserializer	Mailgun\Deserializer\ResponseDeserializer

Create a JSON encoded version of an array of parameters.

protected createJsonBody ( array $parameters ) : null \| string
$parameters	array	Request parameters
return	null \| string

Send a DELETE request with JSON-encoded parameters.

protected httpDelete ( string $path, array $parameters = [], array $requestHeaders = [] ) : Psr\Http\Message\ResponseInterface
$path	string	Request path.
$parameters	array	POST parameters to be JSON encoded.
$requestHeaders	array	Request headers.
return	Psr\Http\Message\ResponseInterface

Send a GET request with query parameters.

protected httpGet ( string $path, array $parameters = [], array $requestHeaders = [] ) : Psr\Http\Message\ResponseInterface
$path	string	Request path.
$parameters	array	GET parameters.
$requestHeaders	array	Request Headers.
return	Psr\Http\Message\ResponseInterface

Send a POST request with JSON-encoded parameters.

protected httpPost ( string $path, array $parameters = [], array $requestHeaders = [] ) : Psr\Http\Message\ResponseInterface
$path	string	Request path.
$parameters	array	POST parameters to be JSON encoded.
$requestHeaders	array	Request headers.
return	Psr\Http\Message\ResponseInterface

Send a POST request with raw data.

protected httpPostRaw ( string $path, array \| string $body, array $requestHeaders = [] ) : Psr\Http\Message\ResponseInterface
$path	string	Request path.
$body	array \| string	Request body.
$requestHeaders	array	Request headers.
return	Psr\Http\Message\ResponseInterface

Send a PUT request with JSON-encoded parameters.

protected httpPut ( string $path, array $parameters = [], array $requestHeaders = [] ) : Psr\Http\Message\ResponseInterface
$path	string	Request path.
$parameters	array	POST parameters to be JSON encoded.
$requestHeaders	array	Request headers.
return	Psr\Http\Message\ResponseInterface

If the HTTP return code != 200, deserializes into SimpleResponse::class to contain the error message and any other information provided.

protected safeDeserialize ( Psr\Http\Message\ResponseInterface $response, string $className )
$response	Psr\Http\Message\ResponseInterface
$className	string

protected RequestBuilder,Mailgun $requestBuilder
return	Mailgun\RequestBuilder

protected ResponseDeserializer,Mailgun\Deserializer $serializer
return	Mailgun\Deserializer\ResponseDeserializer