PHP Класс Mailgun\Mailgun

See the official documentation (link below) for usage instructions.
См. ссылку: https://github.com/mailgun/mailgun-php/blob/master/README.md
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$apiKey null | string
$restClient Mailgun\Connection\RestClient

Открытые методы

Метод Описание
BatchMessage ( string $workingDomain, boolean $autoSend = true ) : BatchMessage
MessageBuilder ( ) : MessageBuilder
OptInHandler ( ) : OptInHandler
__construct ( string | null $apiKey = null, Http\Client\HttpClient $httpClient = null, string $apiEndpoint = 'api.mailgun.net', Mailgun\Deserializer\ResponseDeserializer $deserializer = null, HttpClientConfigurator $clientConfigurator = null, RequestBuilder $requestBuilder = null )
delete ( string $endpointUrl ) : stdClass
domains ( ) : Domain
get ( string $endpointUrl, array $queryString = [] ) : stdClass
post ( string $endpointUrl, array $postData = [], array $files = [] ) : stdClass
put ( string $endpointUrl, array $putData ) : stdClass
sendMessage ( string $workingDomain, array $postData, array $postFiles = [] ) : stdClass This function allows the sending of a fully formed message OR a custom MIME string. If sending MIME, the string must be passed in to the 3rd position of the function call.
setApiVersion ( string $apiVersion ) : Mailgun
setSslEnabled ( boolean $sslEnabled ) : Mailgun
stats ( ) : Api\Stats
verifyWebhookSignature ( array | null $postData = null ) : boolean This function checks the signature in a POST request to see if it is authentic.

Описание методов

BatchMessage() публичный Метод

public BatchMessage ( string $workingDomain, boolean $autoSend = true ) : BatchMessage
$workingDomain string
$autoSend boolean
Результат Mailgun\Messages\BatchMessage

MessageBuilder() публичный Метод

public MessageBuilder ( ) : MessageBuilder
Результат Mailgun\Messages\MessageBuilder

OptInHandler() публичный Метод

public OptInHandler ( ) : OptInHandler
Результат Mailgun\Lists\OptInHandler

__construct() публичный Метод

public __construct ( string | null $apiKey = null, Http\Client\HttpClient $httpClient = null, string $apiEndpoint = 'api.mailgun.net', Mailgun\Deserializer\ResponseDeserializer $deserializer = null, HttpClientConfigurator $clientConfigurator = null, RequestBuilder $requestBuilder = null )
$apiKey string | null
$httpClient Http\Client\HttpClient
$apiEndpoint string
$deserializer Mailgun\Deserializer\ResponseDeserializer
$clientConfigurator HttpClientConfigurator
$requestBuilder RequestBuilder

delete() публичный Метод

public delete ( string $endpointUrl ) : stdClass
$endpointUrl string
Результат stdClass

domains() публичный Метод

public domains ( ) : Domain
Результат Mailgun\Api\Domain

get() публичный Метод

public get ( string $endpointUrl, array $queryString = [] ) : stdClass
$endpointUrl string
$queryString array
Результат stdClass

post() публичный Метод

public post ( string $endpointUrl, array $postData = [], array $files = [] ) : stdClass
$endpointUrl string
$postData array
$files array
Результат stdClass

put() публичный Метод

public put ( string $endpointUrl, array $putData ) : stdClass
$endpointUrl string
$putData array
Результат stdClass

sendMessage() публичный Метод

This function allows the sending of a fully formed message OR a custom MIME string. If sending MIME, the string must be passed in to the 3rd position of the function call.
public sendMessage ( string $workingDomain, array $postData, array $postFiles = [] ) : stdClass
$workingDomain string
$postData array
$postFiles array
Результат stdClass

setApiVersion() публичный Метод

public setApiVersion ( string $apiVersion ) : Mailgun
$apiVersion string
Результат Mailgun

setSslEnabled() публичный Метод

Устаревший: This will be removed in 3.0. Mailgun does not support non-secure connections to their API.
public setSslEnabled ( boolean $sslEnabled ) : Mailgun
$sslEnabled boolean
Результат Mailgun

stats() публичный Метод

public stats ( ) : Api\Stats
Результат Api\Stats

verifyWebhookSignature() публичный Метод

Pass an array of parameters. If you pass nothing, $_POST will be used instead. If this function returns FALSE, you must not process the request. You should reject the request with status code 403 Forbidden.
public verifyWebhookSignature ( array | null $postData = null ) : boolean
$postData array | null
Результат boolean

Описание свойств

$apiKey защищенное свойство

protected null|string $apiKey
Результат null | string

$restClient защищенное свойство

protected RestClient,Mailgun\Connection $restClient
Результат Mailgun\Connection\RestClient