[wiki:WikiStart back to main page]
= !DragonTalk userobservation for Thunderbird =

This extension observes the user actions in the Thunderbird mail client, like mail selection, mail movement, creation or deletion of a folder and so on. For any of these observed actions, the extension will send an XML-RPC request.
The plugin can be deactivated using the settings dialog.

== Download the extension ==

Click the link to download the xpi file.

[http://dragontalk.opendfki.de/repos/trunk/dragontalk_userobs_thunderbird/build/dragontalk_userobs_thunderbird-M1.5.xpi dragontalk_userobs_thunderbird-M1.5.xpi]

== Browse repository ==

The source code of this extension can be found at
 * [source:trunk/dragontalk_userobs_thunderbird trunk/dragontalk_userobs_thunderbird] - using SVN web browser
 * [http://dragontalk.opendfki.de/repos/trunk/dragontalk_userobs_thunderbird/ SVN repository URL] - direct SVN access

----

== Technical documentation: Actions, methods and their parameters ==

For general information about XML-RPC look at [http://www.xmlrpc.com/]

<methodName> consists of two parts separated by a dot. The first part is the service name witch can be changed in the settings dialog. The second part is the name of the event witch is associated with the action of the user.   

All functions are tested with Thunderbird 2.0.0.0.

folder_URI = URI of imap folders has the form !imap://$username@$server/$foldername [[br]]
message_URI = URI of imap messages has the form: !imap://$username@$server/$foldernames/;UID=$messageKey

[[BR]]

'''Method:''' eventFolderSelected [[BR]]
'''Parameters:''' 

||'''Key'''||'''Value'''||
||folderURI||the URI of the selected folder||

[[BR]]

'''Method:''' eventAddFolder [[BR]]
'''Parameters:''' 

||'''Key'''||'''Value'''||
||parentFolderURI||the URI of the parent folder of the added folder||
||childFolderURI||the URI of the added folder||

[[BR]]

'''Method:''' eventRenameFolder [[BR]]
'''Parameters:''' 

||'''Key'''||'''Value'''||
||newURI||the nue URI of the folder after renaming||
||formerURI||the URI of the folder before renaming||

[[BR]]

'''Method:''' eventDeleteFolder [[BR]]
'''Parameters:''' 

||'''Key'''||'''Value'''||
||folderURI||the URI of the deleted folder||

[[BR]]

'''Method:''' eventEmailSelected [[BR]]
'''Parameters:''' 

||'''Key'''||'''Value'''||
||Subject||the subject of the selected email||
||FolderURI||the URI of the folder in which the email is placed||
||EmailURI||the URI of the email||
||Sender||the sender of this email name and email address (name <email-address>)||
||bccRecipients||the bind carbon copy recipients||
||ccRecipients||the carbon copy recipients||
||toRecipients||the to recipients||
||Body||the body of the email||
'''Comment:''' the boddy is always empty

[[BR]]

'''Method:''' eventDeleteEmail [[BR]]
'''Parameters:''' 

||'''Key'''||'''Value'''||
||Subject||the subject of the selected email||
||FolderURI||the URI of the folder in which the email is placed||
||EmailURI||the URI of the email||
||Sender||the sender of this email name and email address (name <email-address>)||
||bccRecipients||the bind carbon copy recipients||
||ccRecipients||the carbon copy recipients||
||toRecipients||the to recipients||
||Body||the body of the email||
'''Comment:''' the boddy is always empty

[[BR]]

'''Method:''' eventViewEmail [[BR]]
'''Parameters:''' 

||'''Key'''||'''Value'''||
||Subject||the subject of the selected email||
||FolderURI||the URI of the folder in which the email is placed||
||EmailURI||the URI of the email||
||Sender||the sender of this email name and email address (name <email-address>)||
||bccRecipients||the bind carbon copy recipients||
||ccRecipients||the carbon copy recipients||
||toRecipients||the to recipients||
||Body||the body of the email||
'''Comment:''' the boddy is always empty

[[BR]]

'''Method:''' eventMoveEmailToFolder[[BR]]
'''Parameters:''' 

||'''Key'''||'''Value'''||
||Subject||the subject of the selected email||
||FolderURI||the URI of the folder in which the email is placed||
||EmailURI||the URI of the email||
||Sender||the sender of this email name and email address (name <email-address>)||
||bccRecipients||the bind carbon copy recipients||
||ccRecipients||the carbon copy recipients||
||toRecipients||the to recipients||
||Body||the body of the email||
'''Comment:''' the boddy is always empty


[[BR]]

'''Method:''' eventSendEmail [[BR]]
'''Parameters:''' 

||'''Key'''||'''Value'''||
||Subject||the subject of the selected email||
||FolderURI||the URI of the folder in which the email is placed||
||EmailURI||the URI of the email||
||Sender||the sender of this email name and email address (name <email-address>)||
||bccRecipients||the bind carbon copy recipients||
||ccRecipients||the carbon copy recipients||
||toRecipients||the to recipients||
||Body||the body of the email||

[[BR]]

'''Method:''' eventReceiveEmail [[BR]]
'''Parameters:''' 

||'''Key'''||'''Value'''||
||Subject||the subject of the selected email||
||FolderURI||the URI of the folder in which the email is placed||
||EmailURI||the URI of the email||
||Sender||the sender of this email name and email address (name <email-address>)||
||bccRecipients||the bind carbon copy recipients||
||ccRecipients||the carbon copy recipients||
||toRecipients||the to recipients||
||Body||the body of the email||
'''Comment:''' the boddy is always empty

[[BR]]

'''Method:''' eventForwardEmail [[BR]]
'''Parameters:''' 

||'''Key'''||'''Value'''||
||Subject||the subject of the selected email||
||OriginalMsgURI||the URI of the email which is forwarded||
||Sender||the sender of this email name and email address (name <email-address>)||
||bccRecipients||the bind carbon copy recipients||
||ccRecipients||the carbon copy recipients||
||toRecipients||the to recipients||
||Body||the body of the email||

[[BR]]

'''Method:''' eventReplyToEmail [[BR]]
'''Parameters:''' 

||'''Key'''||'''Value'''||
||Subject||the subject of the selected email||
||OriginalMsgURI||the URI of the email which is replied||
||Sender||the sender of this email name and email address (name <email-address>)||
||bccRecipients||the bind carbon copy recipients||
||ccRecipients||the carbon copy recipients||
||toRecipients||the to recipients||
||Body||the body of the email||

[[BR]]

'''Method:''' eventPrintEmail [[BR]]
'''Parameters:''' 

||'''Key'''||'''Value'''||
||Subject||the subject of the selected email||
||FolderURI||the URI of the folder in which the email is placed||
||EmailURI||the URI of the email||
||Sender||the sender of this email name and email address (name <email-address>)||
||bccRecipients||the bind carbon copy recipients||
||ccRecipients||the carbon copy recipients||
||toRecipients||the to recipients||
||Body||the body of the email||
'''Comment:''' the boddy is always empty, works only via File -> Print... and with the print button in the toolbar of the main window.

[[BR]]

'''Method:''' eventAddAddressBookEntry [[BR]]
'''Parameters:''' 

||'''Key'''||'''Value'''||
||ABLastName||the lastname||
||ABFirstName||ths firstname||
||ABPrimaryEmail||the email address||
||ABURI||the URI of the addressbook entry||

[[BR]]

'''Method:''' eventModifyAddressBookEntry [[BR]]
'''Parameters:''' 

||'''Key'''||'''Value'''||
||ABLastName||the lastname||
||ABFirstName||ths firstname||
||ABPrimaryEmail||the email address||
||ABURI||the URI of the addressbook entry||

[[BR]]

'''Method:''' eventDeleteAddressBookEntry [[BR]]
'''Parameters:''' 

||'''Key'''||'''Value'''||
||ABLastName||the lastname||
||ABFirstName||ths firstname||
||ABPrimaryEmail||the email address||
||ABURI||the URI of the addressbook entry||