XetPan Documentation
Part of the XetPan Open Mail User Agent Project.
(C) 2002, 2003, Melvin Hadasht <melvin.hadasht@free.fr>
GPL license v2, or any later. 

XETPAN API FOR PYTHON

You need to use 'print' to see the actual result of function returning something or
save the result in a variable.

get_folder_list()
-----------------

Return the tuple of known folders. The folders are references with a unique identitifier consisting
of the mailbox id, a colon, and the full path of the folder. 


update_folder(FOLDER_ID)
------------------------

connect to folder, retrieves messages. If a summary view is currently
displaying the folder, it will be updated.


condition_new(CONDITION_ID, EXPRESSION)
---------------------------------------

create a new condition with the unique identifier CONDITION_ID in the
conditions namespace.  EXPRESSION is the condition as described in
processing.txt.  Return 0 on success, -1 on failure.

action_new(ACTION_ID, COMMAND)
------------------------------

create a new action with the unique identifier ACTION_ID in the
actions namespace.  COMMAND is the command as described in
processing.txt.  Return 0 on success, -1 on failure.


rule_new(RULE_ID, CONDITION_ID, ACTION_ID)
------------------------------------------

create a new rule by combining the existing condition and action
referred by CONDITION_ID and ACTION_ID.  Return 0 on success, -1 on
failure.

folder_get_rules(FOLDER_ID)
---------------------------

return a tuple of the enabled rule IDs private to this folder.


folder_add_rule(FOLDER_ID, RULE_ID)
-----------------------------------

add the existing rule RULE_ID to the private list of rules of folder
FOLDER_ID.


folder_remove_rule(FOLDER_ID, RULE_ID)
--------------------------------------

remove the RULE_ID from the private list of rules of folder FOLDER_ID.