Use libetpan CFLAGS for header check
[claws.git] / src / plugins / python / examples / README.examples
1 This directory tree contains some example scripts. Feel free
2 to copy them to the appropriate subdirectories under
3 ~/.claws-mail/python-scripts and adjust them to your needs. 
4
5 Unless otherwise noted in the respective files, all example snippets
6 are in the public domain.
7
8 Table of contents:
9 ==================
10
11 * auto/startup
12   An example startup script. It demonstrates how to modify the menu of
13   Claws Mail's main window by adding a menu item under the Help menu
14   to generate and browse the API documentation of the plugin.
15   It also adds a menu item to mark a whole thread as read in the
16   Edit menu.
17   Furthermore, it shows how to build a D-Bus bridge to Claws Mail
18   that other processes can use to trigger Claws Mail events.
19   Also see auto/shutdown for cleanup.
20
21 * auto/shutdown
22   Demonstrates how to clean up the stuff that has been introduced in
23   the auto/startup example.
24
25 * auto/compose_any
26   An example compose script. It demonstrates how to strip reply
27   prefixes that Claws Mail doesn't yet know about from the subject
28   header.
29
30 * main/Print-action-names
31   Prints the names of all actions that are currently in the
32   action group of Claws Mail's main window into a TextView widget.
33
34 * main/Recursively-mark-messages-as-read
35   Demonstrates how to perform actions to a directory tree under the
36   currently selected folder in the main window.
37
38 * main/Mass-mail
39   Demonstrates how to automate composing of mails, and sending them out
40
41 * main/Create-Tomboy-Note
42   Create a Tomboy note for each selected message, containing the
43   subject as note title and a Claws Mail link in the body which
44   links back to Claws Mail (requires the Claws Mail addin for Tomboy).
45   Optionally, the user can choose to add a marker string for the
46   Tomboy Reminder addin into the note.
47   To achieve this, this example demonstrates how to talk to other
48   programs via D-Bus, as well as how to query additional information
49   from the user using direct GTK programming.
50
51 * main/Open-Tomboy-Notes
52   This example opens all Tomboy notes which link to any of the currently
53   selected messages, and thus completes the round trip from the
54   "Create-Tomboy-Note" example.
55
56 * compose/Macro-Expansion
57   Demonstrates how to do text expansion in the compose window
58   mail body editor