| [ Index ] |
|
Code source de IMP H3 (4.1.5) |
[Code source] [Imprimer] [Statistiques]
(pas de description)
| Poids: | 453 lignes (14 kb) |
| Inclus ou requis: | 4 fois |
| Référencé: | 0 fois |
| Nécessite: | 0 fichiers |
IMP_Fetchmail:: (12 méthodes):
factory()
listDrivers()
listColors()
description()
IMP_Fetchmail()
getParameterList()
getProtocolList()
getMail()
_processMailMessage()
_checkMessageSize()
_addMessage()
fetchMail()
IMP_Fetchmail_Account:: (9 méthodes):
IMP_Fetchmail_Account()
_save()
add()
delete()
getValue()
getAllValues()
getAll()
setValue()
hasValue()
Classe: IMP_Fetchmail - X-Ref
The IMP_Fetchmail:: class provides an interface to download mail from| factory($driver, $params = array() X-Ref |
| Attempts to return a concrete IMP_Fetchmail instance based on $driver. param: string $driver The type of concrete IMP_Fetchmail subclass to param: array $params The configuration parameter array. return: mixed The newly created concrete IMP_Fetchmail instance, or |
| listDrivers() X-Ref |
| Returns a list of available drivers, with a description of each. This function can be called statically: $list = IMP_Fetchmail::listDrivers(); return: array The list of available drivers, with the driver name as |
| listColors() X-Ref |
| List the colors available for coloring fetched messages. This function can be called statically: $list = IMP_Fetchmail::listColors(); return: array The list of available colors; |
| description() X-Ref |
| Returns a description of the driver. This function can be called statically: $description = IMP_Fetchmail::description(); return: string The description of the driver. |
| IMP_Fetchmail($params) X-Ref |
| Constructor. param: array $params The configuration parameter array. |
| getParameterList() X-Ref |
| Return the list of parameters valid for this driver. return: array The list of active parameters. |
| getProtocolList() X-Ref |
| Return a list of protocols supported by this driver. return: array The list of protocols. |
| getMail() X-Ref |
| Gets the mail using the data in this object. return: mixed Returns the number of messages retrieved on success. |
| _processMailMessage($header, $body) X-Ref |
| Processes a single mail message by calling any user defined functions, stripping bare newlines, and adding color information to the headers. param: string $header The message header text. param: string $body The message body text. return: string The complete message. |
| _checkMessageSize($size, $subject, $from) X-Ref |
| Checks the message size to see if it exceeds the maximum value allowable in the configuration file. param: integer $size The size of the message. param: string $subject The subject of the message. param: string $from The message sender. return: boolean False if message is too large, true if OK. |
| _addMessage($msg) X-Ref |
| Add the message to the requested local mailbox. param: string $msg The message text. return: boolean True on success, false on failure. |
| fetchMail($accounts) X-Ref |
| Perform fetchmail on the list of accounts given. Outputs informaton to the global notification driver. This function can be called statically. param: array $accounts The list of account identifiers to fetch mail |
Classe: IMP_Fetchmail_Account - X-Ref
The IMP_Fetchmail_Account:: class provides an interface to accessing| IMP_Fetchmail_Account() X-Ref |
| Constructor. |
| _save() X-Ref |
| Saves all accounts in the prefs backend. |
| add() X-Ref |
| Adds a new empty account to the array of accounts. return: integer The pointer to the created account. |
| delete($account) X-Ref |
| Remove an account from the array of accounts param: integer $account The pointer to the account to be removed. return: array The removed account. |
| getValue($key, $account) X-Ref |
| Returns a property from one of the accounts. param: string $key The property to retrieve. param: integer $account The account to retrieve the property from. return: mixed The value of the property or false if the property |
| getAllValues($account) X-Ref |
| Returns all properties from the requested accounts. param: integer $account The account to retrieve the properties from. return: array The entire properties array, or false on error. |
| getAll($key) X-Ref |
| Returns an array with the specified property from all existing accounts. param: string $key The property to retrieve. return: array The array with the values from all accounts. |
| setValue($key, $val, $account) X-Ref |
| Sets a property with a specified value. param: string $key The property to set. param: mixed $val The value the property should be set to. param: integer $account The account to set the property in. |
| hasValue($key, $val) X-Ref |
| Returns true if the pair key/value is already in the accounts array. param: string $key The account key to search. param: string $val The value to search for in $key. return: boolean True if the value was found in $key. |
| Généré le : Thu Nov 29 12:30:07 2007 | par Balluche grâce à PHPXref 0.7 |
|
|