1. class
  2. DirectoryTree
  3. \
  4. ImapEngine
  5. \
  6. Message

Message

class Message implements Arrayable, JsonSerializable, MessageInterface (View source)

Traits

HasFlags
HasParsedMessage

Properties

protected IMessage|null $parsed

The parsed message.

 from  HasParsedMessage
protected BodyStructureCollection|null $bodyStructure

The parsed body structure.

Methods

void
markRead()

{@inheritDoc}

from  HasFlags
void
markUnread()

{@inheritDoc}

from  HasFlags
void
markSeen()

{@inheritDoc}

from  HasFlags
void
unmarkSeen()

{@inheritDoc}

from  HasFlags
void
markAnswered()

{@inheritDoc}

from  HasFlags
void
unmarkAnswered()

{@inheritDoc}

from  HasFlags
void
markFlagged()

{@inheritDoc}

from  HasFlags
void
unmarkFlagged()

{@inheritDoc}

from  HasFlags
void
markDeleted(bool $expunge = false)

{@inheritDoc}

from  HasFlags
void
unmarkDeleted()

{@inheritDoc}

from  HasFlags
void
markDraft()

{@inheritDoc}

from  HasFlags
void
unmarkDraft()

{@inheritDoc}

from  HasFlags
void
markRecent()

{@inheritDoc}

from  HasFlags
void
unmarkRecent()

{@inheritDoc}

from  HasFlags
bool
isSeen()

{@inheritDoc}

from  HasFlags
bool
isAnswered()

{@inheritDoc}

from  HasFlags
bool
isFlagged()

{@inheritDoc}

from  HasFlags
bool
isDeleted()

{@inheritDoc}

from  HasFlags
bool
isDraft()

{@inheritDoc}

from  HasFlags
bool
isRecent()

{@inheritDoc}

from  HasFlags
bool
hasFlag(BackedEnum|string $flag)

{@inheritDoc}

from  HasFlags
array
flags()

Get the message's flags.

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

Add or remove a flag from the message.

CarbonInterface|null
date()

Get the message date and time.

from  HasParsedMessage
string|null
messageId()

Get the message's message-id.

from  HasParsedMessage
string|null
subject()

Get the message's subject.

from  HasParsedMessage
Address|null
from()

Get the FROM address.

from  HasParsedMessage
Address|null
sender()

Get the SENDER address.

from  HasParsedMessage
Address|null
replyTo()

Get the REPLY-TO address.

from  HasParsedMessage
array
inReplyTo()

Get the IN-REPLY-TO message identifier(s).

from  HasParsedMessage
array
to()

Get the TO addresses.

from  HasParsedMessage
array
cc()

Get the CC addresses.

from  HasParsedMessage
array
bcc()

Get the BCC addresses.

from  HasParsedMessage
array
attachments()

Get the message's attachments.

from  HasParsedMessage
bool
hasAttachments()

Determine if the message has attachments.

from  HasParsedMessage
int
attachmentCount()

Get the count of attachments.

from  HasParsedMessage
bool
isForwardedMessage(IMessagePart $part)

Determine if the attachment should be treated as an embedded forwarded message.

from  HasParsedMessage
array
addresses(string $header)

Get addresses from the given header.

from  HasParsedMessage
string|null
html()

Get the message's HTML content.

from  HasParsedMessage
string|null
text()

Get the message's text content.

from  HasParsedMessage
array
headers()

Get all headers from the message.

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

Get a header from the message.

from  HasParsedMessage
IMessage
parse()

Parse the message into a MailMimeMessage instance.

from  HasParsedMessage
bool
isEmpty()

Determine if the message is empty.

string
__toString()

Get the string representation of the message.

__construct(FolderInterface $folder, int $uid, array $flags, string $head, string $body, int|null $size = null, ListData|null $bodyStructureData = null)

Constructor.

array
__sleep()

Get the names of properties that should be serialized.

FolderInterface
folder()

Get the message's folder.

int
uid()

Get the message's identifier.

int|null
size()

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

string
head()

Get the message's raw headers.

bool
hasHead()

Determine if the message has headers.

string
body()

Get the message's raw body.

bool
hasBody()

Determine if the message has contents.

BodyStructureCollection|null
bodyStructure()

Get the message's body structure.

bool
hasBodyStructure()

Determine if the message has body structure data.

bool
is(MessageInterface $message)

Determine if the message is the same as another message.

int|null
copy(string $folder)

Copy the message to the given folder.

int|null
move(string $folder, bool $expunge = false)

Move the message to the given folder.

string|null
bodyPart(string $partNumber, bool $peek = true)

Fetch a specific body part by part number.

void
delete(bool $expunge = false)

Delete the message.

void
restore()

Restore the message.

array
toArray()

Get the array representation of the message.

array
jsonSerialize()

Get the JSON representation of the message.

Details

in HasFlags at line 14
void markRead()

{@inheritDoc}

Return Value

void

in HasFlags at line 22
void markUnread()

{@inheritDoc}

Return Value

void

in HasFlags at line 30
void markSeen()

{@inheritDoc}

Return Value

void

in HasFlags at line 38
void unmarkSeen()

{@inheritDoc}

Return Value

void

in HasFlags at line 46
void markAnswered()

{@inheritDoc}

Return Value

void

in HasFlags at line 54
void unmarkAnswered()

{@inheritDoc}

Return Value

void

in HasFlags at line 62
void markFlagged()

{@inheritDoc}

Return Value

void

in HasFlags at line 70
void unmarkFlagged()

{@inheritDoc}

Return Value

void

in HasFlags at line 78
void markDeleted(bool $expunge = false)

{@inheritDoc}

Parameters

bool $expunge

Return Value

void

in HasFlags at line 86
void unmarkDeleted()

{@inheritDoc}

Return Value

void

in HasFlags at line 94
void markDraft()

{@inheritDoc}

Return Value

void

in HasFlags at line 102
void unmarkDraft()

{@inheritDoc}

Return Value

void

in HasFlags at line 110
void markRecent()

{@inheritDoc}

Return Value

void

in HasFlags at line 118
void unmarkRecent()

{@inheritDoc}

Return Value

void

in HasFlags at line 126
bool isSeen()

{@inheritDoc}

Return Value

bool

in HasFlags at line 134
bool isAnswered()

{@inheritDoc}

Return Value

bool

in HasFlags at line 142
bool isFlagged()

{@inheritDoc}

Return Value

bool

in HasFlags at line 150
bool isDeleted()

{@inheritDoc}

Return Value

bool

in HasFlags at line 158
bool isDraft()

{@inheritDoc}

Return Value

bool

in HasFlags at line 166
bool isRecent()

{@inheritDoc}

Return Value

bool

in HasFlags at line 174
bool hasFlag(BackedEnum|string $flag)

{@inheritDoc}

Parameters

BackedEnum|string $flag

Return Value

bool

at line 71
array flags()

Get the message's flags.

Return Value

array

at line 148
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

in HasParsedMessage at line 29
CarbonInterface|null date()

Get the message date and time.

Return Value

CarbonInterface|null

in HasParsedMessage at line 49
string|null messageId()

Get the message's message-id.

Return Value

string|null

in HasParsedMessage at line 57
string|null subject()

Get the message's subject.

Return Value

string|null

in HasParsedMessage at line 65
Address|null from()

Get the FROM address.

Return Value

Address|null

in HasParsedMessage at line 73
Address|null sender()

Get the SENDER address.

Return Value

Address|null

in HasParsedMessage at line 81
Address|null replyTo()

Get the REPLY-TO address.

Return Value

Address|null

in HasParsedMessage at line 91
array inReplyTo()

Get the IN-REPLY-TO message identifier(s).

Return Value

array

in HasParsedMessage at line 107
array to()

Get the TO addresses.

Return Value

array

in HasParsedMessage at line 117
array cc()

Get the CC addresses.

Return Value

array

in HasParsedMessage at line 127
array bcc()

Get the BCC addresses.

Return Value

array

in HasParsedMessage at line 137
array attachments()

Get the message's attachments.

Return Value

array

in HasParsedMessage at line 163
bool hasAttachments()

Determine if the message has attachments.

Return Value

bool

in HasParsedMessage at line 171
int attachmentCount()

Get the count of attachments.

Return Value

int

in HasParsedMessage at line 179
protected bool isForwardedMessage(IMessagePart $part)

Determine if the attachment should be treated as an embedded forwarded message.

Parameters

IMessagePart $part

Return Value

bool

in HasParsedMessage at line 191
array addresses(string $header)

Get addresses from the given header.

Parameters

string $header

Return Value

array

in HasParsedMessage at line 208
string|null html()

Get the message's HTML content.

Return Value

string|null

in HasParsedMessage at line 216
string|null text()

Get the message's text content.

Return Value

string|null

in HasParsedMessage at line 224
array headers()

Get all headers from the message.

Return Value

array

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

Get a header from the message.

Parameters

string $name
int $offset

Return Value

IHeader|null

in HasParsedMessage at line 240
IMessage parse()

Parse the message into a MailMimeMessage instance.

Return Value

IMessage

at line 295
bool isEmpty()

Determine if the message is empty.

Return Value

bool

at line 276
string __toString()

Get the string representation of the message.

Return Value

string

at line 25
__construct(FolderInterface $folder, int $uid, array $flags, string $head, string $body, int|null $size = null, ListData|null $bodyStructureData = null)

Constructor.

Parameters

FolderInterface $folder
int $uid
array $flags
string $head
string $body
int|null $size
ListData|null $bodyStructureData

at line 38
array __sleep()

Get the names of properties that should be serialized.

Return Value

array

at line 47
FolderInterface folder()

Get the message's folder.

Return Value

FolderInterface

at line 55
int uid()

Get the message's identifier.

Return Value

int

at line 63
int|null size()

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

Return Value

int|null

at line 79
string head()

Get the message's raw headers.

Return Value

string

at line 87
bool hasHead()

Determine if the message has headers.

Return Value

bool

at line 95
string body()

Get the message's raw body.

Return Value

string

at line 103
bool hasBody()

Determine if the message has contents.

Return Value

bool

at line 111
BodyStructureCollection|null bodyStructure()

Get the message's body structure.

Return Value

BodyStructureCollection|null

at line 130
bool hasBodyStructure()

Determine if the message has body structure data.

Return Value

bool

at line 138
bool is(MessageInterface $message)

Determine if the message is the same as another message.

Parameters

MessageInterface $message

Return Value

bool

at line 169
int|null copy(string $folder)

Copy the message to the given folder.

Parameters

string $folder

Return Value

int|null

at line 191
int|null move(string $folder, bool $expunge = false)

Move the message to the given folder.

Parameters

string $folder
bool $expunge

Return Value

int|null

Exceptions

ImapCapabilityException

at line 224
string|null bodyPart(string $partNumber, bool $peek = true)

Fetch a specific body part by part number.

Parameters

string $partNumber
bool $peek

Return Value

string|null

at line 246
void delete(bool $expunge = false)

Delete the message.

Parameters

bool $expunge

Return Value

void

at line 254
void restore()

Restore the message.

Return Value

void

at line 262
array toArray()

Get the array representation of the message.

Return Value

array

at line 287
array jsonSerialize()

Get the JSON representation of the message.

Return Value

array