Class IMP_Fetchmail

Description

The IMP_Fetchmail:: class provides an interface to download mail from remote mail servers.

$Horde: imp/lib/Fetchmail.php,v 1.41.8.15 2009/01/06 15:24:03 jan Exp $

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

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.fsf.org/copyleft/gpl.html.

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


	
			
Direct descendents
Class Description
 class IMP_Fetchmail_imap The IMP_Fetchmail_imap driver implements the IMAP_Fetchmail class for use with IMAP/POP3 servers.
Variable Summary
 array $_params
Method Summary
 IMP_Fetchmail IMP_Fetchmail (array $params)
 string description ()
 mixed &factory (string $driver, [array $params = array()])
 void fetchMail (array $accounts)
 mixed getMail ()
 array getParameterList ()
 array getProtocolList ()
 array listColors ()
 array listDrivers ()
Variables
array $_activeparams = array(
'id', 'driver', 'type', 'protocol', 'username', 'password', 'server',
'rmailbox', 'lmailbox', 'onlynew', 'markseen', 'del', 'loginfetch',
'acctcolor'
)
(line 48)

The list of active fetchmail parameters for the current driver.

ALL DRIVERS SHOULD UNSET ANY FETCHMAIL PARAMETERS THEY DO NOT USE OR ELSE THEY WILL APPEAR IN THE PREFERENCES PAGE. The following parameters are available: 'id' -- The account name. 'driver' -- The driver to use. 'protocol' -- The protocol type. 'username' -- The username on the remote server. 'password' -- The password on the remote server. 'server' -- The remote server name/address. 'rmailbox' -- The remote mailbox name. 'lmailbox' -- The local mailbox to download messages to. 'onlynew' -- Only retrieve new messages? 'markseen' -- Mark messages as seen? 'del' -- Delete messages after fetching? 'loginfetch' -- Fetch mail from other accounts on login? 'acctcolor' -- Should these messages be colored differently in mailbox view?

array $_params (line 24)

Parameters used by the driver.

Methods
Constructor IMP_Fetchmail (line 144)

Constructor.

IMP_Fetchmail IMP_Fetchmail (array $params)
  • array $params: The configuration parameter array.
description (line 134)

Returns a description of the driver.

This function can be called statically: $description = IMP_Fetchmail::description();

  • return: The description of the driver.
  • abstract:
string description ()

Redefined in descendants as:
factory (line 66)

Attempts to return a concrete IMP_Fetchmail instance based on $driver.

  • return: The newly created concrete IMP_Fetchmail instance, or false on error.
mixed &factory (string $driver, [array $params = array()])
  • string $driver: The type of concrete IMP_Fetchmail subclass to return, based on the driver indicated. The code is dynamically included.
  • array $params: The configuration parameter array.
fetchMail (line 268)

Perform fetchmail on the list of accounts given. Outputs informaton to the global notification driver.

This function can be called statically.

void fetchMail (array $accounts)
  • array $accounts: The list of account identifiers to fetch mail for.
getMail (line 187)

Gets the mail using the data in this object.

  • return: Returns the number of messages retrieved on success. Returns PEAR_Error on error.
  • abstract:
mixed getMail ()

Redefined in descendants as:
getParameterList (line 160)

Return the list of parameters valid for this driver.

  • return: The list of active parameters.
array getParameterList ()
getProtocolList (line 174)

Return a list of protocols supported by this driver.

  • return: The list of protocols. KEY: protocol ID VAL: protocol description
  • abstract:
array getProtocolList ()

Redefined in descendants as:
listColors (line 117)

List the colors available for coloring fetched messages.

This function can be called statically: $list = IMP_Fetchmail::listColors();

  • return: The list of available colors;
array listColors ()
listDrivers (line 88)

Returns a list of available drivers, with a description of each.

This function can be called statically: $list = IMP_Fetchmail::listDrivers();

  • return: The list of available drivers, with the driver name as the key and the description as the value.
array listDrivers ()

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