1. interface
  2. DirectoryTree
  3. \
  4. ImapEngine
  5. \
  6. MessageInterface

MessageInterface

interface MessageInterface implements FlaggableInterface, Stringable (View source)

Methods

void
markRead()

Mark the message as read. Alias for markSeen.

from  FlaggableInterface
void
markUnread()

Mark the message as unread. Alias for unmarkSeen.

from  FlaggableInterface
void
markSeen()

Mark the message as seen.

from  FlaggableInterface
void
unmarkSeen()

Unmark the seen flag.

from  FlaggableInterface
void
markAnswered()

Mark the message as answered.

from  FlaggableInterface
void
unmarkAnswered()

Unmark the answered flag.

from  FlaggableInterface
void
markFlagged()

Mark the message as flagged.

from  FlaggableInterface
void
unmarkFlagged()

Unmark the flagged flag.

from  FlaggableInterface
void
markDeleted(bool $expunge = false)

Mark the message as deleted.

from  FlaggableInterface
void
unmarkDeleted()

Unmark the deleted flag.

from  FlaggableInterface
void
markDraft()

Mark the message as a draft.

from  FlaggableInterface
void
unmarkDraft()

Unmark the draft flag.

from  FlaggableInterface
void
markRecent()

Mark the message as recent.

from  FlaggableInterface
void
unmarkRecent()

Unmark the recent flag.

from  FlaggableInterface
bool
isSeen()

Determine if the message is marked as seen.

from  FlaggableInterface
bool
isAnswered()

Determine if the message is marked as answered.

from  FlaggableInterface
bool
isFlagged()

Determine if the message is flagged.

from  FlaggableInterface
bool
isDeleted()

Determine if the message is marked as deleted.

from  FlaggableInterface
bool
isDraft()

Determine if the message is marked as a draft.

from  FlaggableInterface
bool
isRecent()

Determine if the message is marked as recent.

from  FlaggableInterface
array
flags()

Get the message's flags.

from  FlaggableInterface
bool
hasFlag(BackedEnum|string $flag)

Determine if the message has the given flag.

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

Add or remove a flag from the message.

from  FlaggableInterface
int
uid()

Get the message's identifier.

int|null
size()

Get the message's size in bytes (RFC822.SIZE).

CarbonInterface|null
date()

Get the message date and time.

string|null
subject()

Get the message's subject.

Address|null
from()

Get the 'From' address.

Address|null
sender()

Get the 'Sender' address.

string|null
messageId()

Get the message's 'Message-ID'.

Address|null
replyTo()

Get the 'Reply-To' address.

array
inReplyTo()

Get the 'In-Reply-To' message identifier(s).

array
to()

Get the 'To' addresses.

array
cc()

Get the 'CC' addresses.

array
bcc()

Get the 'BCC' addresses.

array
attachments()

Get the message's attachments.

bool
hasAttachments()

Determine if the message has attachments.

int
attachmentCount()

Get the count of attachments.

array
addresses(string $header)

Get addresses from the given header.

string|null
html()

Get the message's HTML content.

string|null
text()

Get the message's text content.

array
headers()

Get all headers from the message.

IHeader|null
header(string $name, int $offset = 0)

Get a header from the message.

IMessage
parse()

Parse the message into a MailMimeMessage instance.

bool
is(MessageInterface $message)

Determine if the message is the same as another message.

string
__toString()

Get the string representation of the message.

Details

in FlaggableInterface at line 12
void markRead()

Mark the message as read. Alias for markSeen.

Return Value

void

in FlaggableInterface at line 17
void markUnread()

Mark the message as unread. Alias for unmarkSeen.

Return Value

void

in FlaggableInterface at line 22
void markSeen()

Mark the message as seen.

Return Value

void

in FlaggableInterface at line 27
void unmarkSeen()

Unmark the seen flag.

Return Value

void

in FlaggableInterface at line 32
void markAnswered()

Mark the message as answered.

Return Value

void

in FlaggableInterface at line 37
void unmarkAnswered()

Unmark the answered flag.

Return Value

void

in FlaggableInterface at line 42
void markFlagged()

Mark the message as flagged.

Return Value

void

in FlaggableInterface at line 47
void unmarkFlagged()

Unmark the flagged flag.

Return Value

void

in FlaggableInterface at line 52
void markDeleted(bool $expunge = false)

Mark the message as deleted.

Parameters

bool $expunge

Return Value

void

in FlaggableInterface at line 57
void unmarkDeleted()

Unmark the deleted flag.

Return Value

void

in FlaggableInterface at line 62
void markDraft()

Mark the message as a draft.

Return Value

void

in FlaggableInterface at line 67
void unmarkDraft()

Unmark the draft flag.

Return Value

void

in FlaggableInterface at line 72
void markRecent()

Mark the message as recent.

Return Value

void

in FlaggableInterface at line 77
void unmarkRecent()

Unmark the recent flag.

Return Value

void

in FlaggableInterface at line 82
bool isSeen()

Determine if the message is marked as seen.

Return Value

bool

in FlaggableInterface at line 87
bool isAnswered()

Determine if the message is marked as answered.

Return Value

bool

in FlaggableInterface at line 92
bool isFlagged()

Determine if the message is flagged.

Return Value

bool

in FlaggableInterface at line 97
bool isDeleted()

Determine if the message is marked as deleted.

Return Value

bool

in FlaggableInterface at line 102
bool isDraft()

Determine if the message is marked as a draft.

Return Value

bool

in FlaggableInterface at line 107
bool isRecent()

Determine if the message is marked as recent.

Return Value

bool

in FlaggableInterface at line 114
array flags()

Get the message's flags.

Return Value

array

in FlaggableInterface at line 119
bool hasFlag(BackedEnum|string $flag)

Determine if the message has the given flag.

Parameters

BackedEnum|string $flag

Return Value

bool

in FlaggableInterface at line 126
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

at line 16
int uid()

Get the message's identifier.

Return Value

int

at line 21
int|null size()

Get the message's size in bytes (RFC822.SIZE).

Return Value

int|null

at line 26
CarbonInterface|null date()

Get the message date and time.

Return Value

CarbonInterface|null

at line 31
string|null subject()

Get the message's subject.

Return Value

string|null

at line 36
Address|null from()

Get the 'From' address.

Return Value

Address|null

at line 41
Address|null sender()

Get the 'Sender' address.

Return Value

Address|null

at line 46
string|null messageId()

Get the message's 'Message-ID'.

Return Value

string|null

at line 51
Address|null replyTo()

Get the 'Reply-To' address.

Return Value

Address|null

at line 58
array inReplyTo()

Get the 'In-Reply-To' message identifier(s).

Return Value

array

at line 65
array to()

Get the 'To' addresses.

Return Value

array

at line 72
array cc()

Get the 'CC' addresses.

Return Value

array

at line 79
array bcc()

Get the 'BCC' addresses.

Return Value

array

at line 86
array attachments()

Get the message's attachments.

Return Value

array

at line 91
bool hasAttachments()

Determine if the message has attachments.

Return Value

bool

at line 96
int attachmentCount()

Get the count of attachments.

Return Value

int

at line 103
array addresses(string $header)

Get addresses from the given header.

Parameters

string $header

Return Value

array

at line 108
string|null html()

Get the message's HTML content.

Return Value

string|null

at line 113
string|null text()

Get the message's text content.

Return Value

string|null

at line 118
array headers()

Get all headers from the message.

Return Value

array

at line 123
IHeader|null header(string $name, int $offset = 0)

Get a header from the message.

Parameters

string $name
int $offset

Return Value

IHeader|null

at line 128
IMessage parse()

Parse the message into a MailMimeMessage instance.

Return Value

IMessage

at line 133
bool is(MessageInterface $message)

Determine if the message is the same as another message.

Parameters

MessageInterface $message

Return Value

bool

at line 138
string __toString()

Get the string representation of the message.

Return Value

string