Class CAccount

CAccount summary

api_AContainer

CAccount

Package: Users\Classes
Located at users/classes/account.php

Methods summary

`public`	# `__construct( CDomain $oDomain )` Creates a new instance of the object. Creates a new instance of the object. Parameters `$oDomain` CDomain object for the account.
`public static CAccount`	# `createInstance( CDomain $oDomain )` Creates new empty instance of the account. Creates new empty instance of the account. Parameters `$oDomain` Domain list entry used to populate default values. Returns `CAccount`
`public integer`	# `getDefaultTimeOffset( )` Obtains timezone offset value in minutes. Obtains timezone offset value in minutes. Returns integer
`public string`	# `getDefaultStrTimeZone( )` Obtains timezone information. Obtains timezone information. Returns string
`public`	# `enableExtension( string $sExtensionName )` Enables particular functionality extension. Enables particular functionality extension. Parameters `$sExtensionName` Name of extension to enable.
`public`	# `disableExtension( string $sExtensionName )` Disables particular functionality extension. Disables particular functionality extension. Parameters `$sExtensionName` Name of extension to disable.
`public boolean`	# `isExtensionEnabled( string $sExtensionName )` Checks whether particular functionality extension is enabled. Checks whether particular functionality extension is enabled. Parameters `$sExtensionName` Name of extension for checking. Returns boolean
`public array`	# `getExtensionList( )` Obtains list of extensions currently enabled for the account. Obtains list of extensions currently enabled for the account. Returns array
`public`	# `initLoginAndEmail( string $sLogin, string $sAtChar = '@' )` Initializes Login and Email fields. Initializes Login and Email fields. Parameters `$sLogin` New login for account. `$sAtChar` = '@' Symbol to join login and domain parts.
`public`	# `initByDbRow( stdClass $oRow )` Initializes account object by data from database. Initializes account object by data from database. Parameters `$oRow` Db row.
`public`	# `initBeforeChange( )` Initialize account object before it's changing. Function with the same name is used for other objects in a unified container api_AContainer. Initialize account object before it's changing. Function with the same name is used for other objects in a unified container api_AContainer.
`public string`	# `getFriendlyEmail( )` If display name is non-empty, returns email address with display name attached; otherwise, just the email. If display name is non-empty, returns email address with display name attached; otherwise, just the email. Returns string
`public boolean`	# `isGmailAccount( )` Performs a check whether account is hosted by GMail, by comparing IMAP hostname with known values. Performs a check whether account is hosted by GMail, by comparing IMAP hostname with known values. Returns boolean
`public boolean`	# `isValid( )` Checks if the account can connect to the mail server. Checks if the account can connect to the mail server. Returns boolean
`public array`	# `getMap( )` Obtains static map of account fields. Function with the same name is used for other objects in a unified container api_AContainer. Obtains static map of account fields. Function with the same name is used for other objects in a unified container api_AContainer. Returns array
`public integer`	# `getRealQuotaSize( )` Gets actual quota information in bytes. Gets actual quota information in bytes. Returns integer
`public static array`	# `getStaticMap( )` Obtains static map of account fields. Obtains static map of account fields. Returns array
`public boolean`	# `canLoginWithPassword( )` Can account login with password. Can account login with password. Returns boolean

Constants summary

`string`	`ChangePasswordExtension`	# `'AllowChangePasswordExtension'`
`string`	`AutoresponderExtension`	# `'AllowAutoresponderExtension'`
`string`	`SpamFolderExtension`	# `'AllowSpamFolderExtension'`
`string`	`DisableAccountDeletion`	# `'DisableAccountDeletion'`
`string`	`DisableManageFolders`	# `'DisableManageFolders'`
`string`	`SieveFiltersExtension`	# `'AllowSieveFiltersExtension'`
`string`	`ForwardExtension`	# `'AllowForwardExtension'`
`string`	`DisableManageSubscribe`	# `'DisableManageSubscribe'`
`string`	`DisableFoldersManualSort`	# `'DisableFoldersManualSort'`
`string`	`IgnoreSubscribeStatus`	# `'IgnoreSubscribeStatus'`

Properties summary

`public CUser`	`$User` CUser object for the account. CUser object for the account.	#
`public CDomain`	`$Domain` CDomain object for the account. CDomain object for the account.	#
`protected array`	`$aExtension`	#

Magic properties

`public integer`	`$IdAccount` Account's ID.
`public integer`	`$IdUser` User ID.
`public integer`	`$IdDomain` Domain's ID.
`public integer`	`$IdTenant` Tenant's ID (Aurora only).
`public boolean`	`$IsInternal` If true, the account is hosted by bundled mailserver.
`public boolean`	`$IsDisabled` If true, the account is disabled by the administrator.
`public boolean`	`$IsDefaultAccount` If true, it's the primary account of this user, their other accounts are linked ones.
`public boolean`	`$IsMailingList` If true, the account denotes mailing list rather than regular email account.
`public integer`	`$StorageQuota` Account storage quota.
`public integer`	`$StorageUsedSpace` Disk space currently used by the account.
`public string`	`$Email` Email address of the account.
`public string`	`$FriendlyName` Display name of the account.
`public integer`	`$IncomingMailProtocol` deprecated.
`public string`	`$IncomingMailServer` IMAP server's hostname or IP address.
`public integer`	`$IncomingMailPort` IMAP server port.
`public string`	`$IncomingMailLogin` IMAP login value.
`public string`	`$IncomingMailPassword` Account password on IMAP.
`public boolean`	`$IncomingMailUseSSL` If true, SSL access is used to access IMAP.
`public string`	`$PreviousMailPassword` Account password stored in the database, may differ for actual password entered by user, e.g. if password was changed on mailserver.
`public string`	`$OutgoingMailServer` SMTP server's hostname or IP address.
`public integer`	`$OutgoingMailPort` SMTP server port.
`public string`	`$OutgoingMailLogin` SMTP login value.
`public string`	`$OutgoingMailPassword` Account password on SMTP.
`public integer`	`$OutgoingMailAuth` Denotes whether SMTP authentication is used.
`public boolean`	`$OutgoingMailUseSSL` If true, SSL access is used to access SMTP.
`public integer`	`$OutgoingSendingMethod` Reserved for future use.
`public boolean`	`$HideInGAB` If set to true, account will be excluded from global address book.
`public string`	`$Signature` Account's signature.
`public integer`	`$SignatureType` 0 for plaintext signature, 1 for HTML one.
`public integer`	`$SignatureOptions` 0 means signature isn't used, 1 means signature is added to new messages only, 2 - added to all messages.
`public integer`	`$GlobalAddressBook` Defines mode of presenting the account in global address book.
`public boolean`	`$AllowCompose` true if composing new messages is allowed for the account.
`public boolean`	`$AllowReply` true if replying to messages is allowed for the account.
`public boolean`	`$AllowForward` true if forwarding messages is allowed for the account.
`public boolean`	`$DetectSpecialFoldersWithXList` If set to true, WebMail attempts to locate system folders using XLIST extension of IMAP.
`public mixed`	`$CustomFields`
`public boolean`	`$ForceSaveOnLogin` If set to true, account settings will always be updated on login. Default value is false.
`public boolean`	`$AllowMail`
`public boolean`	`$IsPasswordSpecified`

Packages

Classes

Class CAccount

Methods summary

Parameters

Parameters

Returns

Returns

Returns

Parameters

Parameters

Parameters

Returns

Returns

Parameters

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Constants summary

Properties summary

Magic properties