PHP Class Mailgun\Messages\MessageBuilder

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

Protected Properties

Property Type Description
$counters array
$files array
$message array
$variables array

Public Methods

Method 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

Protected Methods

Method 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 method

public addAttachment ( string $attachmentPath, string | null $attachmentName = null ) : boolean
$attachmentPath string
$attachmentName string | null
return boolean

addBccRecipient() public method

public addBccRecipient ( string $address, array | null $variables = null ) : mixed
$address string
$variables array | null
return mixed

addCampaignId() public method

public addCampaignId ( string | integer $campaignId ) : string | integer
$campaignId string | integer
return string | integer

addCcRecipient() public method

public addCcRecipient ( string $address, array | null $variables = null ) : mixed
$address string
$variables array | null
return mixed

addCustomData() public method

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

addCustomHeader() public method

public addCustomHeader ( string $headerName, mixed $headerData ) : mixed
$headerName string
$headerData mixed
return mixed

addCustomParameter() public method

public addCustomParameter ( string $parameterName, mixed $data ) : mixed
$parameterName string
$data mixed
return mixed

addInlineImage() public method

public addInlineImage ( string $inlineImagePath, string | null $inlineImageName = null ) : boolean
$inlineImagePath string
$inlineImageName string | null
return boolean

addRecipient() protected method

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

addTag() public method

public addTag ( string $tag )
$tag string

addToRecipient() public method

public addToRecipient ( string $address, array | null $variables = null ) : mixed
$address string
$variables array | null
return mixed

getFiles() public method

public getFiles ( ) : array
return array

getFullName() protected method

protected getFullName ( array $params ) : mixed | string
$params array
return mixed | string

getMessage() public method

public getMessage ( ) : array
return array

parseAddress() protected method

protected parseAddress ( string $address, array $variables ) : string
$address string
$variables array
return string

safeGet() protected method

protected safeGet ( array $params, string $key, mixed $default ) : mixed
$params array
$key string
$default mixed
return mixed

setClickTracking() public method

public setClickTracking ( boolean $enabled ) : string
$enabled boolean
return string

setDeliveryTime() public method

public setDeliveryTime ( string $timeDate, string | null $timeZone = null ) : string
$timeDate string
$timeZone string | null
return string

setDkim() public method

public setDkim ( boolean $enabled ) : mixed
$enabled boolean
return mixed

setFromAddress() public method

public setFromAddress ( string $address, array | null $variables = null ) : mixed
$address string
$variables array | null
return mixed

setHtmlBody() public method

public setHtmlBody ( string $htmlBody ) : string
$htmlBody string
return string

setMessage() public method

public setMessage ( array $message )
$message array

setOpenTracking() public method

public setOpenTracking ( boolean $enabled ) : string
$enabled boolean
return string

setReplyToAddress() public method

public setReplyToAddress ( string $address, array | null $variables = null ) : mixed
$address string
$variables array | null
return mixed

setSubject() public method

public setSubject ( string $subject = '' ) : mixed
$subject string
return mixed

setTestMode() public method

public setTestMode ( boolean $testMode ) : string
$testMode boolean
return string

setTextBody() public method

public setTextBody ( string $textBody ) : string
$textBody string
return string

Property Details

$counters protected property

protected array $counters
return array

$files protected property

protected array $files
return array

$message protected property

protected array $message
return array

$variables protected property

protected array $variables
return array