PHP Class Mailgun\Messages\MessageBuilder

See link: https://github.com/mailgun/mailgun-php/blob/master/src/Mailgun/Messages/README.md
Afficher le fichier Open project: mailgun/mailgun-php Class Usage Examples

Protected Properties

Свойство Type Description
$counters array
$files array
$message array
$variables array

Méthodes publiques

Méthode Description
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

Méthodes protégées

Méthode Description
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

Method Details

addAttachment() public méthode

public addAttachment ( string $attachmentPath, string | null $attachmentName = null ) : boolean
$attachmentPath string
$attachmentName string | null
Résultat boolean

addBccRecipient() public méthode

public addBccRecipient ( string $address, array | null $variables = null ) : mixed
$address string
$variables array | null
Résultat mixed

addCampaignId() public méthode

public addCampaignId ( string | integer $campaignId ) : string | integer
$campaignId string | integer
Résultat string | integer

addCcRecipient() public méthode

public addCcRecipient ( string $address, array | null $variables = null ) : mixed
$address string
$variables array | null
Résultat mixed

addCustomData() public méthode

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

addCustomHeader() public méthode

public addCustomHeader ( string $headerName, mixed $headerData ) : mixed
$headerName string
$headerData mixed
Résultat mixed

addCustomParameter() public méthode

public addCustomParameter ( string $parameterName, mixed $data ) : mixed
$parameterName string
$data mixed
Résultat mixed

addInlineImage() public méthode

public addInlineImage ( string $inlineImagePath, string | null $inlineImageName = null ) : boolean
$inlineImagePath string
$inlineImageName string | null
Résultat boolean

addRecipient() protected méthode

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

addTag() public méthode

public addTag ( string $tag )
$tag string

addToRecipient() public méthode

public addToRecipient ( string $address, array | null $variables = null ) : mixed
$address string
$variables array | null
Résultat mixed

getFiles() public méthode

public getFiles ( ) : array
Résultat array

getFullName() protected méthode

protected getFullName ( array $params ) : mixed | string
$params array
Résultat mixed | string

getMessage() public méthode

public getMessage ( ) : array
Résultat array

parseAddress() protected méthode

protected parseAddress ( string $address, array $variables ) : string
$address string
$variables array
Résultat string

safeGet() protected méthode

protected safeGet ( array $params, string $key, mixed $default ) : mixed
$params array
$key string
$default mixed
Résultat mixed

setClickTracking() public méthode

public setClickTracking ( boolean $enabled ) : string
$enabled boolean
Résultat string

setDeliveryTime() public méthode

public setDeliveryTime ( string $timeDate, string | null $timeZone = null ) : string
$timeDate string
$timeZone string | null
Résultat string

setDkim() public méthode

public setDkim ( boolean $enabled ) : mixed
$enabled boolean
Résultat mixed

setFromAddress() public méthode

public setFromAddress ( string $address, array | null $variables = null ) : mixed
$address string
$variables array | null
Résultat mixed

setHtmlBody() public méthode

public setHtmlBody ( string $htmlBody ) : string
$htmlBody string
Résultat string

setMessage() public méthode

public setMessage ( array $message )
$message array

setOpenTracking() public méthode

public setOpenTracking ( boolean $enabled ) : string
$enabled boolean
Résultat string

setReplyToAddress() public méthode

public setReplyToAddress ( string $address, array | null $variables = null ) : mixed
$address string
$variables array | null
Résultat mixed

setSubject() public méthode

public setSubject ( string $subject = '' ) : mixed
$subject string
Résultat mixed

setTestMode() public méthode

public setTestMode ( boolean $testMode ) : string
$testMode boolean
Résultat string

setTextBody() public méthode

public setTextBody ( string $textBody ) : string
$textBody string
Résultat string

Property Details

$counters protected_oe property

protected array $counters
Résultat array

$files protected_oe property

protected array $files
Résultat array

$message protected_oe property

protected array $message
Résultat array

$variables protected_oe property

protected array $variables
Résultat array