The Ingo_Script_imap:: class represents an IMAP client-side script generator.

$Horde: ingo/lib/Script/imap.php,v 1.49.10.22 2010/06/15 10:02:54 jan Exp $

Copyright 2003-2009 The Horde Project (http://www.horde.org/)

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

• author: Michael Slusarz <slusarz@horde.org>

Located in /lib/Script/imap.php (line 16)

Ingo_Script
   |
   --Ingo_Script_imap

array $_actions = array(
INGO_STORAGE_ACTION_KEEP,
INGO_STORAGE_ACTION_MOVE,
INGO_STORAGE_ACTION_DISCARD,
INGO_STORAGE_ACTION_MOVEKEEP
) (line 23)

The list of actions allowed (implemented) for this driver.

---

Redefinition of:

Ingo_Script::$_actions

The list of actions allowed (implemented) for this driver.

Ingo_Script_imap_api $_api (line 87)

The API to use for IMAP functions.

array $_categories = array(
INGO_STORAGE_ACTION_BLACKLIST,
INGO_STORAGE_ACTION_WHITELIST
) (line 35)

The categories of filtering allowed.

---

Redefinition of:

Ingo_Script::$_categories

The categories of filtering allowed.

boolean $_ondemand = true (line 80)

This driver can perform on demand filtering (in fact, that is all it can do).

---

Redefinition of:

Ingo_Script::$_ondemand

Can this driver perform on demand filtering?

boolean $_supportIMAPFlags = true (line 65)

Does the driver support setting IMAP flags?

---

Redefinition of:

Ingo_Script::$_supportIMAPFlags

Does the driver support setting IMAP flags?

boolean $_supportStopScript = true (line 72)

Does the driver support the stop-script option?

---

Redefinition of:

Ingo_Script::$_supportStopScript

Does the driver support the stop-script option?

array $_tests = array(
'contains', 'not contain'
) (line 45)

The list of tests allowed (implemented) for this driver.

---

Redefinition of:

Ingo_Script::$_tests

The list of tests allowed (implemented) for this driver.

array $_types = array(
INGO_STORAGE_TYPE_HEADER,
INGO_STORAGE_TYPE_SIZE,
INGO_STORAGE_TYPE_BODY
) (line 54)

The types of tests allowed (implemented) for this driver.

---

Redefinition of:

Ingo_Script::$_types

The types of tests allowed (implemented) for this driver.

Inherited Variables

Inherited from Ingo_Script

Ingo_Script::$_casesensitive
Ingo_Script::$_params
Ingo_Script::$_scriptfile
Ingo_Script::$_special_types

apply (line 389)

Apply the filters now.

• return: See perform().

boolean apply ()

---

Redefinition of:

Ingo_Script::apply()

Apply the filters now.

canApply (line 377)

Is the apply() function available? The 'mail/getStream' API function must be available.

• return: True if apply() is available, false if not.

boolean canApply ()

---

Redefinition of:

Ingo_Script::canApply()

Is the apply() function available?

perform (line 101)

Perform the filtering specified in the rules.

• return: True if filtering performed, false if not.

boolean perform (array $params)

• array $params: The parameter array. It MUST contain:
  • 'imap': An open IMAP stream.
  • 'mailbox': The name of the mailbox to filter.
  • 'show_filter_msg': Show detailed filter status messages?
  • 'filter_seen': Only filter seen messages?

---

Redefinition of:

Ingo_Script::perform()

Perform the filtering specified in the rules.

_getQuery (line 411)

Returns a query object prepared for adding further criteria.

• return: A query object.

Ingo_IMAP_Search_Query _getQuery ($params $params)

• $params $params

Inherited Methods

Inherited From Ingo_Script

Ingo_Script::Ingo_Script()
Ingo_Script::apply()
Ingo_Script::availableActions()
Ingo_Script::availableCategories()
Ingo_Script::availableTests()
Ingo_Script::availableTypes()
Ingo_Script::canApply()
Ingo_Script::caseSensitive()
Ingo_Script::excludeRegexp()
Ingo_Script::factory()
Ingo_Script::generate()
Ingo_Script::generateAvailable()
Ingo_Script::imapFlags()
Ingo_Script::perform()
Ingo_Script::performAvailable()
Ingo_Script::specialTypes()
Ingo_Script::stopScript()
Ingo_Script::toCode()