Overview

Packages

  • Horde
    • Icalendar
      • UnitTests
  • Ingo
    • UnitTests
  • None

Classes

  • Horde_Core_Ui_VarRenderer_Ingo
  • Ingo
  • Ingo_Api
  • Ingo_Exception
  • Ingo_Exception_Pear
  • Ingo_LoginTasks_SystemTask_Upgrade
  • Ingo_Script
  • Ingo_Script_Imap
  • Ingo_Script_Imap_Api
  • Ingo_Script_Imap_Live
  • Ingo_Script_Maildrop
  • Ingo_Script_Maildrop_Comment
  • Ingo_Script_Maildrop_Recipe
  • Ingo_Script_Maildrop_Variable
  • Ingo_Script_Procmail
  • Ingo_Script_Procmail_Comment
  • Ingo_Script_Procmail_Recipe
  • Ingo_Script_Procmail_Variable
  • Ingo_Script_Sieve
  • Ingo_Script_Sieve_Action
  • Ingo_Script_Sieve_Action_Addflag
  • Ingo_Script_Sieve_Action_Discard
  • Ingo_Script_Sieve_Action_Fileinto
  • Ingo_Script_Sieve_Action_Flag
  • Ingo_Script_Sieve_Action_Keep
  • Ingo_Script_Sieve_Action_Notify
  • Ingo_Script_Sieve_Action_Redirect
  • Ingo_Script_Sieve_Action_Reject
  • Ingo_Script_Sieve_Action_Removeflag
  • Ingo_Script_Sieve_Action_Stop
  • Ingo_Script_Sieve_Action_Vacation
  • Ingo_Script_Sieve_Comment
  • Ingo_Script_Sieve_Else
  • Ingo_Script_Sieve_Elsif
  • Ingo_Script_Sieve_If
  • Ingo_Script_Sieve_Test
  • Ingo_Script_Sieve_Test_Address
  • Ingo_Script_Sieve_Test_Allof
  • Ingo_Script_Sieve_Test_Anyof
  • Ingo_Script_Sieve_Test_Body
  • Ingo_Script_Sieve_Test_Exists
  • Ingo_Script_Sieve_Test_False
  • Ingo_Script_Sieve_Test_Header
  • Ingo_Script_Sieve_Test_Not
  • Ingo_Script_Sieve_Test_Relational
  • Ingo_Script_Sieve_Test_Size
  • Ingo_Script_Sieve_Test_True
  • Ingo_Storage
  • Ingo_Storage_Blacklist
  • Ingo_Storage_Filters
  • Ingo_Storage_Filters_Sql
  • Ingo_Storage_Forward
  • Ingo_Storage_Mock
  • Ingo_Storage_Prefs
  • Ingo_Storage_Rule
  • Ingo_Storage_Spam
  • Ingo_Storage_Sql
  • Ingo_Storage_Vacation
  • Ingo_Storage_VacationTest
  • Ingo_Storage_Whitelist
  • Ingo_Test
  • Ingo_Transport
  • Ingo_Transport_Ldap
  • Ingo_Transport_Null
  • Ingo_Transport_Sivtest
  • Ingo_Transport_Timsieved
  • Ingo_Transport_Vfs
  • Overview
  • Package
  • Class
  • Tree

Class Ingo_Api

Ingo external API interface.

This file defines Ingo's external API interface. Other applications can interact with Ingo through this API.

See the enclosed file LICENSE for license information (ASL). If you did not receive this file, see http://www.horde.org/licenses/apache.

Horde_Registry_Api
Extended by Ingo_Api
Package: Ingo
Located at Api.php
Methods summary
public
# blacklistFrom( string $addresses )

Add addresses to the blacklist.

Add addresses to the blacklist.

Parameters

$addresses
The addresses to add to the blacklist.
public
# whitelistFrom( string $addresses )

Add addresses to the whitelist.

Add addresses to the whitelist.

Parameters

$addresses
The addresses to add to the whitelist.
public boolean
# canApplyFilters( )

Can this driver perform on-demand filtering?

Can this driver perform on-demand filtering?

Returns

boolean
True if perform() is available, false if not.
public boolean
# applyFilters( array $params = array() )

Perform the filtering specified in the rules.

Perform the filtering specified in the rules.

Parameters

$params
The parameter array: <pre>filter_seen mailbox show_filter_msg</pre>

Returns

boolean
True if filtering was performed, false if not.
public boolean
# setVacation( array $info )

Set vacation

Set vacation

Parameters

$info
Vacation details.

Returns

boolean
True on success.
public boolean
# disableVacation( )

Disable vacation

Disable vacation

Returns

boolean
True on success.
Properties summary
public array $links

Links.

Links.

# array( 'showBlacklist' => '%application%/blacklist.php', 'showWhitelist' => '%application%/whitelist.php', 'showFilters' => '%application%/filters.php', 'showVacation' => '%application%/vacation.php' )
API documentation generated by ApiGen