* New upstream release.
[debian/mimetic.git] / examples / README
1 QUICKSTART
2 -----
3 'make examples' will build all examples programs. 
4
5 Run each of them with the -h command line parameters to get usage instruction.
6
7 exbin 
8 -----
9 Extracts e-mail attachments contained into input file(s).
10
11 You can extract just one type of attachment limiting the extraction to one
12 Content-Type using the -t parameter. 
13
14 Ex.
15     ./exbin -t sound Mail/*
16     ./exbin -t image/jpeg Mail/*
17
18     This will extract all binaries, lots of virus and worms will be 
19     probably extracted so be careful!
20     ./exbin Mail/*
21
22 structure 
23 ---------
24 Prints the MIME structure of email messages
25
26 b64 
27 ---
28 Base64 encodes and decodes input files
29
30 qp 
31 --
32 Encodes and decodes in Quoted-Printable input files
33
34 catpart 
35 -------
36 This is a sort of standard Unix 'cat' program applied to email messages.
37
38 It searches for MIME entities based on command line parameters and prints
39 contents of those that match.
40
41 NOTE THAT -r MUST BE USED TO CONSIDER CHILD ENTITIES
42
43 Ex.
44     prints the content of parts of MIME type image/* of email stored 
45     in 'test.msg':
46         ./catpart -r -t image test.msg
47
48     prints just the name of files that contain image/* entities
49         ./catpart -r -t image -l *
50
51     prints entities whose Subject contain the word 'virus'
52         ./catpart -r -f subject=virus *
53
54 buildidx 
55 --------
56 Create an index of files or directories containing email messages for fast
57 searches using the 'search' program.
58 Es.
59     ./buildidx ~/Mail/* > my_mail.index
60
61 search 
62 ------
63 Search for messages, try 'search -h' for parameters.
64 Use -I to use the index created with 'buildidx' to speed up lookup
65
66 mbox
67 ----
68 It prints the MIME structure of each message found in a MBOX archive.
69 It's not very useful right now but it will be expanded :)