QueriesMessages
trait QueriesMessages (View source)
Traits
Properties
| protected ImapQueryBuilder | $query | The query builder instance. |
|
| protected int | $page | The current page. |
|
| protected int|null | $limit | The fetch limit. |
|
| protected bool | $fetchBody | Whether to fetch the message body. |
|
| protected bool | $fetchFlags | Whether to fetch the message flags. |
|
| protected bool | $fetchHeaders | Whether to fetch the message headers. |
|
| protected bool | $fetchSize | Whether to fetch the message size. |
|
| protected bool | $fetchBodyStructure | Whether to fetch the message body structure. |
|
| protected "asc"|"desc" | $fetchOrder | The fetch order. |
|
| protected bool | $fetchAsUnread | Whether to leave messages fetched as unread by default. |
|
| protected array | $passthru | The methods that should be returned from query builder. |
|
| protected ImapSortKey|null | $sortKey | The sort key for server-side sorting (RFC 5256). |
|
| protected "asc"|"desc" | $sortDirection | The sort direction for server-side sorting. |
Methods
Forward a method call to the given object.
Throw a bad method call exception for the given method.
Handle dynamic method calls into the query builder.
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
Set whether to fetch the flags.
Set the fetch body flag.
Set whether to fetch the headers.
Set whether to fetch the size.
Set whether to fetch the body structure.
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
{@inheritDoc}
Details
protected mixed
forwardCallTo(object $object, string $method, array $parameters)
Forward a method call to the given object.
static protected never
throwBadMethodCallException(string $method)
Throw a bad method call exception for the given method.
mixed
__call(string $method, array $parameters)
Handle dynamic method calls into the query builder.
MessageQueryInterface
leaveUnread()
{@inheritDoc}
MessageQueryInterface
markAsRead()
{@inheritDoc}
MessageQueryInterface
limit(int $limit, int $page = 1)
{@inheritDoc}
int|null
getLimit()
{@inheritDoc}
MessageQueryInterface
setLimit(int $limit)
{@inheritDoc}
int
getPage()
{@inheritDoc}
MessageQueryInterface
setPage(int $page)
{@inheritDoc}
bool
isFetchingBody()
{@inheritDoc}
bool
isFetchingFlags()
{@inheritDoc}
bool
isFetchingHeaders()
{@inheritDoc}
bool
isFetchingSize()
{@inheritDoc}
bool
isFetchingBodyStructure()
{@inheritDoc}
MessageQueryInterface
withFlags()
{@inheritDoc}
MessageQueryInterface
withBody()
{@inheritDoc}
MessageQueryInterface
withHeaders()
{@inheritDoc}
MessageQueryInterface
withSize()
{@inheritDoc}
MessageQueryInterface
withBodyStructure()
{@inheritDoc}
MessageQueryInterface
withoutBody()
{@inheritDoc}
MessageQueryInterface
withoutHeaders()
{@inheritDoc}
MessageQueryInterface
withoutFlags()
{@inheritDoc}
MessageQueryInterface
withoutSize()
{@inheritDoc}
MessageQueryInterface
withoutBodyStructure()
{@inheritDoc}
protected MessageQueryInterface
setFetchFlags(bool $fetchFlags)
Set whether to fetch the flags.
protected MessageQueryInterface
setFetchBody(bool $fetchBody)
Set the fetch body flag.
protected MessageQueryInterface
setFetchHeaders(bool $fetchHeaders)
Set whether to fetch the headers.
protected MessageQueryInterface
setFetchSize(bool $fetchSize)
Set whether to fetch the size.
protected MessageQueryInterface
setFetchBodyStructure(bool $fetchBodyStructure)
Set whether to fetch the body structure.
MessageQueryInterface
setFetchOrder(string $fetchOrder)
{@inheritDoc}
string
getFetchOrder()
{@inheritDoc}
MessageQueryInterface
setFetchOrderAsc()
{@inheritDoc}
MessageQueryInterface
setFetchOrderDesc()
{@inheritDoc}
MessageQueryInterface
oldest()
{@inheritDoc}
MessageQueryInterface
newest()
{@inheritDoc}
MessageQueryInterface
setSortKey(ImapSortKey|string|null $key)
{@inheritDoc}
ImapSortKey|null
getSortKey()
{@inheritDoc}
MessageQueryInterface
setSortDirection(string $direction)
{@inheritDoc}
string
getSortDirection()
{@inheritDoc}
MessageQueryInterface
sortBy(ImapSortKey|string $key, string $direction = 'asc')
{@inheritDoc}
MessageQueryInterface
sortByDesc(ImapSortKey|string $key)
{@inheritDoc}