Class Aurora\Modules\Mail\Classes\Message


					
	public

clear(): Message

Clears all the properties of the message.

#


					
	public
					static

createEmptyInstance(): Message

Creates a new instance of the object.

#


					
	public

getHeaders(): string

Returns block of headers of the message.

#


					
	public

addExtend(string $sName, mixed $mValue): Message

Allows for joining custom content to mail message, implemented for use of iCal/vCard content.

Parameters

`$sName`	Name of the custom content.
`$mValue`	Value of the custom content.

#


					
	public

getExtend(string $sName): mixed

Returns value set with **addExtend** method.

Returns value set with addExtend method.

Parameters

$sName

Extended value to be looked up.

#


					
	public

addCustom(string $sName, mixed $mValue): Message

Allows for adding custom values to message object, implemented for use by plugins.

Parameters

`$sName`	Name of custom data.
`$mValue`	Value of custom data.

#


					
	public

getCustomList(): array

Returns a list of values set with **addCustom** method.

Returns a list of values set with addCustom method.

#


					
	public

getPlain(): string

Returns plaintext body of the message.

#


					
	public

getHtml(): string

Returns HTML body of the message.

#


					
	public

getAccountId()

#


					
	public

setAccountId($iAccountId)

#


					
	public

getFolder(): string

Raw full name of the folder the message resides in.

#


					
	public

getUid(): int

UID value of the message.

#


					
	public

getUnifiedUid(): int

Unified UID value of the message.

#


					
	public

setUnifiedUid($sUnifiedUid)

#


					
	public

getMessageId(): string

Value of Message-ID header.

#


					
	public

getSubject(): string

Subject of the message.

#


					
	public

getContentType(): string

Content-Type value of the message.

#


					
	public

getSize(): int

Message size in bytes.

#


					
	public

getTextSize(): int

Total size of text parts of the message in bytes.

#


					
	public

getInternalTimeStamp(): int

Returns timestamp information of the message in UTC/GMT.

#


					
	public

getReceivedOrDateTimeStamp(): int

Returns UTC timestamp of the message, checking through various sources including Received and Date headers.

#


					
	public

getFlags(): array

Returns list of message flags.

#


					
	public

getFlagsLowerCase(): array

Returns list of message flags converted to lower case.

#


					
	public

getFrom(): EmailCollection

List of From addresses in the message. Though in most cases it's just one address, it's possible to have multiple From…

List of From addresses in the message. Though in most cases it's just one address, it's possible to have multiple From entries in the same message.

#


					
	public

getSender(): EmailCollection

List of Sender addresses in the message. Though in most cases it's just one address, it's possible to have multiple…

List of Sender addresses in the message. Though in most cases it's just one address, it's possible to have multiple Sender entries in the same message.

#


					
	public

getReplyTo(): EmailCollection

Returns value of Reply-To header.

#


					
	public

getTo(): EmailCollection

List of To addresses of the message.

#


					
	public

getCc(): EmailCollection

List of CC addresses of the message.

#


					
	public

getBcc(): EmailCollection

List of BCC addresses of the message.

#


					
	public

getInReplyTo(): string

Returns value of *In-Reply-To* header which is supplied in replies/forwards and contains Message-ID of the original…

Returns value of In-Reply-To header which is supplied in replies/forwards and contains Message-ID of the original message. This approach allows for organizing threads.

#


					
	public

getReferences(): string

Returns the content of References header block of the message.

#


					
	public

getSensitivity(): int

If Sensitivity header was set for the message, its value will be returned: 1 for "Confidential", 2 for "Private", 3 for…

If Sensitivity header was set for the message, its value will be returned: 1 for "Confidential", 2 for "Private", 3 for "Personal".

#


					
	public

getImportance(): int

Returns importance value of the message, from 1 (highest) to 5 (lowest).

#


					
	public

getSafety(): bool

The method returns indication of whether the sender is trustworthy so it's safe to display external images.

#


					
	public

getReadingConfirmation(): string

Returns email address reading confirmation is to be sent to.

#


					
	public

setSafety(bool $bSafety): void

The method allows for indication of whether the sender is trustworthy so it's safe to display external images.

Parameters

$bSafety

If true displaying external images is allowed.

#


					
	public

getAttachments(): AttachmentCollection

Returns information about attachments of the message.

#


					
	public

getDraftInfo(): array|null

Contains information about the original message which is replied or forwarded: message type (reply/forward), UID and…

Contains information about the original message which is replied or forwarded: message type (reply/forward), UID and folder.

#


					
	public

getThreads(): array

Threading information such as UIDs of messages in the thread.

#


					
	public

setThreads(array $aThreads)

Updates information about the message by supplying threading information such as UIDs of messages in the thread.

#


					
	public

getHeadersCollection(): HeaderCollection

Get a collection of headers.

#


					
	public

parseUnsubscribeHeaders(): array

#


					
	public
					static

createInstance(
	string $sRawFolderFullName,
	FetchResponse $oFetchResponse,
	BodyStructure $oBodyStructure = null,
	string $sRfc822SubMimeIndex = '',
	$bTruncated = false,
): Message

Creates and initializes instance of the object.

Parameters

`$sRawFolderFullName`	Raw full name of the folder that contains the message.
`$oFetchResponse`	FetchResponse object.
`$oBodyStructure`	= null. BodyStructure object.
`$sRfc822SubMimeIndex`	= ''. Index at which a message is taken to parse. Index is used if the message is another message attachment.

#


					
	public

toResponseArray($aParameters = [])

#

Namespaces

Classes

Parameters

Parameters

Parameters

Parameters

Parameters