PHP 클래스 Ingo_Api, horde

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

상속: extends Horde_Registry_Api

공개 메소드들

메소드	설명
applyFilters ( array $params = [] )	Perform the filtering specified in the rules.
blacklistFrom ( string $addresses )	Add addresses to the blacklist.
canApplyFilters ( ) : boolean	Can this driver perform on-demand filtering?
disableVacation ( )	Disable vacation
disabled ( )
getVacation ( ) : array	Return the vacation message properties.
links ( )
listTimeObjectCategories ( ) : array	Retrieves a list of available time objects categories.
listTimeObjects ( array $time_categories, mixed $start, mixed $end ) : array	Lists vacation rules as timeobject.
setVacation ( array $info, boolean $enable = true )	Set vacation
whitelistFrom ( string $addresses )	Add addresses to the whitelist.

Perform the filtering specified in the rules.

public applyFilters ( array $params = [] )
$params	array	The parameter array: - filter_seen - mailbox (UTF-8) - show_filter_msg

Add addresses to the blacklist.

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

Can this driver perform on-demand filtering?

public canApplyFilters ( ) : boolean
리턴	boolean	True if perform() is available, false if not.

Disable vacation

public disableVacation ( )

public disabled ( )

Return the vacation message properties.

public getVacation ( ) : array
리턴	array	The property hash

public links ( )

Retrieves a list of available time objects categories.

public listTimeObjectCategories ( ) : array
리턴	array	An array of all configured time object categories.

Lists vacation rules as timeobject.

public listTimeObjects ( array $time_categories, mixed $start, mixed $end ) : array
$time_categories	array	The time categories (from listTimeObjectCategories) to list.
$start	mixed	The start date of the period.
$end	mixed	The end date of the period.
리턴	array	An array of timeObject results.

Set vacation

public setVacation ( array $info, boolean $enable = true )
$info	array	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	boolean	Enable the filter?

Add addresses to the whitelist.

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