Revise plugin documentation. Mainly, this removes remains of documentation
[squirrelmail.git] / plugins / abook_take / README
1 Address Book Take
2
3 If you would like to add the sender of a message you're reading to your
4 address book quickly and easily without cutting and pasting, then this
5 plugin simplifies the process.  It scans the mail message you're reading
6 for any email address and lets you add it with a quick form.
7
8
9 Features
10 ========
11
12 * Saves you the need to Cut & Paste
13 * Steals from the To, From, Reply-To, and CC fields
14 * Steals from the body of the message
15 * Address verification (pretty good)
16
17
18 Description
19 ===========
20
21 By pulling down a list and selecting the address you want to add, you
22 are then presented with a familiar Add to Personal Address Book screen.
23 By filling out this form, you will then add the email address to your
24 personal address book.
25
26 The user can decide if the box is shown, where it is shown on the bottom
27 of the Read screen, and whether or not to attempt to verify that the
28 address works.
29
30 When trying to verify if the address works, it checks to see if the host
31 has any DNS record available.  Usually this will work.
32
33
34 Future Work
35 ===========
36
37 * Maybe grab the name, if available
38 * Search more headers (when they become available)
39 * Steal from the body of the message directly (when possible)
40 * When new domains are added, update the email verification function
41
42
43 Installation
44 ============
45
46 Go back to the main directory, run configure and add the plugin.
47
48
49 Credits
50 =======
51
52 This plugin has been originally developed by Tyler Akins and is now
53 maintained by the SquirrelMail Project Team.