Class CApiMailMessage

CApiMailMessage class summary

Package: Mail\Classes
Located at mail/classes/message.php

Methods summary

`protected`	# `__construct( )`
`public CApiMailMessage`	# `clear( )` Clears all the properties of the message. Clears all the properties of the message. Returns `CApiMailMessage`
`public static CApiMailMessage`	# `createEmptyInstance( )` Creates a new instance of the object. Creates a new instance of the object. Returns `CApiMailMessage`
`public string`	# `getHeaders( )` Returns block of headers of the message. Returns block of headers of the message. Returns string
`public CApiMailMessage`	# `addExtend( string $sName, mixed $mValue )` Allows for joining custom content to mail message, implemented for use of iCal/vCard content. 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. Returns `CApiMailMessage`
`public mixed`	# `getExtend( string $sName )` Returns value set with addExtend method. Returns value set with addExtend method. Parameters `$sName` Extended value to be looked up. Returns mixed
`public CApiMailMessage`	# `addCustom( string $sName, mixed $mValue )` Allows for adding custom values to message object, implemented for use by plugins. Allows for adding custom values to message object, implemented for use by plugins. Parameters `$sName` Name of custom data. `$mValue` Value of custom data. Returns `CApiMailMessage`
`public array`	# `getCustomList( )` Returns a list of values set with addCustom method. Returns a list of values set with addCustom method. Returns array
`public string`	# `getPlain( )` Returns plaintext body of the message. Returns plaintext body of the message. Returns string
`public string`	# `getHtml( )` Returns HTML body of the message. Returns HTML body of the message. Returns string
`public string`	# `getFolder( )` Raw full name of the folder the message resides in. Raw full name of the folder the message resides in. Returns string
`public integer`	# `getUid( )` UID value of the message. UID value of the message. Returns integer
`public string`	# `getMessageId( )` Value of Message-ID header. Value of Message-ID header. Returns string
`public string`	# `getSubject( )` Subject of the message. Subject of the message. Returns string
`public string`	# `getContentType( )` Content-Type value of the message. Content-Type value of the message. Returns string
`public integer`	# `getSize( )` Message size in bytes. Message size in bytes. Returns integer
`public integer`	# `getTextSize( )` Total size of text parts of the message in bytes. Total size of text parts of the message in bytes. Returns integer
`public integer`	# `getInternalTimeStamp( )` Returns timestamp information of the message in UTC/GMT. Returns timestamp information of the message in UTC/GMT. Returns integer
`public integer`	# `getReceivedOrDateTimeStamp( )` Returns UTC timestamp of the message, checking through various sources including Received and Date headers. Returns UTC timestamp of the message, checking through various sources including Received and Date headers. Returns integer
`public array`	# `getFlags( )` Returns list of message flags. Returns list of message flags. Returns array
`public array`	# `getFlagsLowerCase( )` Returns list of message flags converted to lower case. Returns list of message flags converted to lower case. Returns array
`public MailSo\Mime\EmailCollection`	# `getFrom( )` 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. 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. Returns MailSo\Mime\EmailCollection
`public MailSo\Mime\EmailCollection`	# `getSender( )` 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. 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. Returns MailSo\Mime\EmailCollection
`public MailSo\Mime\EmailCollection`	# `getReplyTo( )` Returns value of Reply-To header. Returns value of Reply-To header. Returns MailSo\Mime\EmailCollection
`public MailSo\Mime\EmailCollection`	# `getTo( )` List of To addresses of the message. List of To addresses of the message. Returns MailSo\Mime\EmailCollection
`public MailSo\Mime\EmailCollection`	# `getCc( )` List of CC addresses of the message. List of CC addresses of the message. Returns MailSo\Mime\EmailCollection
`public MailSo\Mime\EmailCollection`	# `getBcc( )` List of BCC addresses of the message. List of BCC addresses of the message. Returns MailSo\Mime\EmailCollection
`public string`	# `getInReplyTo( )` 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. 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. Returns string
`public string`	# `getReferences( )` Returns the content of References header block of the message. Returns the content of References header block of the message. Returns string
`public integer`	# `getSensitivity( )` If Sensitivity header was set for the message, its value will be returned: 1 for "Confidential", 2 for "Private", 3 for "Personal". If Sensitivity header was set for the message, its value will be returned: 1 for "Confidential", 2 for "Private", 3 for "Personal". Returns integer
`public integer`	# `getPriority( )` Returns priority value of the message, from 1 (highest) to 5 (lowest). Returns priority value of the message, from 1 (highest) to 5 (lowest). Returns integer
`public boolean`	# `getSafety( )` The method returns indication of whether the sender is trustworthy so it's safe to display external images. The method returns indication of whether the sender is trustworthy so it's safe to display external images. Returns boolean
`public string`	# `getReadingConfirmation( )` Returns email address reading confirmation is to be sent to. Returns email address reading confirmation is to be sent to. Returns string
`public`	# `setSafety( boolean $bSafety )` The method allows for indication of whether the sender is trustworthy so it's safe to display external images. 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 CApiMailAttachmentCollection`	# `getAttachments( )` Returns information about the attachments of the message. Returns information about the attachments of the message. Returns `CApiMailAttachmentCollection`
`public array`	# `getDraftInfo( )` Contains information about the original message which is replied or forwarded: message type (reply/forward), UID and folder. Contains information about the original message which is replied or forwarded: message type (reply/forward), UID and folder. Returns array \| null
`public array`	# `getThreads( )` Threading information such as UIDs of messages in the thread. Threading information such as UIDs of messages in the thread. Returns array
`public`	# `setThreads( array $aThreads )` Updates information about the message by supplying threading information such as UIDs of messages in the thread. Updates information about the message by supplying threading information such as UIDs of messages in the thread. Parameters `$aThreads`
`public static CApiMailMessage`	# `createInstance( string $sRawFolderFullName, MailSo\Imap\FetchResponse $oFetchResponse, MailSo\Imap\BodyStructure $oBodyStructure = null, string $sRfc822SubMimeIndex = '', array $aAscPartsIds = array() )` Creates and initializes instance of the object. 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. `$aAscPartsIds` = array(). List of message parts wich is .asc files. It is need for setting content in it's CApiMailAttachment object. Returns `CApiMailMessage`
`public CApiMailMessage`	# `initialize( string $sRawFolderFullName, MailSo\Imap\FetchResponse $oFetchResponse, MailSo\Imap\BodyStructure $oBodyStructure = null, string $sRfc822SubMimeIndex = '', array $aAscPartsIds = array() )` Advanced method which allows for creating messages invoking MailSo library built into the product. Advanced method which allows for creating messages invoking MailSo library built into the product. 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. `$aAscPartsIds` = array(). List of message parts wich is .asc files. It is need for setting content in it's CApiMailAttachment object. Returns `CApiMailMessage`

Properties summary

`protected string`	`$sFolder` Raw full name of the folder the message resides in. Raw full name of the folder the message resides in.	#
`protected integer`	`$iUid` UID value of the message. UID value of the message.	#
`protected string`	`$sSubject` Subject of the message. Subject of the message.	#
`protected string`	`$sMessageId` Value of Message-ID header. Value of Message-ID header.	#
`protected string`	`$sContentType` Content-Type value of the message. Content-Type value of the message.	#
`protected integer`	`$iSize` Message size in bytes. Message size in bytes.	#
`protected integer`	`$iTextSize` Total size of text parts of the message in bytes. Total size of text parts of the message in bytes.	#
`protected integer`	`$iInternalTimeStampInUTC` Timestamp information of the message in UTC/GMT. Timestamp information of the message in UTC/GMT.	#
`protected integer`	`$iReceivedOrDateTimeStampInUTC` UTC timestamp of the message, checking through various sources including Received and Date headers. UTC timestamp of the message, checking through various sources including Received and Date headers.	#
`protected array`	`$aFlags` List of message flags. List of message flags.	#
`protected array`	`$aFlagsLowerCase` List of message flags converted to lower case. List of message flags converted to lower case.	#
`protected MailSo\Mime\EmailCollection`	`$oFrom` 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. 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.	#
`protected MailSo\Mime\EmailCollection`	`$oSender` 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. 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.	#
`protected MailSo\Mime\EmailCollection`	`$oReplyTo` Value of Reply-To header. Value of Reply-To header.	#
`protected MailSo\Mime\EmailCollection`	`$oTo` List of To addresses of the message. List of To addresses of the message.	#
`protected MailSo\Mime\EmailCollection`	`$oCc` List of CC addresses of the message. List of CC addresses of the message.	#
`protected MailSo\Mime\EmailCollection`	`$oBcc` List of BCC addresses of the message. List of BCC addresses of the message.	#
`protected string`	`$sInReplyTo` 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. 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.	#
`protected string`	`$sReferences` Content of References header block of the message. Content of References header block of the message.	#
`protected string`	`$sPlain` Plaintext body of the message. Plaintext body of the message.	#
`protected string`	`$sHtml` HTML body of the message. HTML body of the message.	#
`protected integer`	`$iSensitivity` If Sensitivity header was set for the message, its value will be returned: 1 for "Confidential", 2 for "Private", 3 for "Personal". If Sensitivity header was set for the message, its value will be returned: 1 for "Confidential", 2 for "Private", 3 for "Personal".	#
`protected integer`	`$iPriority` Priority value of the message, from 1 (highest) to 5 (lowest). Priority value of the message, from 1 (highest) to 5 (lowest).	#
`protected string`	`$sReadingConfirmation` Email address reading confirmation is to be sent to. Email address reading confirmation is to be sent to.	#
`protected boolean`	`$bSafety` Indication of whether the sender is trustworthy so it's safe to display external images. Indication of whether the sender is trustworthy so it's safe to display external images.	#
`protected CApiMailAttachmentCollection`	`$oAttachments` Information about the attachments of the message. Information about the attachments of the message.	#

Packages

Classes

Class CApiMailMessage

Methods summary

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Parameters

Returns

Parameters

Returns

Properties summary