API Documentation
\

\Ingo_Api

Ingo external API interface.

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

Summary

Methods
Properties
Constants
disabled()
links()
blacklistFrom()
whitelistFrom()
canApplyFilters()
applyFilters()
setVacation()
getVacation()
disableVacation()
listTimeObjectCategories()
listTimeObjects()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

disabled()

disabled()

links()

links()

blacklistFrom()

blacklistFrom(string  $addresses)

Add addresses to the blacklist.

Parameters

string $addresses

The addresses to add to the blacklist.

whitelistFrom()

whitelistFrom(string  $addresses)

Add addresses to the whitelist.

Parameters

string $addresses

The addresses to add to the whitelist.

canApplyFilters()

canApplyFilters() : boolean

Can this driver perform on-demand filtering?

Returns

boolean —

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

applyFilters()

applyFilters(array  $params = array())

Perform the filtering specified in the rules.

Parameters

array $params

The parameter array:

  • filter_seen
  • mailbox (UTF-8)
  • show_filter_msg

setVacation()

setVacation(array  $info, boolean  $enable = true)

Set vacation

Parameters

array $info

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.
boolean $enable

Enable the filter?

Throws

\Ingo_Exception

getVacation()

getVacation() : array

Return the vacation message properties.

Returns

array —

The property hash

disableVacation()

disableVacation()

Disable vacation

Throws

\Ingo_Exception

listTimeObjectCategories()

listTimeObjectCategories() : array

Retrieves a list of available time objects categories.

Returns

array —

An array of all configured time object categories.

listTimeObjects()

listTimeObjects(array  $time_categories, mixed  $start, mixed  $end) : array

Lists vacation rules as timeobject.

Parameters

array $time_categories

The time categories (from listTimeObjectCategories) to list.
mixed $start

The start date of the period.
mixed $end

The end date of the period.

Throws

\Turba_Exception

Returns

array —

An array of timeObject results.