\Clx\XmsInboundsFilter

Filter to use when listing inbounds messages.

Summary

Methods
Properties
Constants
getPageSize()
setPageSize()
getRecipients()
setRecipients()
getStartDate()
setStartDate()
getEndDate()
setEndDate()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

getPageSize()

getPageSize() : integer

Get the maximum number of messages to retrieve per page.

Returns

integer —

page size

setPageSize()

setPageSize(integer  $pageSize) : void

Set the maximum number of messages to retrieve per page.

Parameters

integer $pageSize

page size

getRecipients()

getRecipients() : array<mixed,string>

Get recipient filter.

Returns

array<mixed,string> —

list of short codes and long numbers

setRecipients()

setRecipients(array<mixed,string>  $recipients) : void

Set recipient filter.

Only messages having one of these recipients will be fetched.

Parameters

array<mixed,string> $recipients

list of short codes and long numbers

getStartDate()

getStartDate() : \DateTime

Get start date filter.

Returns

\DateTime —

start date filter

setStartDate()

setStartDate(\DateTime  $startDate) : void

Set start date filter.

Only messages received at or after this date will be fetched.

Parameters

\DateTime $startDate

start date filter

getEndDate()

getEndDate() : \DateTime

Get end date filter.

Returns

\DateTime —

end date filter

setEndDate()

setEndDate(\DateTime  $endDate) : void

Set end date filter.

Only messages received before this date will be fetched.

Parameters

\DateTime $endDate

end date filter