README.orig (5692B) - raw
1 ===============================================================================
2 Mail Notification overview
3 ===============================================================================
4
5 Index
6
7 0. About this document
8 1. About Mail Notification
9 2. Dependencies
10 3. Installation instructions
11 4. Issues in third-party software affecting Mail Notification
12
13 0. About this document
14
15 $Id: README,v 1.45 2008-03-19 23:22:09 jylefort Exp $
16
17 Copyright (C) 2003-2008 Jean-Yves Lefort.
18
19 Permission is granted to copy, distribute and/or modify this
20 document under the terms of the GNU Free Documentation License
21 (GFDL), Version 1.2 or any later version published by the Free
22 Software Foundation with no Invariant Sections, no Front-Cover
23 Texts, and no Back-Cover Texts. You can find a copy of the
24 GFDL at http://www.gnu.org/licenses/fdl.html or in the file
25 COPYING-DOCS distributed with this manual.
26
27 1. About Mail Notification
28
29 Mail Notification is a status icon (aka tray icon) that
30 informs you if you have new mail.
31
32 It works with system trays implementing the freedesktop.org
33 System Tray Specification, such as the GNOME Panel
34 Notification Area, the Xfce Notification Area and the KDE
35 System Tray.
36
37 Mail Notification features include:
38
39 * multiple mailbox support
40 * Evolution, Gmail, IMAP, Maildir, mbox, MH, Mozilla
41 products (Mozilla, SeaMonkey, Thunderbird, ...),
42 POP3, Sylpheed, Windows Live Hotmail and Yahoo! Mail
43 support
44 * SASL authentication support
45 * APOP authentication support
46 * SSL/TLS support
47 * automatic detection of mailbox format
48 * immediate notification (the status icon is updated
49 immediately or within seconds after a mailbox
50 changes)
51 * message popups
52 * HIG 2.0 compliance
53
54 2. Dependencies
55
56 Mandatory:
57
58 * GNOME (version 2.14.0 or superior)
59 http://www.gnome.org/
60
61 * libnotify (version 0.4.1 or superior)
62 http://www.galago-project.org/
63
64 Optional:
65
66 * for IMAP, Maildir, mbox, MH, Mozilla, POP3,
67 Sylpheed, Windows Live Hotmail and Yahoo! Mail
68 support:
69
70 GMime (version 2.2.7 or superior)
71 http://spruce.sourceforge.net/gmime/
72
73 * for Windows Live Hotmail support:
74
75 GetLive
76 http://sourceforge.net/projects/getlive/
77
78 * for Yahoo! Mail support:
79
80 FetchYahoo
81 http://fetchyahoo.twizzler.org/
82
83 * for SSL/TLS support:
84
85 OpenSSL (version 0.9.6 or superior)
86 http://www.openssl.org/
87
88 * for SASL authentication support:
89
90 Cyrus SASL (version 2.0 or superior)
91 http://asg.web.cmu.edu/sasl/sasl-library.html
92
93 * for Evolution support:
94
95 Evolution (version 2.12 or superior)
96 http://www.gnome.org/projects/evolution/
97
98 3. Installation instructions
99
100 To configure, build and install Mail Notification, use the
101 following commands:
102
103 ./jb configure
104 ./jb build
105 sudo ./jb install
106
107 Note that a number of settings can be passed to the configure
108 stage, for instance:
109
110 ./jb configure prefix=/opt cflags=-O3 pop3=no
111
112 For details, use:
113
114 ./jb help
115
116 For more informations about JB (the Jean-Yves Lefort's Build
117 System), read jbsrc/lib/README.
118
119 Note to Sylpheed users: if you want more responsive
120 notifications, apply the patch data/sylpheed-locking.diff to
121 Sylpheed and recompile it.
122
123 4. Issues in third-party software affecting Mail Notification
124
125 * Thread-safety bugs in libgnomeui may cause Mail Notification
126 (and other multi-threaded GNOME applications) to crash or
127 hang.
128
129 http://bugzilla.gnome.org/show_bug.cgi?id=152023
130 fixed:
131 - FreeBSD port x11-toolkits/libgnomeui >= 2.10.0_1
132 - libgnomeui CVS >= 20060102
133 - libgnomeui >= 2.13.2
134
135 http://bugzilla.gnome.org/show_bug.cgi?id=312180
136 fixed:
137 - FreeBSD port x11-toolkits/libgnomeui >= 2.10.1_1
138 - libgnomeui CVS >= 20060208
139 - libgnomeui >= 2.15.90
140
141 * An infinite loop in GnomeVFS may affect mailboxes which use
142 HTTP authentication (for instance, Gmail mailboxes).
143
144 http://bugzilla.gnome.org/show_bug.cgi?id=310596
145 fixed:
146 - GnomeVFS CVS >= 20050724
147 - GnomeVFS >= 2.11.90
148
149 * If GnomeVFS was built with GnuTLS support, a GnomeVFS bug
150 may cause Mail Notification to crash when accessing a
151 mailbox over SSL (for instance, a Gmail mailbox) with
152 GnomeVFS. The crash is accompanied by an error message
153 similar to the following:
154
155 mail-notification: ath.c:181: _gcry_ath_mutex_lock: Assertion `*lock == ((ath_mutex_t) 0)' failed.
156 Xlib: unexpected async reply (sequence 0x2cc0)!
157
158 http://bugzilla.gnome.org/show_bug.cgi?id=172813
159 fixed:
160 - GnomeVFS CVS >= 20050411
161 - GnomeVFS >= 2.11.1
162
163 * An infinite loop in GnomeVFS may affect mailboxes which use
164 the GnomeVFS bzip2 method.
165
166 http://bugzilla.gnome.org/show_bug.cgi?id=322652
167 fixed:
168 - FreeBSD port devel/gnomevfs2 >= 2.12.1.1_4
169 - GnomeVFS CVS >= 20051201
170 - GnomeVFS >= 2.13.2
171
172 * A bug in GnomeVFS may prevent successful authentication if
173 an username or password contains special characters such as
174 '@'.
175
176 http://bugzilla.gnome.org/show_bug.cgi?id=89106
177 fixed:
178 - GnomeVFS CVS >= 20050716
179 - GnomeVFS >= 2.11.90
180
181 * A bug in GnomeVFS may occasionally cause mbox, MH, Maildir
182 and Sylpheed mailbox changes to stay undetected.
183
184 http://bugzilla.gnome.org/show_bug.cgi?id=341585
185 fixed:
186 - FreeBSD port devel/gnomevfs2 >= 2.14.1_2
187 - GnomeVFS >= 2.15.90
188
189 * A bug in GnomeVFS causes intermittent Gmail errors when the
190 delay between mail checks is set to a small value.
191
192 http://bugzilla.gnome.org/show_bug.cgi?id=455972
193
194 * Bugs in GnomeVFS may cause various problems with mailboxes
195 accessed through ssh/sftp.
196
197 http://bugzilla.gnome.org/show_bug.cgi?id=500307
198 http://bugzilla.gnome.org/show_bug.cgi?id=500533
199 http://bugzilla.gnome.org/show_bug.cgi?id=500538