\Clx\Xms\ApiDryRunPerRecipient

Per-recipient dry-run result.

Object of this class only occur within dry-run results.

Summary

Methods
Properties
Constants
getRecipient()
setRecipient()
getNumberOfParts()
setNumberOfParts()
getBody()
setBody()
getEncoding()
setEncoding()
No public properties found
ENCODING_TEXT
ENCODING_UNICODE
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

ENCODING_TEXT

ENCODING_TEXT

Constant indicating non-unicode encoding.

ENCODING_UNICODE

ENCODING_UNICODE

Constant indicating unicode encoding.

Methods

getRecipient()

getRecipient() : string

Get the recipient that this dry run result concerns.

Returns

string —

the recipient address

setRecipient()

setRecipient(string  $recipient) : void

Set the recipient that this dry run result concerns.

Parameters

string $recipient

the recipient address

getNumberOfParts()

getNumberOfParts() : integer

Get the number of message parts needed for this recipient.

Returns

integer —

number of message parts

setNumberOfParts()

setNumberOfParts(integer  $numberOfParts) : void

Set the number of message parts needed for this recipient.

Parameters

integer $numberOfParts

number of message parts

getBody()

getBody() : string

Get the message body sent to this recipient.

Returns

string —

message body

setBody()

setBody(string  $body) : void

Set the message body sent to this recipient.

Parameters

string $body

message body

getEncoding()

getEncoding() : string

Get the text encoding used for this recipient.

This is one of "text" or "unicode".

Returns

string —

text encoding used for this recipient

setEncoding()

setEncoding(string  $encoding) : void

Set the text encoding used for this recipient.

This is one of "text" or "unicode".

Parameters

string $encoding

text encoding used for this recipient