Class IMP_Fetchmail_Account

Description

The IMP_Fetchmail_Account:: class provides an interface to accessing fetchmail preferences for all mail accounts a user might have.

Located in /lib/Fetchmail.php (line 301)


	
			
Variable Summary
 array $_accounts
Method Summary
 IMP_Fetchmail_Account IMP_Fetchmail_Account ()
 integer add ()
 integer count ()
 array delete (integer $account)
 array getAll (string $key)
 array getAllValues (integer $account)
 mixed getValue (string $key, integer $account)
 boolean hasValue (string $key, string $val)
 void setValue (string $key, mixed $val, integer $account)
Variables
array $_accounts = array() (line 308)

Array containing all the user's accounts.

Methods
Constructor IMP_Fetchmail_Account (line 313)

Constructor.

IMP_Fetchmail_Account IMP_Fetchmail_Account ()
add (line 348)

Adds a new empty account to the array of accounts.

  • return: The pointer to the created account.
integer add ()
count (line 328)

Return the number of accounts.

  • return: Number of active accounts.
integer count ()
delete (line 362)

Remove an account from the array of accounts

  • return: The removed account.
array delete (integer $account)
  • integer $account: The pointer to the account to be removed.
getAll (line 404)

Returns an array with the specified property from all existing accounts.

  • return: The array with the values from all accounts.
array getAll (string $key)
  • string $key: The property to retrieve.
getAllValues (line 392)

Returns all properties from the requested accounts.

  • return: The entire properties array, or false on error.
array getAllValues (integer $account)
  • integer $account: The account to retrieve the properties from.
getValue (line 380)

Returns a property from one of the accounts.

  • return: The value of the property or false if the property doesn't exist.
mixed getValue (string $key, integer $account)
  • string $key: The property to retrieve.
  • integer $account: The account to retrieve the property from.
hasValue (line 446)

Returns true if the pair key/value is already in the accounts array.

  • return: True if the value was found in $key.
boolean hasValue (string $key, string $val)
  • string $key: The account key to search.
  • string $val: The value to search for in $key.
setValue (line 421)

Sets a property with a specified value.

void setValue (string $key, mixed $val, integer $account)
  • string $key: The property to set.
  • mixed $val: The value the property should be set to.
  • integer $account: The account to set the property in.

Documentation generated on Sun, 30 Jan 2011 05:28:11 +0000 by phpDocumentor 1.4.3