PHP 클래스 Mailgun\Connection\RestClient

파일 보기 프로젝트 열기: mailgun/mailgun-php 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$apiHost string
$apiVersion string The version of the API to use.
$httpClient Http\Client\HttpClient
$sslEnabled boolean If we should use SSL or not.

공개 메소드들

메소드 설명
__construct ( string $apiKey, string $apiHost, Http\Client\HttpClient $httpClient = null )
delete ( string $endpointUrl ) : stdClass
get ( string $endpointUrl, array $queryString = [] ) : stdClass
post ( string $endpointUrl, array $postData = [], array $files = [] ) : stdClass
put ( string $endpointUrl, mixed $putData ) : stdClass
responseHandler ( Psr\Http\Message\ResponseInterface $responseObj ) : stdClass
setApiVersion ( string $apiVersion ) : RestClient
setSslEnabled ( boolean $sslEnabled ) : RestClient

보호된 메소드들

메소드 설명
getHttpClient ( ) : Http\Client\HttpClient
getResponseExceptionMessage ( Psr\Http\Message\ResponseInterface $responseObj ) : string
prepareFile ( string $fieldName, string | array $filePath, integer $fileIndex ) : array Prepare a file for the postBody.
send ( string $method, string $uri, mixed $body = null, array $files = [], array $headers = [] ) : stdClass

비공개 메소드들

메소드 설명
generateEndpoint ( string $apiEndpoint, string $apiVersion, boolean $ssl ) : string
getApiUrl ( $uri ) : string

메소드 상세

__construct() 공개 메소드

public __construct ( string $apiKey, string $apiHost, Http\Client\HttpClient $httpClient = null )
$apiKey string
$apiHost string
$httpClient Http\Client\HttpClient

delete() 공개 메소드

public delete ( string $endpointUrl ) : stdClass
$endpointUrl string
리턴 stdClass

get() 공개 메소드

public get ( string $endpointUrl, array $queryString = [] ) : stdClass
$endpointUrl string
$queryString array
리턴 stdClass

getHttpClient() 보호된 메소드

protected getHttpClient ( ) : Http\Client\HttpClient
리턴 Http\Client\HttpClient

getResponseExceptionMessage() 보호된 메소드

protected getResponseExceptionMessage ( Psr\Http\Message\ResponseInterface $responseObj ) : string
$responseObj Psr\Http\Message\ResponseInterface
리턴 string

post() 공개 메소드

public post ( string $endpointUrl, array $postData = [], array $files = [] ) : stdClass
$endpointUrl string
$postData array
$files array
리턴 stdClass

prepareFile() 보호된 메소드

Prepare a file for the postBody.
protected prepareFile ( string $fieldName, string | array $filePath, integer $fileIndex ) : array
$fieldName string
$filePath string | array
$fileIndex integer
리턴 array

put() 공개 메소드

public put ( string $endpointUrl, mixed $putData ) : stdClass
$endpointUrl string
$putData mixed
리턴 stdClass

responseHandler() 공개 메소드

public responseHandler ( Psr\Http\Message\ResponseInterface $responseObj ) : stdClass
$responseObj Psr\Http\Message\ResponseInterface
리턴 stdClass

send() 보호된 메소드

protected send ( string $method, string $uri, mixed $body = null, array $files = [], array $headers = [] ) : stdClass
$method string
$uri string
$body mixed
$files array
$headers array
리턴 stdClass

setApiVersion() 공개 메소드

public setApiVersion ( string $apiVersion ) : RestClient
$apiVersion string
리턴 RestClient

setSslEnabled() 공개 메소드

사용 중단: To be removed in 3.0
public setSslEnabled ( boolean $sslEnabled ) : RestClient
$sslEnabled boolean
리턴 RestClient

프로퍼티 상세

$apiHost 보호되어 있는 프로퍼티

protected string $apiHost
리턴 string

$apiVersion 보호되어 있는 프로퍼티

The version of the API to use.
protected string $apiVersion
리턴 string

$httpClient 보호되어 있는 프로퍼티

protected HttpClient,Http\Client $httpClient
리턴 Http\Client\HttpClient

$sslEnabled 보호되어 있는 프로퍼티

If we should use SSL or not.
사용 중단: To be removed in 3.0
protected bool $sslEnabled
리턴 boolean