Documentation

Ingo_Api extends Horde_Registry_Api
in package

Ingo external API interface.

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

Tags
category

Horde

copyright

2012-2017 Horde LLC

license

http://www.horde.org/licenses/apache ASL

Table of Contents

applyFilters()  : mixed
Perform the filtering specified in the rules.
blacklistFrom()  : mixed
Add addresses to the blacklist.
canApplyFilters()  : bool
Can this driver perform on-demand filtering?
disabled()  : mixed
disableVacation()  : mixed
Disable vacation
getVacation()  : array<string|int, mixed>
Return the vacation message properties.
links()  : mixed
listTimeObjectCategories()  : array<string|int, mixed>
Retrieves a list of available time objects categories.
listTimeObjects()  : array<string|int, mixed>
Lists vacation rules as timeobject.
setVacation()  : mixed
Set vacation
whitelistFrom()  : mixed
Add addresses to the whitelist.

Methods

applyFilters()

Perform the filtering specified in the rules.

public applyFilters([array<string|int, mixed> $params = array() ]) : mixed
Parameters
$params : array<string|int, mixed> = array()

The parameter array:

  • filter_seen
  • mailbox (UTF-8)
  • show_filter_msg
Return values
mixed —

blacklistFrom()

Add addresses to the blacklist.

public blacklistFrom(string $addresses) : mixed
Parameters
$addresses : string

The addresses to add to the blacklist.

Return values
mixed —

canApplyFilters()

Can this driver perform on-demand filtering?

public canApplyFilters() : bool
Return values
bool —

True if perform() is available, false if not.

disabled()

public disabled() : mixed
Return values
mixed —

disableVacation()

Disable vacation

public disableVacation() : mixed
Tags
throws
Ingo_Exception
Return values
mixed —

getVacation()

Return the vacation message properties.

public getVacation() : array<string|int, mixed>
Return values
array<string|int, mixed> —

The property hash

links()

public links() : mixed
Return values
mixed —

listTimeObjectCategories()

Retrieves a list of available time objects categories.

public listTimeObjectCategories() : array<string|int, mixed>
Return values
array<string|int, mixed> —

An array of all configured time object categories.

listTimeObjects()

Lists vacation rules as timeobject.

public listTimeObjects(array<string|int, mixed> $time_categories, mixed $start, mixed $end) : array<string|int, mixed>
Parameters
$time_categories : array<string|int, mixed>

The time categories (from listTimeObjectCategories) to list.

$start : mixed

The start date of the period.

$end : mixed

The end date of the period.

Tags
throws
Turba_Exception
Return values
array<string|int, mixed> —

An array of timeObject results.

setVacation()

Set vacation

public setVacation(array<string|int, mixed> $info[, bool $enable = true ]) : mixed
Parameters
$info : array<string|int, mixed>

Vacation details.

  • addresses: (mixed) Address list to enable vacation for.
  • days: (integer) Number of days between vacation replies.
  • excludes: (mixed) Address list to exclude from vacation replies.
  • ignorelist: (boolean) If set, ignore mailing lists.
  • reason: (string) Vacation message.
  • subject: (string) Vacation email subject.
  • start: (integer) Timestamp of vacation starttime.
  • end: (integer) Timestamp of vacation endtime.
$enable : bool = true

Enable the filter?

Tags
throws
Ingo_Exception
Return values
mixed —

whitelistFrom()

Add addresses to the whitelist.

public whitelistFrom(string $addresses) : mixed
Parameters
$addresses : string

The addresses to add to the whitelist.

Return values
mixed —

Search results