Available methods for Pošta (imp)

Application: imp
Prefix: mail
Name: Pošta

Example:

// inside ObalaNET 1
$result = $registry->call("mail/METHOD_NAME", array(PARAMETERS));

// inside ObalaNET 2
$result = $registry->callByPackage("imp", "METHOD_NAME", array(PARAMETERS));

// XML RPC (http://pear.php.net/package/XML_RPC)
require_once "XML/RPC.php";
$msg = new XML_RPC_Message("mail.METHOD_NAME", PARAMETERS);
$cli = new XML_RPC_Client("/rpc.php", "http://HOSTNAME");
$resp = $cli->send($msg);
$val = $resp->value();
$result = XML_RPC_decode($val);

// XML RPC 2 (http://pear.php.net/package/XML_RPC2)
require_once "XML/RPC2/Client.php";
$client = XML_RPC2_Client::create("http://HOSTNAME/rpc.php", array("prefix" => "mail"));
$result = $client->METHOD_NAME(PARAMETER_1, PARAMETER_2, PARAMETER_3 ...);

// Python Example (http://wiki.horde.org/XmlRpcPythonHowTo)
import xmlrpclib
url = "http://HOSTNAME/rpc.php"
server = xmlrpclib.ServerProxy(url, verbose=0)
result = server.mail.METHOD_NAME(PARAMETER_1, PARAMETER_2, PARAMETER_3 ...)

More detailed examples: http://www.drugapisarna.si/wicked/ZunanjaUporaba

perms - ...

Call: (mixed) perms()

authenticate - TODO...

Call: (boolean) authenticate((string) userID, (array) credentials, (array) params)

Description :

TODO

Parameters:

Type	Name	Documentation
string	userID	TODO
array	credentials	s TODO
array	params	s TODO

getStream - Attempts to authenti...

Call: (mixed) getStream( [ (string) mailbox, (integer) flags ] )

Description :

Attempts to authenticate via IMP and return an IMAP stream.

Parameters:

Type	Name	Documentation
string	mailbox	The mailbox name.
integer	flags	IMAP connection flags.

compose - Returns a compose wi...

Call: (string) compose( [ (array) args, (array) extra ] )

Description :

Returns a compose window link.
If this is passed in as a string, it will be
parsed as a toaddress?subject=foo&cc=ccaddress
(mailto-style) string.
compose.php.

Parameters:

Type	Name	Documentation
array	args	List of arguments to pass to compose.php.
array	extra	Hash of extra, non-standard arguments to pass to

batchCompose - Return a list of com...

Call: (string) batchCompose( [ (mixed) args, (array) extra ] )

Description :

Return a list of compose window links.
the lists are passed in as strings, they will be parsed
as toaddress?subject=foo&cc=ccaddress (mailto-style)
strings.
to compose.php.

Parameters:

Type	Name	Documentation
mixed	args	List of lists of arguments to pass to compose.php. If
array	extra	List of hashes of extra, non-standard arguments to pass

folderlist - Returns the list of ...

Call: (array) folderlist()

Description :

Returns the list of folders.

createFolder - Creates a new folder...

Call: (string) createFolder((string) folder)

Description :

Creates a new folder.
on failure.

Parameters:

Type	Name	Documentation
string	folder	The UTF7-IMAP encoded name of the folder to create.

server - Returns the currentl...

Call: (string) server()

Description :

Returns the currently logged on IMAP server.
authenticated into IMP yet.

favouriteRecipients - Returns the list of ...

Call: (array) favouriteRecipients((integer) limit [ , (array) filter ] )

Description :

Returns the list of favorite recipients.
A value of null returns all message types.

Parameters:

Type	Name	Documentation
integer	limit	Return this number of recipients.
array	filter	A list of messages types that should be returned.

changeLanguage - Performs tasks neces...

Call: (mixed) changeLanguage()

Description :

Performs tasks necessary when the language is changed during the session.