Class CApiMailAttachment

CApiMailAttachment class is used for work with attachment.

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

Methods summary

`protected`	# `__construct( )`
`public CApiMailAttachment`	# `clear( )` Clears all fields of the object. Clears all fields of the object. Returns `CApiMailAttachment`
`public string`	# `getFolder( )` Returns full name of the folder in which there is the message that contains the attachment. Returns full name of the folder in which there is the message that contains the attachment. Returns string
`public integer`	# `getUid( )` Returns uid of the message that contains the attachment. Returns uid of the message that contains the attachment. Returns integer
`public string`	# `getContent( )` Returns content of the attachment. It is used only for files with .asc extension. Returns content of the attachment. It is used only for files with .asc extension. Returns string
`public`	# `setContent( string $sContent )` Fills content of the attachment. It is used only for files with .asc extension. Fills content of the attachment. It is used only for files with .asc extension. Parameters `$sContent`
`public string`	# `getMimeIndex( )` Returns part identifier of the attachment in the message. Returns part identifier of the attachment in the message. Returns string
`public string`	# `getFileName( $bCalculateOnEmpty = false )` Returns file name of the attachment. Returns file name of the attachment. Returns string
`public string`	# `getMimeType( )` Returns mime type of the attachment. Returns mime type of the attachment. Returns string
`public string`	# `getEncoding( )` Returns encoding that encodes content of the attachment. Returns encoding that encodes content of the attachment. Returns string
`public integer`	# `getEstimatedSize( )` Returns estimated size of decoded attachment content. Returns estimated size of decoded attachment content. Returns integer
`public string`	# `getCid( )` Returns content identifier of the attachment. Returns content identifier of the attachment. Returns string
`public string`	# `getContentLocation( )` Returns content location of the attachment. Returns content location of the attachment. Returns string
`public boolean`	# `isInline( )` Returns true if the attachment is marked as inline attachment in it's headers. Returns true if the attachment is marked as inline attachment in it's headers. Returns boolean
`public boolean`	# `isVcard( )` Returns true if the attachment is contact card. Returns true if the attachment is contact card. Returns boolean
`public boolean`	# `isIcal( )` Returns true if the attachment is calendar event or calendar appointment. Returns true if the attachment is calendar event or calendar appointment. Returns boolean
`public static CApiMailAttachment`	# `createEmptyInstance( )` Creates new empty instance. Creates new empty instance. Returns `CApiMailAttachment`
`public static CApiMailAttachment`	# `createInstance( string $sFolder, integer $iUid, MailSo\Imap\BodyStructure $oBodyStructure )` Creates and initializes new instance. Creates and initializes new instance. Parameters `$sFolder` Full name of the folder in which there is the message that contains the attachment. `$iUid` Uid of the message that contains the attachment. `$oBodyStructure` Body structure of the message part that contains the attachment. Returns `CApiMailAttachment`
`public CApiMailAttachment`	# `initialize( string $sFolder, integer $iUid, MailSo\Imap\BodyStructure $oBodyStructure )` Initializes object fields. Initializes object fields. Parameters `$sFolder` Full name of the folder in which there is the message that contains the attachment. `$iUid` Uid of the message that contains the attachment. `$oBodyStructure` Body structure of the message part that contains the attachment. Returns `CApiMailAttachment`

Properties summary

`protected string`	`$sFolder` Full name of the folder in which there is the message that contains the attachment. Full name of the folder in which there is the message that contains the attachment.	#
`protected integer`	`$iUid` Uid of the message that contains the attachment. Uid of the message that contains the attachment.	#
`protected string`	`$sContent` Content of the attachment. It is used only for files with .asc extension. Content of the attachment. It is used only for files with .asc extension.	#
`protected MailSo\Imap\BodyStructure`	`$oBodyStructure` Body structure of the message part that contains the attachment. Body structure of the message part that contains the attachment.	#