trunk/doc/gpgoe.texi

\input texinfo

@setfilename GPGOE

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

This file is free under the terms of the GNU General Public License v2.

Copyright (C) 2006 Timo Schulz

@settitle GPGOE - the GnuPG plug-in for Outlook Express

@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 Sign and Encrypt a message
To sign and encrypt a message, you have to check both toolbar
buttons ("Sign" and "Encrypt"). The procedure is the same as
in encrypt-only when one or more email addresses couldn't be
mapped. Then the default key is used to sign the plaintext
before it is encrypted with the selected recipients.

@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.

@subsection Reply to an encrypted message
Newer versions of the plug-in provide a feature to decrypt the
message before the text is used in the reply mail. As a result,
the reply message will contain the plain text instead of the encrypted
GPG armored message.
This feature is automatically used whenever the user clicks on "Reply"
or "Reply All" in the Outlook main window. But only in the case, the
mail is actually encrypted. Optionally the plug-in will ask for a
key passphrase.

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

@itemize @bullet

@item
If you manually installed GPG and GPGoe, please make sure that
you installed GPG at a standard place or create at least the gpgBinary
registry entry. This is not needed if you use an automatic installer
like GPG4WIN or GnuPT.

@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. Newer versions of the plug-in
save the original clipboard text before encryption/signing and the
ext is restored after the GPG operation ends.

@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 Apple users, it is likely
that there are problems with the charset. Newer versions of the
plug-in try to handle UTF8 encoding correctly but even so it cannot
be 100% assured that the receiver can handle the text in all cases.

@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. The current version of the 
plug-in automatically uses WinPT for key import if the program
is available and running.

@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	twoaday	6	\input texinfo
2
3	twoaday	8	@setfilename GPGOE
4	twoaday	6
5			This file describes the GPGOE functions and the integration
6			in the Outlook Express mailer.
7
8	twoaday	15	This file is free under the terms of the GNU General Public License v2.
9
10			Copyright (C) 2006 Timo Schulz
11
12			@settitle GPGOE - the GnuPG plug-in for Outlook Express
13
14	twoaday	6	@section Requirements for GPGOE
15
16			First you need to have a working GnuPG installtion on the machine you
17			plan to install GPGOE. If you don't have GPG in your machine, please
18			visit http://www.gnupg.org and download the latest GPG version there.
19			It comes with a graphical installer so there is no need to do this
20			step manually.
21
22			You need at least Windows 2000/XP and at least Outlook Express 6.0
23			or higher. The plug-in will not work with earlier versions of Express.
24
25
26			@section Installation of the Plug-in
27
28			It is always recommend to use the latest version of the plug-in. You
29			can download it from http://wald.intevation.org/projects/gpgoe.
30			Download the zip file with the binaries inside and unpack them in
31			a folder. All files need to be in the same folder, so if you change
32			the folder don't forget to move all files.
33
34			To activate the plug-in you need to start gpgoeinit.exe. You should
35			now see a little (lock) icon in the taskbar which indicates that the
36			plug-in is running. If you want to quit the program, double click on
37			the (lock) icon and confirm the unload.
38
39			Now the plug-in is active.
40
41			@section Integration into Outlook Express
42
43			You have to enable the "Encrypt" and "Sign" items in the
44			toolbar, in the "New Message" dialog to allow GPGOE to
45			encrypt and/or sign the message.
46
47			There are no new icons for the plug-in and this means you
48			can either use S/MIME or OpenPGP but never at the same time.
49			If you want to use S/MIME again, just unload the plugin (quit
50			gpgoeinit.exe).
51
52			@section How to use the plug-in
53
54			@subsection Encrypt a message
55
56			To encrypt a mail, you need to check the "Encrypt" toolbar button.
57			If you click the "Send" button the plug-in will try to map each email
58			address to a user-ID of an existing OpenPGP key. If no unresolved
59			recipients were found, the mail is encrypted and stored in the outbox
60			folder. If one or more recipients couldn't be mapped to a key, the
61			recipient dialog is shown to manually select the recipients.
62
63			@subsection Sign a message
64
65			To sign a message, you need to check the "Sign" toolbar button.
66			If you click the "Send" button, GPG will figure out the default
67			signing key and the plug-in openes a passphrase dialog to enter
68			your passphrase for this key. If you entered it and the passphrase
69			was correct, the plugin will sign the message and store it in
70			the outbox.
71
72	twoaday	15	@subsection Sign and Encrypt a message
73			To sign and encrypt a message, you have to check both toolbar
74			buttons ("Sign" and "Encrypt"). The procedure is the same as
75			in encrypt-only when one or more email addresses couldn't be
76			mapped. Then the default key is used to sign the plaintext
77			before it is encrypted with the selected recipients.
78
79	twoaday	6	@subsection Decrypt and/or verify a message
80			If you received an OpenPGP message, you can just double-click
81			the message to open it. The plug-in will figure out if it is
82			encrypted or signed and will start the correct procedures. For
83			decryption you need to enter your passphrase, otherwise the
84			verify dialog is shown which contains information about the
85			signature status.
86			You can also use the "Next" and "Previous" toolbar buttons to
87			jump to the next message or to go back to the previous. The plug-in
88			will figure out the message status and will take the needed steps.
89			If the message is neither signed nor encrypted, no action is performed.
90
91	twoaday	15	@subsection Reply to an encrypted message
92			Newer versions of the plug-in provide a feature to decrypt the
93			message before the text is used in the reply mail. As a result,
94			the reply message will contain the plain text instead of the encrypted
95			GPG armored message.
96			This feature is automatically used whenever the user clicks on "Reply"
97			or "Reply All" in the Outlook main window. But only in the case, the
98			mail is actually encrypted. Optionally the plug-in will ask for a
99			key passphrase.
100
101	twoaday	6	@section Additional information and limitations of the GPGOE plug-in
102
103			@itemize @bullet
104
105			@item
106	twoaday	15	If you manually installed GPG and GPGoe, please make sure that
107			you installed GPG at a standard place or create at least the gpgBinary
108			registry entry. This is not needed if you use an automatic installer
109			like GPG4WIN or GnuPT.
110
111			@item
112	twoaday	7	Due to the fact the plug-in uses the clipboard for data transfer,
113			the clipboard itself can be only of limited use to copy/paste messages
114	twoaday	15	into the mailer window or elsewhere. Newer versions of the plug-in
115			save the original clipboard text before encryption/signing and the
116			ext is restored after the GPG operation ends.
117	twoaday	7
118			@item
119	twoaday	6	The current version of the plug-in will NOT encrypt any attachments
120			which are attached to the message. You either need to encrypt them
121			before or send them in cleartext. For the file encryption it is
122			recommend to use GPGee or WinPT.
123
124			The same needs to be done when an encrypted mail with encrypted
125			attachments is in the inbox folder. You need GPGee or WinPT to
126			decrypt the saved file.
127
128			@item
129			Even so the plug-in supports native line endings, which means you
130	twoaday	12	can properly exchange mails with Linux or Apple users, it is likely
131	twoaday	15	that there are problems with the charset. Newer versions of the
132			plug-in try to handle UTF8 encoding correctly but even so it cannot
133			be 100% assured that the receiver can handle the text in all cases.
134	twoaday	6
135			@item
136			If you want to import keys or attach keys to a mail, you have to
137			use an external key manager. WinPT is recommend in this case. It
138			contains features to send public keys to mail recipients and also
139			to export keys via the clipboard so you can easily paste the key
140	twoaday	12	into the text body of the message. The current version of the
141			plug-in automatically uses WinPT for key import if the program
142			is available and running.
143	twoaday	6
144			@item
145			Currently signing can be only done with the default signing key.
146			If you want to change the default signing key, you can use WinPT
147			to select a different key and then GPGOE will use this one.
148
149			@item
150			GPGOE is NOT able to handle PGP/MIME (RFC3156) style messages.
151			This means if you get such a message, the plug-in will not be
152			able to automatically decrypt it.
153			And due to the fact that the decrypted "attachment" will still
154			contain a lot of control and coding information, you cannot simply
155			decrypt it with WinPT/GPGee and use the output.
156
157			@end itemize
158
159			@bye