trunk/doc/gpgoe.texi

\input texinfo

@setfilename GPGOE.txt

This file describes the GPGOE functions and the integration
in the Outlook Express mailer.

@section Requirements for GPGOE

First you need to have a working GnuPG installtion on the machine you
plan to install GPGOE. If you don't have GPG in your machine, please
visit http://www.gnupg.org and download the latest GPG version there.
It comes with a graphical installer so there is no need to do this
step manually.

You need at least Windows 2000/XP and at least Outlook Express 6.0
or higher. The plug-in will not work with earlier versions of Express.


@section Installation of the Plug-in

It is always recommend to use the latest version of the plug-in. You
can download it from http://wald.intevation.org/projects/gpgoe.
Download the zip file with the binaries inside and unpack them in
a folder. All files need to be in the same folder, so if you change
the folder don't forget to move all files.

To activate the plug-in you need to start gpgoeinit.exe. You should
now see a little (lock) icon in the taskbar which indicates that the
plug-in is running. If you want to quit the program, double click on
the (lock) icon and confirm the unload.

Now the plug-in is active.

@section Integration into Outlook Express

You have to enable the "Encrypt" and "Sign" items in the
toolbar, in the "New Message" dialog to allow GPGOE to
encrypt and/or sign the message.

There are no new icons for the plug-in and this means you
can either use S/MIME or OpenPGP but never at the same time.
If you want to use S/MIME again, just unload the plugin (quit
gpgoeinit.exe).

@section How to use the plug-in

@subsection Encrypt a message

To encrypt a mail, you need to check the "Encrypt" toolbar button.
If you click the "Send" button the plug-in will try to map each email 
address to a user-ID of an existing OpenPGP key. If no unresolved 
recipients were found, the mail is encrypted and stored in the outbox 
folder. If one or more recipients couldn't be mapped to a key, the 
recipient dialog is shown to manually select the recipients.

@subsection Sign a message

To sign a message, you need to check the "Sign" toolbar button.
If you click the "Send" button, GPG will figure out the default
signing key and the plug-in openes a passphrase dialog to enter
your passphrase for this key. If you entered it and the passphrase
was correct, the plugin will sign the message and store it in
the outbox.

@subsection Decrypt and/or verify a message
If you received an OpenPGP message, you can just double-click
the message to open it. The plug-in will figure out if it is
encrypted or signed and will start the correct procedures. For
decryption you need to enter your passphrase, otherwise the
verify dialog is shown which contains information about the
signature status.
You can also use the "Next" and "Previous" toolbar buttons to
jump to the next message or to go back to the previous. The plug-in
will figure out the message status and will take the needed steps.
If the message is neither signed nor encrypted, no action is performed.

@section Additional information and limitations of the GPGOE plug-in

@itemize @bullet

@item
Due to the fact the plug-in uses the clipboard for data transfer,
the clipboard itself can be only of limited use to copy/paste messages
into the mailer window or elsewhere.

@item
The current version of the plug-in will NOT encrypt any attachments
which are attached to the message. You either need to encrypt them
before or send them in cleartext. For the file encryption it is
recommend to use GPGee or WinPT.

The same needs to be done when an encrypted mail with encrypted
attachments is in the inbox folder. You need GPGee or WinPT to
decrypt the saved file.

@item
Even so the plug-in supports native line endings, which means you
can properly exchange mails with Linux or MAC users, it is likely
that there are problems with the charset.

@item
If you want to import keys or attach keys to a mail, you have to
use an external key manager. WinPT is recommend in this case. It
contains features to send public keys to mail recipients and also
to export keys via the clipboard so you can easily paste the key
into the text body of the message.

@item
Currently signing can be only done with the default signing key.
If you want to change the default signing key, you can use WinPT
to select a different key and then GPGOE will use this one.

@item
GPGOE is NOT able to handle PGP/MIME (RFC3156) style messages.
This means if you get such a message, the plug-in will not be
able to automatically decrypt it.
And due to the fact that the decrypted "attachment" will still
contain a lot of control and coding information, you cannot simply
decrypt it with WinPT/GPGee and use the output.

@end itemize

@bye
1	\input texinfo
2
3	@setfilename GPGOE.txt
4
5	This file describes the GPGOE functions and the integration
6	in the Outlook Express mailer.
7
8	@section Requirements for GPGOE
9
10	First you need to have a working GnuPG installtion on the machine you
11	plan to install GPGOE. If you don't have GPG in your machine, please
12	visit http://www.gnupg.org and download the latest GPG version there.
13	It comes with a graphical installer so there is no need to do this
14	step manually.
15
16	You need at least Windows 2000/XP and at least Outlook Express 6.0
17	or higher. The plug-in will not work with earlier versions of Express.
18
19
20	@section Installation of the Plug-in
21
22	It is always recommend to use the latest version of the plug-in. You
23	can download it from http://wald.intevation.org/projects/gpgoe.
24	Download the zip file with the binaries inside and unpack them in
25	a folder. All files need to be in the same folder, so if you change
26	the folder don't forget to move all files.
27
28	To activate the plug-in you need to start gpgoeinit.exe. You should
29	now see a little (lock) icon in the taskbar which indicates that the
30	plug-in is running. If you want to quit the program, double click on
31	the (lock) icon and confirm the unload.
32
33	Now the plug-in is active.
34
35	@section Integration into Outlook Express
36
37	You have to enable the "Encrypt" and "Sign" items in the
38	toolbar, in the "New Message" dialog to allow GPGOE to
39	encrypt and/or sign the message.
40
41	There are no new icons for the plug-in and this means you
42	can either use S/MIME or OpenPGP but never at the same time.
43	If you want to use S/MIME again, just unload the plugin (quit
44	gpgoeinit.exe).
45
46	@section How to use the plug-in
47
48	@subsection Encrypt a message
49
50	To encrypt a mail, you need to check the "Encrypt" toolbar button.
51	If you click the "Send" button the plug-in will try to map each email
52	address to a user-ID of an existing OpenPGP key. If no unresolved
53	recipients were found, the mail is encrypted and stored in the outbox
54	folder. If one or more recipients couldn't be mapped to a key, the
55	recipient dialog is shown to manually select the recipients.
56
57	@subsection Sign a message
58
59	To sign a message, you need to check the "Sign" toolbar button.
60	If you click the "Send" button, GPG will figure out the default
61	signing key and the plug-in openes a passphrase dialog to enter
62	your passphrase for this key. If you entered it and the passphrase
63	was correct, the plugin will sign the message and store it in
64	the outbox.
65
66	@subsection Decrypt and/or verify a message
67	If you received an OpenPGP message, you can just double-click
68	the message to open it. The plug-in will figure out if it is
69	encrypted or signed and will start the correct procedures. For
70	decryption you need to enter your passphrase, otherwise the
71	verify dialog is shown which contains information about the
72	signature status.
73	You can also use the "Next" and "Previous" toolbar buttons to
74	jump to the next message or to go back to the previous. The plug-in
75	will figure out the message status and will take the needed steps.
76	If the message is neither signed nor encrypted, no action is performed.
77
78	@section Additional information and limitations of the GPGOE plug-in
79
80	@itemize @bullet
81
82	@item
83	Due to the fact the plug-in uses the clipboard for data transfer,
84	the clipboard itself can be only of limited use to copy/paste messages
85	into the mailer window or elsewhere.
86
87	@item
88	The current version of the plug-in will NOT encrypt any attachments
89	which are attached to the message. You either need to encrypt them
90	before or send them in cleartext. For the file encryption it is
91	recommend to use GPGee or WinPT.
92
93	The same needs to be done when an encrypted mail with encrypted
94	attachments is in the inbox folder. You need GPGee or WinPT to
95	decrypt the saved file.
96
97	@item
98	Even so the plug-in supports native line endings, which means you
99	can properly exchange mails with Linux or MAC users, it is likely
100	that there are problems with the charset.
101
102	@item
103	If you want to import keys or attach keys to a mail, you have to
104	use an external key manager. WinPT is recommend in this case. It
105	contains features to send public keys to mail recipients and also
106	to export keys via the clipboard so you can easily paste the key
107	into the text body of the message.
108
109	@item
110	Currently signing can be only done with the default signing key.
111	If you want to change the default signing key, you can use WinPT
112	to select a different key and then GPGOE will use this one.
113
114	@item
115	GPGOE is NOT able to handle PGP/MIME (RFC3156) style messages.
116	This means if you get such a message, the plug-in will not be
117	able to automatically decrypt it.
118	And due to the fact that the decrypted "attachment" will still
119	contain a lot of control and coding information, you cannot simply
120	decrypt it with WinPT/GPGee and use the output.
121
122	@end itemize
123
124	@bye