interface FlaggableInterface (View source)

Methods

void
markRead()

Mark the message as read. Alias for markSeen.

void
markUnread()

Mark the message as unread. Alias for unmarkSeen.

void
markSeen()

Mark the message as seen.

void
unmarkSeen()

Unmark the seen flag.

void
markAnswered()

Mark the message as answered.

void
unmarkAnswered()

Unmark the answered flag.

void
markFlagged()

Mark the message as flagged.

void
unmarkFlagged()

Unmark the flagged flag.

void
markDeleted(bool $expunge = false)

Mark the message as deleted.

void
unmarkDeleted()

Unmark the deleted flag.

void
markDraft()

Mark the message as a draft.

void
unmarkDraft()

Unmark the draft flag.

void
markRecent()

Mark the message as recent.

void
unmarkRecent()

Unmark the recent flag.

bool
isSeen()

Determine if the message is marked as seen.

bool
isAnswered()

Determine if the message is marked as answered.

bool
isFlagged()

Determine if the message is flagged.

bool
isDeleted()

Determine if the message is marked as deleted.

bool
isDraft()

Determine if the message is marked as a draft.

bool
isRecent()

Determine if the message is marked as recent.

array
flags()

Get the message's flags.

bool
hasFlag(BackedEnum|string $flag)

Determine if the message has the given flag.

void
flag(BackedEnum|string $flag, string $operation, bool $expunge = false)

Add or remove a flag from the message.

Details

void markRead()

Mark the message as read. Alias for markSeen.

Return Value

void

void markUnread()

Mark the message as unread. Alias for unmarkSeen.

Return Value

void

void markSeen()

Mark the message as seen.

Return Value

void

void unmarkSeen()

Unmark the seen flag.

Return Value

void

void markAnswered()

Mark the message as answered.

Return Value

void

void unmarkAnswered()

Unmark the answered flag.

Return Value

void

void markFlagged()

Mark the message as flagged.

Return Value

void

void unmarkFlagged()

Unmark the flagged flag.

Return Value

void

void markDeleted(bool $expunge = false)

Mark the message as deleted.

Parameters

bool $expunge

Return Value

void

void unmarkDeleted()

Unmark the deleted flag.

Return Value

void

void markDraft()

Mark the message as a draft.

Return Value

void

void unmarkDraft()

Unmark the draft flag.

Return Value

void

void markRecent()

Mark the message as recent.

Return Value

void

void unmarkRecent()

Unmark the recent flag.

Return Value

void

bool isSeen()

Determine if the message is marked as seen.

Return Value

bool

bool isAnswered()

Determine if the message is marked as answered.

Return Value

bool

bool isFlagged()

Determine if the message is flagged.

Return Value

bool

bool isDeleted()

Determine if the message is marked as deleted.

Return Value

bool

bool isDraft()

Determine if the message is marked as a draft.

Return Value

bool

bool isRecent()

Determine if the message is marked as recent.

Return Value

bool

array flags()

Get the message's flags.

Return Value

array

bool hasFlag(BackedEnum|string $flag)

Determine if the message has the given flag.

Parameters

BackedEnum|string $flag

Return Value

bool

void flag(BackedEnum|string $flag, string $operation, bool $expunge = false)

Add or remove a flag from the message.

Parameters

BackedEnum|string $flag
string $operation
bool $expunge

Return Value

void