summaryrefslogtreecommitdiffstats
path: root/gnome-users-guide/gnome-users-guide-1.4/C/applets/mailcheck-ug.sgml
blob: bd9f554d69b333ac918a5459a5720840f3f45147 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 <sect2 id="applets-core-mailcheck">
  <title>The Mail Check Applet</title> 

  <para>
    The <application>mailcheck applet</application> is an applet which
    sits in your panel and tells you when you have new email. To add 
    this applet to the panel, right-click on the panel and choose
    <menuchoice>
     <guimenu>Add applet</guimenu>
     <guisubmenu>Network</guisubmenu>
     <guimenuitem>Mailcheck</guimenuitem>
    </menuchoice>
  </para>

  <figure id="mailcheck-applets-core-fig">
    <title>Mail Check Applet</title>
    <screenshot>
      <screeninfo>Mail Check Applet</screeninfo>
      <graphic format="png" fileref="figures/mailcheck-applet" 
	     srccredit="Eric Baudais">
      </graphic>
    </screenshot>
  </figure>

   <sect3 id="mailcheck-usage">
    <title> Usage</title>
    <para>
      You don't need to do anything in particular to run this applet.
      Providing it is looking in the right place for your email, it
      will run itself quite happily. The following options, however,
      are available:
    </para>
 
    <itemizedlist>
     <listitem>
      <para>
        Clicking <mousebutton>mouse button 1</mousebutton> does nothing
        unless you have told it to start a program when you do this. You
        do this with the properties box described <link
        linkend="mailcheck-prefs">below</link>.
      </para>
     </listitem>
     <listitem>
      <para>
        Holding down <mousebutton>mouse button 2</mousebutton> allows
        you to drag the applet around the panel (and between panels).
        option.
      </para>
     </listitem>
     <listitem>
      <para>
        Clicking <mousebutton>mouse button 3</mousebutton> brings up
        the typical <guimenu>applet menu</guimenu> which includes an
        About box and a <link linkend="mailcheck-prefs">properties</link>
      </para>
     </listitem>
    </itemizedlist>
   </sect3>
 
   <sect3 id="mailcheck-prefs">
    <title>Preferences</title>
    <para>
       The mailcheck <interface>properties dialogue box</interface> is
       divided into two sections, one for what the mail check applet
       does, and one for where it checks for email.
    </para>

    <figure id="mailcheck-settings-mailcheck-fig">
      <title>Properties dialog &mdash; Mail check tab</title>
      <screenshot>
	<screeninfo>Properties dialog - Mail check tab</screeninfo>
	<graphic format="png" fileref="figures/mailcheck-properties-mailcheck"
	       srccredit="Eric Baudais">
	</graphic>
      </screenshot>
    </figure>
  
    <variablelist>
     <varlistentry>
      <term>Mail check options</term>
      <listitem>
       <para>
         The mail check options have six sections:
       </para>
 
       <variablelist>
        <varlistentry>
         <term>Execute...before each update</term>
         <listitem>
          <para>
            Sometimes you may want to run something such as
            <application>fetchmail</application> before the applet 
            checks for new mail. To do this, check the checkbox and
            fill in the program name in the space here.
          </para>
         </listitem>
        </varlistentry>
 
        <varlistentry>
         <term>Execute...when new mail arrives</term>
         <listitem>
          <para>
            Sometimes you may want other programs to run when new mail
            arrives. It is common to tell the machine to play a noise
            at you, for example. Checking this checkbox and filling in
            the command (such as <command>mpg123
            <replaceable>sillynoise.mpg</replaceable></command> or
            <command>esdplay
            <replaceable>sillynoise.wav</replaceable></command>) will
            let this happen.
          </para>
         </listitem>
        </varlistentry>
 
        <varlistentry>
         <term>Execute...when clicked</term>
         <listitem>
          <para>
            By putting a program name (generally a mail-reader such as
            <application>balsa</application> or <application>spruce</application>
            here and clicking on the checkbox, you can set things up so that
            when you click <mousebutton>button 1</mousebutton> on the 
            applet, that program will be automatically run.
          </para>
         </listitem>
        </varlistentry>
 
        <varlistentry>
         <term>Check for mail every...</term>
         <listitem>
          <para>
            You can adjust the range for checking whether mail has arrived
            between 1440 minutes (once a day) to never. Setting it to never
            is silly and will confuse it. The default value is every two
            minutes.
          </para>
         </listitem>
        </varlistentry>
 
        <varlistentry>
         <term>Play a sound when new mail arrives</term>
         <listitem>
          <para>
            The sound played if you check this <guibutton>checkbox</guibutton>
            is an alarm bell. It is contained in
            <filename>$prefix/sound/events/mailcheck.soundlist</filename>;
            if you want to change it to a different sound, alter that and
            put the sound in <filename>$prefix/sounds/</filename>.
          </para>
         </listitem>
        </varlistentry>
  
        <varlistentry>
         <term>Select animation</term>
         <listitem>
          <para>
            By clicking on the <guilabel>box with the animation name</guilabel>,
            you can get a list of different pictures which have different
            animations when new email arrives.
          </para>
         </listitem>
        </varlistentry>
       </variablelist>
      </listitem>   
     </varlistentry>
    </variablelist>

      <figure id="mailcheck-settings-mailbox-fig">
	<title>Properties dialog &mdash; Mailbox tab</title>
	<screenshot>
	  <screeninfo>Properties dialog - Mailbox tab</screeninfo>
	  <graphic format="png" fileref="figures/mailcheck-properties-mailbox"
		 srccredit="Eric Baudais">
	  </graphic>
	</screenshot>
      </figure>

    <variablelist>
     <varlistentry>
      <term>Mailbox options</term>
      <listitem>
       <para>
         The mailbox options have four sections, some of which will be
         greyed-out.
       </para>
           
       <para>
         By clicking on the <guilabel>box with the mailbox location</guilabel>,
         you can tell the mailcheck applet where to look for your incoming
         email.
       </para>
       <itemizedlist>
        <listitem>
         <para>
           When local mailspool or local maildir are selected as the location
           for the mailbox, then you can fill in the details on which file
           or directory the applet should check for new email. You can only
           put one filename here. The section about mail servers will be
           greyed out.
          </para>
         </listitem>
         <listitem>
          <para>
           When remote POP3 or remote IMAP are selected as the location for
           the mailbox, then you can fill in the details on the mail server,
           username and password. If the you don't supply the password, the
           applet will ask for it when it first tries to check for mail.
           The section about local filenames will be greyed out.
         </para>
        </listitem>
       </itemizedlist>
      </listitem>
     </varlistentry>    
   </variablelist>
  </sect3>
 
  <sect3 id="mailcheck-bugs">
   <title> Known bugs and limitations</title>
   <itemizedlist>
    <listitem>
     <para>
       Setting something to be executed before each update can hang the
       applet and the panel.
     </para>
    </listitem>
    <listitem>
     <para>
       Sometimes the animation stops happening after prolonged use.
     </para>
    </listitem>
    <listitem>
     <para>
       If you use a mail filter such as <application>procmail</application>,
       which sorts email into different folders, the applet won't check them
       all for new email. It will only look at one file.
     </para>
    </listitem>
   </itemizedlist>
  </sect3>

  <!-- ============= Authors ================================ -->

  <sect3 id="mailcheck-authors">
   <title>Authors</title>
   <para>
    <application>Mail Check</application> was written by  
      Miguel de Icaza (<email>miguel@gnu.org</email>),
      Jacob Berkman (<email>jberkman@andrew.cmu.edu</email>),
      Jaka Mocnik (<email>jaka.mocnik@kiss.uni-lj.si</email>) and
      Lennart Poettering (<email>poettering@gmx.net</email>).  
      Please send all comments, suggestions, and bug 
      reports to the <ulink url="http://bugs.gnome.org/" type="http">GNOME
      bug tracking database</ulink>. (Instructions for submitting bug
      reports can be found <ulink
      url="http://bugs.gnome.org/Reporting.html" type="http">
      on-line</ulink>. If you are using
      GNOME 1.1 or later, you can also use <application>Bug Report
      Tool</application> (<command>bug-buddy</command>), available in the
      <guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main
      Menu</guimenu>, for submitting bug reports.
   </para>

   <para>
      This manual was written by Telsa Gwynne
      (<email>telsa@linuxchix.org</email>) and Eric Baudais
      (<email>baudais@okstate.edu</email>). Please send all comments
      and suggestions regarding this manual to the <ulink type="http"
      url="http://developer.gnome.org/projects/gdp/">GNOME
      Documentation Project</ulink> by sending an email to
      <email>docs@gnome.org</email>. You can also submit comments
      online by using the <ulink type="http"
      url="http://developer.gnome.org/projects/gdp/doctable/">GNOME
      Documentation Status Table</ulink>.
   </para>

   <!-- For translations: uncomment this:

   <para>  
    Latin translation was done by ME
    (<email>MYNAME@MYADDRESS</email>). Please send all  comments  and
    suggestions regarding this translation to SOMEWHERE.
   </para>

   -->

  </sect3>


  <!-- ============= Application License ============================= -->

  <!-- 
   <sect3 id="license">
   <title>License</title>
   <para>
    This program is free software; you can redistribute it and/or
    modify it under the terms of the <ulink type="help"
    url="gnome-help:gpl"><citetitle>GNU General Public
    License</citetitle></ulink> as published by the Free Software
    Foundation; either version 2 of the License, or (at your option)
    any later version.
   </para>
   <para>
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    <ulink type="help" url="gnome-help:gpl"><citetitle>GNU General
    Public License</citetitle></ulink> for more details.
   </para>
   <para>
    A copy of the <ulink type="help"
    url="gnome-help:gpl"><citetitle>GNU General Public
    License</citetitle></ulink> is included with the GNOME documentation. You
    also may obtain a
    copy of the <ulink type="help" url="gnome-help:gpl"><citetitle>GNU
    General Public License</citetitle></ulink> from the Free Software
    Foundation by visiting <ulink type="http"
    url="http://www.fsf.org/">their Web site</ulink> or by writing to
    <address>
     Free Software Foundation, Inc.
     <street>59 Temple Place</street> - Suite 330
     <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
     <country>USA</country>
    </address>
   </para>
  </sect3>

 --> 
 </sect2>