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

  • CApiSieveManager

Class CApiSieveManager

AApiManager
Extended by CApiSieveManager
Package: Sieve
Located at sieve/manager.php

Methods summary

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

Parameters

$oManager
$oManager
$sForcedStorage
public array
# getAutoresponder( CAccount $oAccount )

Parameters

$oAccount

Returns

array
public boolean
# setAutoresponder( CAccount $oAccount, string $sSubject, string $sText, boolean $bEnabled = true )

Parameters

$oAccount
$sSubject
$sText
$bEnabled

Returns

boolean
public boolean
# disableAutoresponder( CAccount $oAccount )

Parameters

$oAccount

Returns

boolean
public array|false
# getForward( CAccount $oAccount )

Parameters

$oAccount

Returns

array|false
public boolean
# setForward( CAccount $oAccount, string $sForward, boolean $bEnabled = true )

Parameters

$oAccount
$sForward
$bEnabled
Default true

Returns

boolean
public array|false
# getSieveFilters( CAcount $oAccount )

Parameters

$oAccount

Returns

array|false
public boolean
# updateSieveFilters( CAcount $oAccount, array $aFilters )

Parameters

$oAccount
$aFilters

Returns

boolean
public boolean
# disableForward( CAccount $oAccount, string $sForward,…, boolean $bEnabled,… )

Parameters

$oAccount
$sForward,…
$bEnabled,…
= true

Returns

boolean
public boolean
# resave( CAccount $oAccount, string $sSectionName = '', string $sSectionData = '' )

Parameters

$oAccount
$sSectionName
Default ''
$sSectionData
Default ''

Returns

boolean

Depricated

public string
# getFiltersRawData( CAccount $oAccount )

Parameters

$oAccount

Returns

string
public boolean
# setFiltersRawData( CAccount $oAccount, string $sFiltersRawData )

Parameters

$oAccount
$sFiltersRawData

Returns

boolean
protected MailSo\Sieve\ManageSieveClient|false
# _getSieveDriver( CAccount $oAccount )

Parameters

$oAccount

Returns

MailSo\Sieve\ManageSieveClient|false
protected MailSo\Sieve\ManageSieveClient|false
# _connectSieve( CAccount $oAccount )

Parameters

$oAccount

Returns

MailSo\Sieve\ManageSieveClient|false
protected string|false
# _getSieveFile( CAccount $oAccount )

Parameters

$oAccount

Returns

string|false
protected boolean
# _setSieveFile( CAccount $oAccount, string $sText )

Parameters

$oAccount
$sText

Returns

boolean
protected boolean
# _resaveSectionsData( CAccount $oAccount )

Parameters

$oAccount

Returns

boolean
protected
# _parseSectionsData( CAccount $oAccount, boolean $bForced = false )

Parameters

$oAccount
$bForced
Default false
protected string
# _selectionsDataToString( )

Returns

string
protected string
# _getSectionData( string $sSectionName )

Parameters

$sSectionName

Returns

string
protected
# _setSectionData( string $sSectionName, string $sData )

Parameters

$sSectionName
$sData
protected string
# _getComment( type $sSectionName, type $bIsBeginComment = true )

Parameters

$sSectionName
$bIsBeginComment
Default true

Returns

string
protected array|false
# _getSectionParams( string $sSectionName, string $sText )

Parameters

$sSectionName
$sText

Returns

array|false

Properties summary

public static boolean $AutoSave
# true
protected CApiSieveProtocol $oSieve
#
protected string $sSieveFileName
#
protected array $aSectionsData
#
protected array $aSectionsOrders
#
protected array $aSieves
#
protected string $sGeneralPassword
#
AfterLogic API Documentation API documentation generated by ApiGen