PHP Класс Mailgun\Messages\MessageBuilder

См. ссылку: https://github.com/mailgun/mailgun-php/blob/master/src/Mailgun/Messages/README.md
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$counters array
$files array
$message array
$variables array

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

Метод Описание
addAttachment ( string $attachmentPath, string | null $attachmentName = null ) : boolean
addBccRecipient ( string $address, array | null $variables = null ) : mixed
addCampaignId ( string | integer $campaignId ) : string | integer
addCcRecipient ( string $address, array | null $variables = null ) : mixed
addCustomData ( string $customName, mixed $data )
addCustomHeader ( string $headerName, mixed $headerData ) : mixed
addCustomParameter ( string $parameterName, mixed $data ) : mixed
addInlineImage ( string $inlineImagePath, string | null $inlineImageName = null ) : boolean
addTag ( string $tag )
addToRecipient ( string $address, array | null $variables = null ) : mixed
getFiles ( ) : array
getMessage ( ) : array
setClickTracking ( boolean $enabled ) : string
setDeliveryTime ( string $timeDate, string | null $timeZone = null ) : string
setDkim ( boolean $enabled ) : mixed
setFromAddress ( string $address, array | null $variables = null ) : mixed
setHtmlBody ( string $htmlBody ) : string
setMessage ( array $message )
setOpenTracking ( boolean $enabled ) : string
setReplyToAddress ( string $address, array | null $variables = null ) : mixed
setSubject ( string $subject = '' ) : mixed
setTestMode ( boolean $testMode ) : string
setTextBody ( string $textBody ) : string

Защищенные методы

Метод Описание
addRecipient ( string $headerName, string $address, array $variables )
getFullName ( array $params ) : mixed | string
parseAddress ( string $address, array $variables ) : string
safeGet ( array $params, string $key, mixed $default ) : mixed

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

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

public addAttachment ( string $attachmentPath, string | null $attachmentName = null ) : boolean
$attachmentPath string
$attachmentName string | null
Результат boolean

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

public addBccRecipient ( string $address, array | null $variables = null ) : mixed
$address string
$variables array | null
Результат mixed

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

public addCampaignId ( string | integer $campaignId ) : string | integer
$campaignId string | integer
Результат string | integer

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

public addCcRecipient ( string $address, array | null $variables = null ) : mixed
$address string
$variables array | null
Результат mixed

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

public addCustomData ( string $customName, mixed $data )
$customName string
$data mixed

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

public addCustomHeader ( string $headerName, mixed $headerData ) : mixed
$headerName string
$headerData mixed
Результат mixed

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

public addCustomParameter ( string $parameterName, mixed $data ) : mixed
$parameterName string
$data mixed
Результат mixed

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

public addInlineImage ( string $inlineImagePath, string | null $inlineImageName = null ) : boolean
$inlineImagePath string
$inlineImageName string | null
Результат boolean

addRecipient() защищенный Метод

protected addRecipient ( string $headerName, string $address, array $variables )
$headerName string
$address string
$variables array

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

public addTag ( string $tag )
$tag string

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

public addToRecipient ( string $address, array | null $variables = null ) : mixed
$address string
$variables array | null
Результат mixed

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

public getFiles ( ) : array
Результат array

getFullName() защищенный Метод

protected getFullName ( array $params ) : mixed | string
$params array
Результат mixed | string

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

public getMessage ( ) : array
Результат array

parseAddress() защищенный Метод

protected parseAddress ( string $address, array $variables ) : string
$address string
$variables array
Результат string

safeGet() защищенный Метод

protected safeGet ( array $params, string $key, mixed $default ) : mixed
$params array
$key string
$default mixed
Результат mixed

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

public setClickTracking ( boolean $enabled ) : string
$enabled boolean
Результат string

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

public setDeliveryTime ( string $timeDate, string | null $timeZone = null ) : string
$timeDate string
$timeZone string | null
Результат string

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

public setDkim ( boolean $enabled ) : mixed
$enabled boolean
Результат mixed

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

public setFromAddress ( string $address, array | null $variables = null ) : mixed
$address string
$variables array | null
Результат mixed

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

public setHtmlBody ( string $htmlBody ) : string
$htmlBody string
Результат string

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

public setMessage ( array $message )
$message array

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

public setOpenTracking ( boolean $enabled ) : string
$enabled boolean
Результат string

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

public setReplyToAddress ( string $address, array | null $variables = null ) : mixed
$address string
$variables array | null
Результат mixed

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

public setSubject ( string $subject = '' ) : mixed
$subject string
Результат mixed

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

public setTestMode ( boolean $testMode ) : string
$testMode boolean
Результат string

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

public setTextBody ( string $textBody ) : string
$textBody string
Результат string

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

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

protected array $counters
Результат array

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

protected array $files
Результат array

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

protected array $message
Результат array

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

protected array $variables
Результат array