Annotation of /trunk/README


        GNU Privacy Guard - Outlook Express Plugin
        ------------------------------------------


Some important information
--------------------------
Please consider this work as a beta version. Don't except that everything
works and be prepared for some unexpected behvaiours! So please use it 
with some caution.
Even so I tested the plugin several times and what I can say is, that it
seems to work with W2K/WXP and Outlook Express (6.X). Because I don't
have any access to a machine with Vista, I cannot say anything how it
works with the new Outlook Express version.


Installation
------------

To use the plugin a working GnuPG installation is *required*. If you
don't have GPG installed, please visit gnupg.org and read some manuals
about it. The easiest way is to use gpg4win to install GPG and WinPT.

Now you should unzip all files into a directory. Make sure that 
the GPGOE.dll and the GPGOEInit.exe is located in the same directory.
Now start the GPGOEInit program. You'll see a small new icon (lock) 
in the tasbkar. If there was no error message, the OE plugin is now setup 
properly. To quit the program and to unload the GPGOE plug-in you've to 
double click on the icon with the left mouse button.


Native language support
-----------------------

Currently the following languages are supported:
German, Italian

In the case you want to translate GPGOE into your language, please contact
me. The amount of strings that need to be translated is totally
manageable so that the translation takes about just 30 minutes.


How to use the plug-in
----------------------

For now the plugin supports encryption, signing and decryption or to verify
signatures. There are *no* new icons in the OE mailer window. To encrypt a
message you've to add the S/MIME encrypt/sign buttons to the OE toolbar.
This is *required*. Now you can press one of the buttons to sign or encrypt.
If you click both buttons the message is signed *and* encrypted.

There are several ways to choose the recipients:

1. Use the OE addressbook and make sure that the email address of the
   recipients is equal to the user ID's from the GPG key.

2. Enter the recipients manually. Then a keylist dialog is shown when
   at least one of the recipients were not found and you can choose the 
   recipients which should use for encryption. It's also allowed to 
   select more then one.

Now we're at the point you get an signed or encrypted message. Open the
message and soon after you openend it, either a passphrase callback is shown
and you need to enter the passphrase or a dialog is shown for signature
verification. After the operation was successfull the plaintext is shown 
in a separate text viewer. Or in the case it was a signature, the signature 
status is shown.

If you've trouble to install or use the plugin, you can use the forum
at wald.intevation.org. But please, check the existing threads there
to make sure you questions wasn't already answered by someone else.


Hint
----

The plug-in does *NOT* use any S/MIME procedures. It only uses the OE
buttons, which had the S/MIME description, to encrypt/sign text.
And as a logical result, you cannot use S/MIME and OpenPGP at the 
same time. If you want to use S/MIME again, just unload the plug-in.
1	twoaday	1
2	twoaday	6	GNU Privacy Guard - Outlook Express Plugin
3	twoaday	1	------------------------------------------
4
5
6			Some important information
7			--------------------------
8			Please consider this work as a beta version. Don't except that everything
9	twoaday	6	works and be prepared for some unexpected behvaiours! So please use it
10			with some caution.
11	twoaday	1	Even so I tested the plugin several times and what I can say is, that it
12	twoaday	23	seems to work with W2K/WXP and Outlook Express (6.X). Because I don't
13			have any access to a machine with Vista, I cannot say anything how it
14			works with the new Outlook Express version.
15	twoaday	1
16
17			Installation
18			------------
19
20			To use the plugin a working GnuPG installation is required. If you
21			don't have GPG installed, please visit gnupg.org and read some manuals
22	twoaday	19	about it. The easiest way is to use gpg4win to install GPG and WinPT.
23	twoaday	1
24	twoaday	6	Now you should unzip all files into a directory. Make sure that
25			the GPGOE.dll and the GPGOEInit.exe is located in the same directory.
26			Now start the GPGOEInit program. You'll see a small new icon (lock)
27			in the tasbkar. If there was no error message, the OE plugin is now setup
28			properly. To quit the program and to unload the GPGOE plug-in you've to
29			double click on the icon with the left mouse button.
30	twoaday	1
31
32			Native language support
33			-----------------------
34
35	twoaday	19	Currently the following languages are supported:
36			German, Italian
37	twoaday	1
38			In the case you want to translate GPGOE into your language, please contact
39	twoaday	6	me. The amount of strings that need to be translated is totally
40			manageable so that the translation takes about just 30 minutes.
41	twoaday	1
42
43			How to use the plug-in
44			----------------------
45
46			For now the plugin supports encryption, signing and decryption or to verify
47	twoaday	6	signatures. There are no new icons in the OE mailer window. To encrypt a
48	twoaday	1	message you've to add the S/MIME encrypt/sign buttons to the OE toolbar.
49			This is required. Now you can press one of the buttons to sign or encrypt.
50			If you click both buttons the message is signed and encrypted.
51
52			There are several ways to choose the recipients:
53
54			1. Use the OE addressbook and make sure that the email address of the
55			recipients is equal to the user ID's from the GPG key.
56
57	twoaday	6	2. Enter the recipients manually. Then a keylist dialog is shown when
58			at least one of the recipients were not found and you can choose the
59			recipients which should use for encryption. It's also allowed to
60			select more then one.
61	twoaday	1
62			Now we're at the point you get an signed or encrypted message. Open the
63	twoaday	6	message and soon after you openend it, either a passphrase callback is shown
64			and you need to enter the passphrase or a dialog is shown for signature
65			verification. After the operation was successfull the plaintext is shown
66			in a separate text viewer. Or in the case it was a signature, the signature
67			status is shown.
68	twoaday	1
69	twoaday	23	If you've trouble to install or use the plugin, you can use the forum
70			at wald.intevation.org. But please, check the existing threads there
71			to make sure you questions wasn't already answered by someone else.
72	twoaday	1
73
74			Hint
75			----
76
77			The plug-in does NOT use any S/MIME procedures. It only uses the OE
78			buttons, which had the S/MIME description, to encrypt/sign text.
79	twoaday	6	And as a logical result, you cannot use S/MIME and OpenPGP at the
80			same time. If you want to use S/MIME again, just unload the plug-in.