File/lib/api.php

Description
Description | Functions

Ingo external API interface.

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

$Horde: ingo/lib/api.php,v 1.16.12.9 2009/12/30 17:40:03 jan Exp $

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

Functions
Description | Functions
_ingo_applyFilters (line 237)

Perform the filtering specified in the rules.

  • return: True if filtering was performed, false if not.
boolean _ingo_applyFilters ([array $params = array()])
  • array $params: The parameter array.
_ingo_blacklistFrom (line 154)

Add addresses to the blacklist

void _ingo_blacklistFrom (string $addresses)
  • string $addresses: The addresses to add
_ingo_canApplyFilters (line 218)

Can this driver perform on-demand filtering?

  • return: True if perform() is available, false if not.
boolean _ingo_canApplyFilters ()
_ingo_disableVacation (line 338)

Disable vacation

  • return: True on success.
boolean _ingo_disableVacation ()
_ingo_perms (line 74)

Returns a list of available permissions.

  • return: An array describing all available permissions.
array _ingo_perms ()
_ingo_removeUserData (line 94)

Removes user data.

  • return: true on success | PEAR_Error on failure
mixed _ingo_removeUserData (string $user)
  • string $user: Name of user to remove data for.
_ingo_setVacation (line 263)

Set vacation

  • return: True on success.
boolean _ingo_setVacation (array $info)
  • array $info: Vacation details
_ingo_whitelistFrom (line 191)

Add addresses to the white list

void _ingo_whitelistFrom (string $addresses)
  • string $addresses: The addresses to add

Documentation generated on Sun, 30 Jan 2011 05:29:25 +0000 by phpDocumentor 1.4.3