AfterLogic API Documentation
  • Package
  • Class

Packages

  • Calendar
    • Classes
    • Storages
  • Capability
  • Channels
    • Classes
    • Storages
  • Collaboration
  • Contacts
    • Helpers
    • Storages
  • Dav
  • Db
    • Classes
    • Enum
    • Storages
  • Domains
    • Classes
    • Storages
  • Fetchers
    • Classes
    • Storages
  • Filecache
    • Storages
  • Filestorage
    • Classes
    • Storages
  • GContacts
    • Storages
  • Helpdesk
    • Classes
    • Enum
    • Storages
  • Integrator
  • IOS
  • Logger
  • Mail
    • Classes
    • Enum
    • Storages
  • Mailsuite
    • Classes
    • Storages
  • Min
    • Storages
  • Sieve
    • Classes
    • Enum
  • Social
    • Classes
    • Storages
  • Subscription
    • Classes
  • Subscriptions
    • Storages
  • Tenants
    • Classes
    • Storages
  • Twofactorauth
    • Classes
    • Storages
  • Users
    • Classes
    • Enum
    • Storages
  • Voice
  • WebMail
    • Storages

Classes

  • CApiWebmailManager

Class CApiWebmailManager

CApiWebmailManager class is used for work with essential webmail functions.

AApiManagerWithStorage
Extended by CApiWebmailManager
Package: WebMail
Located at webmail/manager.php

Methods summary

public
# __construct( CApiGlobalManager & $oManager, string $sForcedStorage = '' )

Creates a new instance of the object.

Creates a new instance of the object.

Parameters

$oManager
$oManager Global manager.
$sForcedStorage
Storage name.
public CAccount
# createAccount( string $sEmail, string $sPassword, string $sLanguage = '', array $aExtValues = null, boolean $bAllowInternalOnly = false )

Creates new account.

Creates new account.

Parameters

$sEmail
Account email.
$sPassword
Account password.
$sLanguage
= '' Account language.
$aExtValues
= null Array of extra information about account.
$bAllowInternalOnly
= false If true only internal accounts are allowed.

Returns

CAccount
| false
public boolean
# validateAdminPassword( string $sPassword )

Validates the administrator password.

Validates the administrator password.

Parameters

$sPassword
Administrator password.

Returns

boolean
protected
# _removeDirByTime( string $sTempPath, integer $iTime2Kill, integer $iNow )

Recursively deletes temporary files and folders on time.

Recursively deletes temporary files and folders on time.

Parameters

$sTempPath
Path to the temporary folder.
$iTime2Kill
Interval in seconds at which files needs removing.
$iNow
Current Unix timestamp.
protected boolean
# _removeFilesByTime( string $sTempPath, integer $iTime2Kill, integer $iNow )

Recursively deletes temporary files on time.

Recursively deletes temporary files on time.

Parameters

$sTempPath
Path to the temporary folder.
$iTime2Kill
Interval in seconds at which files needs removing.
$iNow
Current Unix timestamp.

Returns

boolean
AfterLogic API Documentation API documentation generated by ApiGen