help/C/mail-notification.xml (60403B) - raw
1 <?xml version="1.0"?> 2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ 4 <!ENTITY app "<application>Mail Notification</application>"> 5 <!ENTITY appversion "5.4"> 6 <!ENTITY manrevision "2.25"> 7 <!ENTITY date "Thursday, May 22, 2008"> 8 9 <!ENTITY project "The Mail Notification Project"> 10 11 <!ENTITY documentation-license SYSTEM "documentation-license.xml"> 12 <!ENTITY software-license SYSTEM "software-license.xml"> 13 14 <!ENTITY aka "<acronym>aka</acronym>"> 15 <!ENTITY uri "<link linkend="uri">URI</link>"> 16 <!ENTITY maildir "<link linkend="maildir">Maildir</link>"> 17 <!ENTITY mbox "<link linkend="mbox">mbox</link>"> 18 <!ENTITY mh "<link linkend="mh">MH</link>"> 19 <!ENTITY pop3 "<link linkend="pop3">POP3</link>"> 20 <!ENTITY imap "<link linkend="imap">IMAP</link>"> 21 <!ENTITY sasl "<link linkend="sasl">SASL</link>"> 22 <!ENTITY ssl "<link linkend="pop3">SSL</link>"> 23 <!ENTITY tls "<link linkend="pop3">TLS</link>"> 24 <!ENTITY mozilla "<link linkend="mozilla">Mozilla</link>"> 25 <!ENTITY sylpheed "<link linkend="sylpheed">Sylpheed</link>"> 26 <!ENTITY gnomevfs "<link linkend="gnomevfs">GnomeVFS</link>"> 27 ]> 28 29 <!-- $Id: mail-notification.xml,v 1.187 2008-05-22 15:44:32 jylefort Exp $ --> 30 <!-- Mail Notification Manual --> 31 32 <!-- Copyright (C) 2003-2008 Jean-Yves Lefort --> 33 <!-- All rights reserved. --> 34 35 <!-- See documentation-license.xml for licensing information. --> 36 37 <!-- This document does its best to adhere to the --> 38 <!-- GNOME Documentation Style Guide V1.3 --> 39 <!-- (http://developer.gnome.org/documents/style-guide) --> 40 41 <article id="index" lang="en"> 42 <!-- please do not change the id; for translations, change lang to --> 43 <!-- appropriate code --> 44 <articleinfo> 45 <title>&app; Manual V&manrevision;</title> 46 47 <copyright> 48 <year>2004</year> 49 <year>2005</year> 50 <year>2006</year> 51 <year>2007</year> 52 <year>2008</year> 53 <holder>Jean-Yves Lefort</holder> 54 </copyright> 55 <!-- translators: uncomment this: 56 57 <copyright> 58 <year>2002</year> 59 <holder>ME-THE-TRANSLATOR (Latin translation)</holder> 60 </copyright> 61 62 --> 63 <publisher> 64 <publishername>&project;</publishername> 65 </publisher> 66 67 &documentation-license; 68 69 <authorgroup> 70 <author> 71 <firstname>Jean-Yves</firstname> 72 <surname>Lefort</surname> 73 <affiliation> 74 <orgname>&project;</orgname> 75 <address><email>jylefort@brutele.be</email></address> 76 </affiliation> 77 </author> 78 79 <!-- This is appropriate place for other contributors: translators, 80 maintainers, etc. Commented out by default. 81 82 <othercredit role="translator"> 83 <firstname>Latin</firstname> 84 <surname>Translator 1</surname> 85 <affiliation> 86 <orgname>Latin Translation Team</orgname> 87 <address> <email>translator@gnome.org</email> </address> 88 </affiliation> 89 <contrib>Latin translation</contrib> 90 </othercredit> 91 --> 92 </authorgroup> 93 94 <!-- The revision numbering system for GNOME manuals is as follows: --> 95 <!-- * the revision number consists of two components --> 96 <!-- * the first component of the revision number reflects the release version of the GNOME desktop. --> 97 <!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. --> 98 <!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that --> 99 <!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. --> 100 <!-- When the desktop release version changes to V3.x, the revision number of the manual changes --> 101 <!-- to V3.0, and so on. --> 102 <revhistory> 103 <revision> 104 <revnumber>Mail Notification Manual V&manrevision;</revnumber> 105 <date>&date;</date> 106 <revdescription> 107 <para role="author"> 108 Jean-Yves Lefort 109 <email>jylefort@brutele.be</email> 110 </para> 111 <para role="publisher">&project;</para> 112 </revdescription> 113 </revision> 114 <revision> 115 <revnumber>Mail Notification Manual V2.24</revnumber> 116 <date>Sunday, April 27, 2008</date> 117 <revdescription> 118 <para role="author"> 119 Jean-Yves Lefort 120 <email>jylefort@brutele.be</email> 121 </para> 122 <para role="publisher">&project;</para> 123 </revdescription> 124 </revision> 125 <revision> 126 <revnumber>Mail Notification Manual V2.23</revnumber> 127 <date>Thursday, March 20, 2008</date> 128 <revdescription> 129 <para role="author"> 130 Jean-Yves Lefort 131 <email>jylefort@brutele.be</email> 132 </para> 133 <para role="publisher">&project;</para> 134 </revdescription> 135 </revision> 136 <revision> 137 <revnumber>Mail Notification Manual V2.22</revnumber> 138 <date>Thursday, March 20, 2008</date> 139 <revdescription> 140 <para role="author"> 141 Jean-Yves Lefort 142 <email>jylefort@brutele.be</email> 143 </para> 144 <para role="publisher">&project;</para> 145 </revdescription> 146 </revision> 147 <revision> 148 <revnumber>Mail Notification Manual V2.21</revnumber> 149 <date>Friday, January 4, 2008</date> 150 <revdescription> 151 <para role="author"> 152 Jean-Yves Lefort 153 <email>jylefort@brutele.be</email> 154 </para> 155 <para role="publisher">&project;</para> 156 </revdescription> 157 </revision> 158 <revision> 159 <revnumber>Mail Notification Manual V2.20</revnumber> 160 <date>Tuesday, November 27, 2007</date> 161 <revdescription> 162 <para role="author"> 163 Jean-Yves Lefort 164 <email>jylefort@brutele.be</email> 165 </para> 166 <para role="publisher">&project;</para> 167 </revdescription> 168 </revision> 169 <revision> 170 <revnumber>Mail Notification Manual V2.19</revnumber> 171 <date>Tuesday, June 26, 2007</date> 172 <revdescription> 173 <para role="author"> 174 Jean-Yves Lefort 175 <email>jylefort@brutele.be</email> 176 </para> 177 <para role="publisher">&project;</para> 178 </revdescription> 179 </revision> 180 <revision> 181 <revnumber>Mail Notification Manual V2.18</revnumber> 182 <date>Wednesday, January 17, 2007</date> 183 <revdescription> 184 <para role="author"> 185 Jean-Yves Lefort 186 <email>jylefort@brutele.be</email> 187 </para> 188 <para role="publisher">&project;</para> 189 </revdescription> 190 </revision> 191 <revision> 192 <revnumber>Mail Notification Manual V2.17</revnumber> 193 <date>Thursday, December 7, 2006</date> 194 <revdescription> 195 <para role="author"> 196 Jean-Yves Lefort 197 <email>jylefort@brutele.be</email> 198 </para> 199 <para role="publisher">&project;</para> 200 </revdescription> 201 </revision> 202 <revision> 203 <revnumber>Mail Notification Manual V2.16</revnumber> 204 <date>Monday, November 27, 2006</date> 205 <revdescription> 206 <para role="author"> 207 Jean-Yves Lefort 208 <email>jylefort@brutele.be</email> 209 </para> 210 <para role="publisher">&project;</para> 211 </revdescription> 212 </revision> 213 <revision> 214 <revnumber>Mail Notification Manual V2.15</revnumber> 215 <date>Wednesday, June 14, 2006</date> 216 <revdescription> 217 <para role="author"> 218 Jean-Yves Lefort 219 <email>jylefort@brutele.be</email> 220 </para> 221 <para role="publisher">&project;</para> 222 </revdescription> 223 </revision> 224 <revision> 225 <revnumber>Mail Notification Manual V2.14</revnumber> 226 <date>Thursday, May 18, 2006</date> 227 <revdescription> 228 <para role="author"> 229 Jean-Yves Lefort 230 <email>jylefort@brutele.be</email> 231 </para> 232 <para role="publisher">&project;</para> 233 </revdescription> 234 </revision> 235 <revision> 236 <revnumber>Mail Notification Manual V2.13</revnumber> 237 <date>Tuesday, May 16, 2006</date> 238 <revdescription> 239 <para role="author"> 240 Jean-Yves Lefort 241 <email>jylefort@brutele.be</email> 242 </para> 243 <para role="publisher">&project;</para> 244 </revdescription> 245 </revision> 246 <revision> 247 <revnumber>Mail Notification Manual V2.12</revnumber> 248 <date>Tuesday, August 9, 2005</date> 249 <revdescription> 250 <para role="author"> 251 Jean-Yves Lefort 252 <email>jylefort@brutele.be</email> 253 </para> 254 <para role="publisher">&project;</para> 255 </revdescription> 256 </revision> 257 <revision> 258 <revnumber>Mail Notification Manual V2.11</revnumber> 259 <date>Sunday, March 6, 2005</date> 260 <revdescription> 261 <para role="author"> 262 Jean-Yves Lefort 263 <email>jylefort@brutele.be</email> 264 </para> 265 <para role="publisher">&project;</para> 266 </revdescription> 267 </revision> 268 <revision> 269 <revnumber>Mail Notification Manual V2.10</revnumber> 270 <date>Thursday, November 25, 2004</date> 271 <revdescription> 272 <para role="author"> 273 Jean-Yves Lefort 274 <email>jylefort@brutele.be</email> 275 </para> 276 <para role="publisher">&project;</para> 277 </revdescription> 278 </revision> 279 <revision> 280 <revnumber>Mail Notification Manual V2.9</revnumber> 281 <date>Monday, November 15, 2004</date> 282 <revdescription> 283 <para role="author"> 284 Jean-Yves Lefort 285 <email>jylefort@brutele.be</email> 286 </para> 287 <para role="publisher">&project;</para> 288 </revdescription> 289 </revision> 290 <revision> 291 <revnumber>Mail Notification Manual V2.8</revnumber> 292 <date>Thursday, November 4, 2004</date> 293 <revdescription> 294 <para role="author"> 295 Jean-Yves Lefort 296 <email>jylefort@brutele.be</email> 297 </para> 298 <para role="publisher">&project;</para> 299 </revdescription> 300 </revision> 301 <revision> 302 <revnumber>Mail Notification Manual V2.7</revnumber> 303 <date>Sunday, October 31, 2004</date> 304 <revdescription> 305 <para role="author"> 306 Jean-Yves Lefort 307 <email>jylefort@brutele.be</email> 308 </para> 309 <para role="publisher">&project;</para> 310 </revdescription> 311 </revision> 312 <revision> 313 <revnumber>Mail Notification Manual V2.6</revnumber> 314 <date>Monday, October 25, 2004</date> 315 <revdescription> 316 <para role="author"> 317 Jean-Yves Lefort 318 <email>jylefort@brutele.be</email> 319 </para> 320 <para role="publisher">&project;</para> 321 </revdescription> 322 </revision> 323 <revision> 324 <revnumber>Mail Notification Manual V2.5</revnumber> 325 <date>Wednesday, October 6, 2004</date> 326 <revdescription> 327 <para role="author"> 328 Jean-Yves Lefort 329 <email>jylefort@brutele.be</email> 330 </para> 331 <para role="publisher">&project;</para> 332 </revdescription> 333 </revision> 334 <revision> 335 <revnumber>Mail Notification Manual V2.4</revnumber> 336 <date>Thursday, September 9, 2004</date> 337 <revdescription> 338 <para role="author"> 339 Jean-Yves Lefort 340 <email>jylefort@brutele.be</email> 341 </para> 342 <para role="publisher">&project;</para> 343 </revdescription> 344 </revision> 345 <revision> 346 <revnumber>Mail Notification Manual V2.3</revnumber> 347 <date>Thursday, August 19, 2004</date> 348 <revdescription> 349 <para role="author"> 350 Jean-Yves Lefort 351 <email>jylefort@brutele.be</email> 352 </para> 353 <para role="publisher">&project;</para> 354 </revdescription> 355 </revision> 356 <revision> 357 <revnumber>Mail Notification Manual V2.2</revnumber> 358 <date>Monday, August 16, 2004</date> 359 <revdescription> 360 <para role="author"> 361 Jean-Yves Lefort 362 <email>jylefort@brutele.be</email> 363 </para> 364 <para role="publisher">&project;</para> 365 </revdescription> 366 </revision> 367 <revision> 368 <revnumber>Mail Notification Manual V2.1</revnumber> 369 <date>Wednesday, July 21, 2004</date> 370 <revdescription> 371 <para role="author"> 372 Jean-Yves Lefort 373 <email>jylefort@brutele.be</email> 374 </para> 375 <para role="publisher">&project;</para> 376 </revdescription> 377 </revision> 378 <revision> 379 <revnumber>Mail Notification Manual V2.0</revnumber> 380 <date>Tuesday, June 29, 2004</date> 381 <revdescription> 382 <para role="author"> 383 Jean-Yves Lefort 384 <email>jylefort@brutele.be</email> 385 </para> 386 <para role="publisher">&project;</para> 387 </revdescription> 388 </revision> 389 </revhistory> 390 391 <releaseinfo> 392 This manual describes version &appversion; of Mail Notification. 393 </releaseinfo> 394 <legalnotice> 395 <title>Feedback</title> 396 <para>To report a bug or make a suggestion regarding the &app; 397 application or this manual, follow the directions in 398 <xref linkend="problem-reports"/>. 399 </para> 400 <!-- Translators may also add here feedback address for translations --> 401 </legalnotice> 402 </articleinfo> 403 404 <indexterm zone="index"> 405 <primary>Mail Notification</primary> 406 </indexterm> 407 408 <sect1 id="introduction"> 409 <title>Introduction</title> 410 <para> 411 &app; is a status icon (&aka; tray icon) that informs you if you 412 have new mail. 413 </para> 414 <para> 415 It works with system trays implementing the freedesktop.org 416 <ulink url="http://www.freedesktop.org/Standards/systemtray-spec" type="http">System Tray Specification</ulink>, such as the 417 GNOME Panel Notification Area, the Xfce Notification Area and the KDE System Tray. 418 </para> 419 <para> 420 &app; features include: 421 </para> 422 <itemizedlist> 423 <listitem><para>multiple mailbox support</para></listitem> 424 <listitem><para>Evolution, Gmail, &imap;, &maildir;, &mbox;, &mh;, &mozilla; products (Mozilla, SeaMonkey, Thunderbird, …), &pop3;, &sylpheed;, Windows Live Hotmail and Yahoo! Mail support</para></listitem> 425 <listitem><para>&sasl; authentication support</para></listitem> 426 <listitem><para>APOP authentication support</para></listitem> 427 <listitem><para>&ssl;/&tls; support</para></listitem> 428 <listitem><para>automatic detection of mailbox format</para></listitem> 429 <listitem><para><link linkend="immediate-notification">immediate notification</link> (the status icon is updated immediately or within seconds after a mailbox changes)</para></listitem> 430 <listitem><para>message popups</para></listitem> 431 <listitem><para><ulink url="http://developer.gnome.org/projects/gup/hig" type="http">HIG</ulink> 2.0 compliance</para></listitem> 432 </itemizedlist> 433 </sect1> 434 435 <sect1 id="getting-started"> 436 <title>Getting Started</title> 437 438 <sect2 id="to-start"> 439 <title>To Start &app;</title> 440 <para> 441 You can start &app; in the following ways: 442 </para> 443 <variablelist> 444 <varlistentry> 445 <term><guimenu>System</guimenu> menu</term> 446 <listitem> 447 <para>Choose 448 <menuchoice> 449 <guisubmenu>Preferences</guisubmenu> 450 <guimenuitem>&app;</guimenuitem> 451 </menuchoice> (this location may vary across systems).</para> 452 </listitem> 453 </varlistentry> 454 455 <varlistentry> 456 <term>Command line</term> 457 <listitem> 458 <para> 459 To start &app; from a command line, type the following 460 command in a terminal: 461 </para> 462 <para> 463 <command>mail-notification</command> 464 <replaceable>options</replaceable> 465 </para> 466 <para> 467 where <replaceable>options</replaceable> is one or more options 468 from the following non-exhaustive list: 469 </para> 470 <variablelist> 471 <varlistentry> 472 <term>-v, --version</term> 473 <listitem><para>Show version information and compiled-in features</para></listitem> 474 </varlistentry> 475 476 <varlistentry> 477 <term>-i, --enable-info</term> 478 <listitem> 479 <para>Enable informational output</para> 480 <warning> 481 <title>Security</title> 482 <para> 483 The output of --enable-info may contain 484 sensitive information such as passwords and 485 session transcripts. 486 </para> 487 </warning> 488 </listitem> 489 </varlistentry> 490 491 <varlistentry> 492 <term>-p, --display-properties</term> 493 <listitem><para>Display the properties dialog</para></listitem> 494 </varlistentry> 495 496 <varlistentry> 497 <term>-a, --display-about</term> 498 <listitem><para>Display the about dialog</para></listitem> 499 </varlistentry> 500 501 <varlistentry> 502 <term>-r, --consider-new-mail-as-read</term> 503 <listitem><para>Consider new mail as read</para></listitem> 504 </varlistentry> 505 506 <varlistentry> 507 <term>-u, --update</term> 508 <listitem><para>Update the mail status</para></listitem> 509 </varlistentry> 510 511 <varlistentry> 512 <term>-s, --print-summary</term> 513 <listitem><para>Print a XML mail summary</para></listitem> 514 </varlistentry> 515 516 <varlistentry> 517 <term>--unset-obsolete-configuration</term> 518 <listitem><para>Unset obsolete <application>GConf</application> configuration</para></listitem> 519 </varlistentry> 520 521 <varlistentry> 522 <term>-q, --quit</term> 523 <listitem><para>Quit &app;</para></listitem> 524 </varlistentry> 525 526 <varlistentry> 527 <term>-?, --help</term> 528 <listitem><para>Show help</para></listitem> 529 </varlistentry> 530 </variablelist> 531 </listitem> 532 </varlistentry> 533 </variablelist> 534 </sect2> 535 536 <sect2 id="when-start"> 537 <title>When You Start &app;</title> 538 <para> 539 When you start &app;, it puts itself in the background and 540 monitors the status of your mailboxes. 541 </para> 542 <para> 543 When new mail arrives, an icon similar to the following one is 544 displayed in the notification area (&aka; system tray). The 545 number of new messages is displayed over the icon. 546 </para> 547 <figure id="no-mail-fig"> 548 <title>&app; when there is new mail</title> 549 <screenshot> 550 <mediaobject> 551 <imageobject> 552 <imagedata fileref="figures/mail.png" format="PNG"/> 553 </imageobject> 554 <textobject> 555 <phrase>Shows the &app; status icon.</phrase> 556 </textobject> 557 </mediaobject> 558 </screenshot> 559 </figure> 560 <para> 561 Additionally: 562 </para> 563 <itemizedlist> 564 <listitem> 565 <para> 566 if the <link 567 linkend="play-a-sound-when-new-mail-arrives">Play a sound 568 when new mail arrives</link> setting is enabled, that sound 569 is played 570 </para> 571 </listitem> 572 <listitem> 573 <para> 574 if the <link linkend="enable-message-popups">Enable 575 message popups</link> setting is enabled, information 576 about each new message is popped up on your desktop 577 </para> 578 </listitem> 579 </itemizedlist> 580 <para> 581 If an error is detected, the icon blinks. 582 </para> 583 <para> 584 Leaving your mouse over the icon will reveal more details 585 about the status of your mailboxes. Clicking on the 586 icon will perform the action specified in the 587 <link linkend="click-action">Click Action</link> setting. 588 </para> 589 </sect2> 590 </sect1> 591 592 <sect1 id="properties"> 593 <title>Properties</title> 594 <para>To configure &app;, choose 595 <menuchoice> 596 <guimenu>System</guimenu> 597 <guisubmenu>Preferences</guisubmenu> 598 <guimenuitem>Mail Notification</guimenuitem> 599 </menuchoice> (this location may vary across systems). 600 </para> 601 <para> 602 The <guilabel>Properties</guilabel> dialog contains the 603 following tabbed sections: 604 </para> 605 <itemizedlist> 606 <listitem> 607 <para><link linkend="properties-general">General</link></para> 608 </listitem> 609 <listitem> 610 <para><link linkend="properties-status-icon">Status Icon</link></para> 611 </listitem> 612 <listitem> 613 <para><link linkend="properties-message-popups">Message Popups</link></para> 614 </listitem> 615 </itemizedlist> 616 <para> 617 In addition, at the bottom of the dialog, the <guilabel>Display 618 test messages</guilabel> setting can be used to test the various 619 settings against test messages. 620 </para> 621 622 <sect2 id="properties-general"> 623 <title>General</title> 624 <variablelist> 625 <varlistentry> 626 <term><guilabel>General</guilabel></term> 627 <listitem> 628 <variablelist> 629 <varlistentry id="play-a-sound-when-new-mail-arrives"> 630 <term><guilabel>Play a sound when new mail arrives</guilabel></term> 631 <listitem> 632 <para> 633 If this setting is enabled, the selected sound 634 will be played when new mail arrives. 635 </para> 636 </listitem> 637 </varlistentry> 638 </variablelist> 639 </listitem> 640 </varlistentry> 641 <varlistentry id="mailbox-list"> 642 <term><guilabel>Mailbox List</guilabel></term> 643 <listitem> 644 <para> 645 This is the list of mailboxes to monitor for new 646 mail. Selecting <guibutton>Add</guibutton> or 647 <guibutton>Properties</guibutton> will display the <link linkend="mailbox-properties">Mailbox Properties</link> 648 dialog. 649 <tip> 650 <para> 651 You can drag a file or folder into this list. 652 </para> 653 </tip> 654 </para> 655 </listitem> 656 </varlistentry> 657 </variablelist> 658 </sect2> 659 660 <sect2 id="properties-status-icon"> 661 <title>Status Icon</title> 662 <variablelist> 663 <varlistentry id="click-action"> 664 <term><guilabel>Click Action</guilabel></term> 665 <listitem> 666 <variablelist> 667 <varlistentry> 668 <term><guilabel>Launch the mail reader</guilabel></term> 669 <listitem> 670 <para> 671 Launches the GNOME mail reader. To specify your 672 preferred mail reader, choose 673 <menuchoice> 674 <guimenu>System</guimenu> 675 <guisubmenu>Preferences</guisubmenu> 676 <guimenuitem>Preferred Applications</guimenuitem> 677 </menuchoice> (this location may vary across systems). 678 </para> 679 </listitem> 680 </varlistentry> 681 <varlistentry> 682 <term><guilabel>Open the latest message</guilabel></term> 683 <listitem> 684 <para> 685 Opens the most recent message, if supported. 686 </para> 687 <para> 688 This is equivalent to clicking on the 689 <guilabel>Open</guilabel> button in the message 690 popup. See the <link 691 linkend="message-actions">Message Actions</link> 692 section for more details. 693 </para> 694 </listitem> 695 </varlistentry> 696 <varlistentry> 697 <term><guilabel>Consider new mail as read</guilabel></term> 698 <listitem> 699 <para> 700 Hides the messages received so far. This action 701 has no permanent effects: your mailboxes will not 702 be modified, and the messages will no longer be 703 hidden the next time &app; is started. 704 </para> 705 </listitem> 706 </varlistentry> 707 <varlistentry> 708 <term><guilabel>Update the mail status</guilabel></term> 709 <listitem> 710 <para> 711 Checks for new mail in all mailboxes which do not 712 support <link 713 linkend="immediate-notification">immediate 714 notification</link>. 715 </para> 716 </listitem> 717 </varlistentry> 718 </variablelist> 719 </listitem> 720 </varlistentry> 721 </variablelist> 722 </sect2> 723 724 <sect2 id="properties-message-popups"> 725 <title>Message Popups</title> 726 <variablelist> 727 <varlistentry> 728 <term><guilabel>General</guilabel></term> 729 <listitem> 730 <variablelist> 731 <varlistentry id="enable-message-popups"> 732 <term><guilabel>Enable message popups</guilabel></term> 733 <listitem> 734 <para> 735 If this setting is enabled, an information window 736 will be popped up on your desktop whenever a new 737 message arrives. 738 </para> 739 </listitem> 740 </varlistentry> 741 </variablelist> 742 </listitem> 743 </varlistentry> 744 <varlistentry> 745 <term><guilabel>Position</guilabel></term> 746 <listitem> 747 <para> 748 The location of the message popups on the screen. 749 </para> 750 <variablelist> 751 <varlistentry> 752 <term><guilabel>Attached to the status icon</guilabel></term> 753 <listitem> 754 <para> 755 Message popups will be placed next to the status icon. 756 </para> 757 </listitem> 758 </varlistentry> 759 <varlistentry> 760 <term><guilabel>In the popup stack</guilabel></term> 761 <listitem> 762 <para> 763 Message popups will be stacked together in one 764 corner of your screen. 765 </para> 766 </listitem> 767 </varlistentry> 768 </variablelist> 769 </listitem> 770 </varlistentry> 771 <varlistentry> 772 <term><guilabel>Expiration</guilabel></term> 773 <listitem> 774 <para> 775 You can choose to have message popups stay on the screen 776 until you click on them, or have them disappear after a 777 delay has elapsed. 778 </para> 779 </listitem> 780 </varlistentry> 781 </variablelist> 782 </sect2> 783 </sect1> 784 785 <sect1 id="mailbox-properties"> 786 <title>Mailbox Properties</title> 787 <para> 788 The <guilabel>Mailbox Properties</guilabel> dialog is displayed 789 when you add a new mailbox or when you edit an existing one. It 790 may contain the following tabbed sections: 791 </para> 792 <itemizedlist> 793 <listitem> 794 <para><link linkend="mailbox-properties-general">General</link></para> 795 </listitem> 796 <listitem> 797 <para><link linkend="mailbox-properties-connection">Connection</link></para> 798 </listitem> 799 <listitem> 800 <para><link linkend="mailbox-properties-details">Details</link></para> 801 </listitem> 802 </itemizedlist> 803 804 <sect2 id="mailbox-properties-general"> 805 <title>General</title> 806 <variablelist> 807 <varlistentry> 808 <term><guilabel>General</guilabel></term> 809 <listitem> 810 <variablelist> 811 <varlistentry> 812 <term><guilabel>Mailbox type</guilabel></term> 813 <listitem> 814 <para> 815 This is the type of the mailbox. If you select 816 <guilabel>autodetect</guilabel>, the type will be 817 autodetected using the mailbox &uri; and/or 818 contents. 819 </para> 820 </listitem> 821 </varlistentry> 822 </variablelist> 823 </listitem> 824 </varlistentry> 825 826 <varlistentry> 827 <term> 828 <guilabel>Location</guilabel> 829 (<guilabel>Autodetect</guilabel> and <guilabel>System 830 mailbox</guilabel> only) 831 </term> 832 <listitem> 833 <para> 834 This is the &uri; of the mailbox. 835 </para> 836 <note> 837 <para> 838 &app; abstracts file operations by using &gnomevfs;. 839 All the schemes (http, ftp, sftp, …) supported by 840 &gnomevfs; are therefore supported by &app;. 841 </para> 842 </note> 843 </listitem> 844 </varlistentry> 845 846 <varlistentry> 847 <term> 848 <guilabel>Account</guilabel> (<guilabel>Gmail</guilabel>, 849 <guilabel>IMAP</guilabel>, <guilabel>POP3</guilabel>, 850 <guilabel>Windows Live Hotmail</guilabel> and 851 <guilabel>Yahoo! Mail</guilabel> only) 852 </term> 853 <listitem> 854 <variablelist> 855 <varlistentry> 856 <term> 857 <guilabel>Server</guilabel> 858 (<guilabel>IMAP</guilabel> and 859 <guilabel>POP3</guilabel> only) 860 </term> 861 <listitem> 862 <para> 863 This is the hostname or IP address of the &imap; or 864 &pop3; server. 865 </para> 866 <note> 867 <para> 868 Symbolic names as well as IPv4 and IPv6 869 addresses are supported. 870 </para> 871 </note> 872 </listitem> 873 </varlistentry> 874 <varlistentry> 875 <term><guilabel>Username</guilabel></term> 876 <listitem> 877 <para> 878 This is your username on the mail server. 879 </para> 880 </listitem> 881 </varlistentry> 882 <varlistentry> 883 <term><guilabel>Password</guilabel></term> 884 <listitem> 885 <para> 886 This is your password on the mail server. If the 887 password is filled in, it will be stored in your 888 default keyring. If it is left out, a password 889 prompt will appear when needed. 890 </para> 891 <warning> 892 <title>IMAP and POP3 Security</title> 893 <para> 894 To avoid sending your password over the network 895 in clear text, you must either use a SSL/TLS 896 connection or select a secure authentication 897 mechanism. See the <link 898 linkend="authentication-mechanism">Authentication 899 Mechanism</link> setting for more details. 900 </para> 901 <!-- simplified on purpose: actually, a weak SSL/TLS --> 902 <!-- algorithm could be used, but this is beyond the --> 903 <!-- scope of this document --> 904 </warning> 905 </listitem> 906 </varlistentry> 907 </variablelist> 908 </listitem> 909 </varlistentry> 910 911 <varlistentry> 912 <term> 913 <guilabel>IMAP Mailbox</guilabel> (<guilabel>IMAP</guilabel> only) 914 </term> 915 <listitem> 916 <para> 917 This is the &imap; mailbox to use. 918 </para> 919 </listitem> 920 </varlistentry> 921 922 <varlistentry> 923 <term> 924 <guilabel>Folder</guilabel> (<guilabel>Evolution</guilabel> only) 925 </term> 926 <listitem> 927 <para> 928 This is the Evolution folder to monitor for changes. 929 </para> 930 <note> 931 <para> 932 For the folder selector to be available and for 933 monitoring an Evolution mailbox, Evolution must be 934 running and the Evolution <guilabel>Jean-Yves Lefort's 935 Mail Notification</guilabel> plugin must be loaded. 936 </para> 937 </note> 938 </listitem> 939 </varlistentry> 940 </variablelist> 941 </sect2> 942 943 <sect2 id="mailbox-properties-connection"> 944 <title>Connection (<guilabel>IMAP</guilabel> and <guilabel>POP3</guilabel> only)</title> 945 <variablelist> 946 <varlistentry> 947 <term><guilabel>Connection type</guilabel></term> 948 <listitem> 949 <para> 950 This is the type of connection to use and the port 951 number to connect to. 952 </para> 953 <para> 954 <guilabel>In-band SSL/TLS</guilabel> refers to a 955 &ssl;/&tls; connection negotiated inside of the 956 protocol (using the <literal>STARTTLS</literal> &imap; 957 command or the <literal>STLS</literal> &pop3; 958 command). 959 </para> 960 <para> 961 <guilabel>SSL/TLS on separate port</guilabel> refers to 962 the most widespread method for establishing a 963 &ssl;/&tls; connection: using a separate port. 964 </para> 965 </listitem> 966 </varlistentry> 967 968 <varlistentry> 969 <term><guilabel>Authentication</guilabel></term> 970 <listitem> 971 <variablelist> 972 <varlistentry id="authentication-mechanism"> 973 <term><guilabel>Mechanism</guilabel></term> 974 <listitem> 975 <para> 976 This is the authentication mechanism to use. 977 If you select <guilabel>autodetect</guilabel>, 978 all the authentication mechanisms supported by the &imap; 979 or &pop3; server will be tried, in descending order of 980 security. Otherwise, the selected mechanism (and 981 <emphasis>only</emphasis> the selected mechanism) will 982 be used. 983 </para> 984 <warning> 985 <title>Security</title> 986 <para> 987 If <guilabel>autodetect</guilabel> is selected and 988 secure authentication fails, your credentials may 989 be sent over the network in clear text (unless you 990 use a &ssl;/&tls; connection). 991 </para> 992 <para> 993 If this is a concern, select the appropriate 994 secure authentication mechanism from the drop-down 995 list. 996 </para> 997 </warning> 998 </listitem> 999 </varlistentry> 1000 </variablelist> 1001 </listitem> 1002 </varlistentry> 1003 1004 <varlistentry> 1005 <term> 1006 <guilabel>Use the IDLE extension</guilabel> 1007 (<guilabel>IMAP</guilabel> only) 1008 </term> 1009 <listitem> 1010 <para> 1011 The IDLE extension (as defined by <ulink url="http://www.ietf.org/rfc/rfc2177.txt" type="http">RFC 2177</ulink>) 1012 allows &app; to stay connected to the server and provide 1013 <link linkend="immediate-notification">immediate notification</link> of changes. 1014 </para> 1015 <para> 1016 If <guilabel>never</guilabel> is selected, &app; 1017 will never use the IDLE extension, not even if the 1018 server supports it. Use this setting if it appears 1019 that &app; does not detect changes to an &imap; 1020 mailbox while the IDLE extension is in use. If using 1021 this setting fixes the issue, please also send the 1022 &imap; session transcript (obtained by running &app; 1023 using the --enable-info option) to Jean-Yves Lefort 1024 <email>jylefort@brutele.be</email>. 1025 </para> 1026 <para> 1027 If <guilabel>autodetect</guilabel> is selected, 1028 &app; will use the IDLE extension if the server 1029 supports it, unless the server software is known to 1030 have a broken IDLE implementation (currently, the 1031 only such software known to &app; is the University 1032 of Washington imapd). This is the recommended 1033 choice. 1034 </para> 1035 <para> 1036 If <guilabel>always</guilabel> is selected, &app; 1037 will use the IDLE extension if the server supports 1038 it, regardless of the server software. Use this 1039 setting if you want to force &app; to use the IDLE 1040 extension, even if it has detected a bogus 1041 implementation. 1042 </para> 1043 </listitem> 1044 </varlistentry> 1045 </variablelist> 1046 </sect2> 1047 1048 <sect2 id="mailbox-properties-details"> 1049 <title>Details</title> 1050 <variablelist> 1051 <varlistentry> 1052 <term><guilabel>Mailbox Name</guilabel></term> 1053 <listitem> 1054 <para> 1055 You can choose to assign a custom name to the 1056 mailbox. The mailbox name has informative purposes 1057 only, and is displayed in various parts of 1058 &app;. 1059 </para> 1060 </listitem> 1061 </varlistentry> 1062 1063 <varlistentry id="delay-between-mail-checks"> 1064 <term><guilabel>Delay Between Mail Checks</guilabel></term> 1065 <listitem> 1066 <para> 1067 This is the amount of time to wait between mail checks. 1068 </para> 1069 <note> 1070 <para> 1071 This delay is only used if the mailbox does 1072 not support <link 1073 linkend="immediate-notification">immediate 1074 notification</link> of changes. 1075 </para> 1076 </note> 1077 </listitem> 1078 </varlistentry> 1079 </variablelist> 1080 </sect2> 1081 </sect1> 1082 1083 <sect1 id="advanced-configuration"> 1084 <title>Advanced Configuration</title> 1085 1086 <sect2 id="message-actions"> 1087 <title>Message Actions</title> 1088 <para> 1089 Message popups support the following actions: 1090 </para> 1091 <itemizedlist> 1092 <listitem><para><guilabel>Open</guilabel></para></listitem> 1093 <listitem><para><guilabel>Mark as Read</guilabel></para></listitem> 1094 <listitem><para><guilabel>Mark as Spam</guilabel></para></listitem> 1095 <listitem><para><guilabel>Delete</guilabel></para></listitem> 1096 </itemizedlist> 1097 <para> 1098 Note that the <guilabel>Delete</guilabel> action is disabled 1099 by default. It can be enabled by modifying the <database 1100 class="field">/apps/mail-notification/popups/actions</database> 1101 <application>GConf</application> key. See the <link 1102 linkend="gconf-settings">GConf Settings</link> section 1103 for more details about the <application>GConf</application> 1104 database. 1105 </para> 1106 1107 <sect3 id="built-in-actions"> 1108 <title>Built-in Actions</title> 1109 <para> 1110 The following table summarizes the currently implemented 1111 built-in actions for each mailbox type. 1112 </para> 1113 <table> 1114 <title>Built-in Actions</title> 1115 <tgroup cols="4"> 1116 <thead> 1117 <row> 1118 <entry>Mailbox Type</entry> 1119 <entry><guilabel>Open</guilabel></entry> 1120 <entry><guilabel>Mark as Read</guilabel></entry> 1121 <entry><guilabel>Mark as Spam</guilabel></entry> 1122 <entry><guilabel>Delete</guilabel></entry> 1123 </row> 1124 </thead> 1125 <tbody> 1126 <row> 1127 <entry>Evolution</entry> 1128 <entry>yes</entry> 1129 <entry>yes</entry> 1130 <entry>yes</entry> 1131 <entry>yes</entry> 1132 </row> 1133 <row> 1134 <entry>Gmail</entry> 1135 <entry>yes</entry> 1136 <entry>no</entry> 1137 <entry>no</entry> 1138 <entry>no</entry> 1139 </row> 1140 <row> 1141 <entry>&imap;</entry> 1142 <entry>no</entry> 1143 <entry>no</entry> 1144 <entry>no</entry> 1145 <entry>no</entry> 1146 </row> 1147 <row> 1148 <entry>&maildir;</entry> 1149 <entry>yes</entry> 1150 <entry>yes</entry> 1151 <entry>no</entry> 1152 <entry>yes</entry> 1153 </row> 1154 <row> 1155 <entry>&mbox;</entry> 1156 <entry>no</entry> 1157 <entry>no</entry> 1158 <entry>no</entry> 1159 <entry>no</entry> 1160 </row> 1161 <row> 1162 <entry>&mh;</entry> 1163 <entry>yes</entry> 1164 <entry>no</entry> 1165 <entry>no</entry> 1166 <entry>no</entry> 1167 </row> 1168 <row> 1169 <entry>&mozilla;</entry> 1170 <entry>no</entry> 1171 <entry>no</entry> 1172 <entry>no</entry> 1173 <entry>no</entry> 1174 </row> 1175 <row> 1176 <entry>&sylpheed;</entry> 1177 <entry>yes</entry> 1178 <entry>yes</entry> 1179 <entry>no</entry> 1180 <entry>no</entry> 1181 </row> 1182 <row> 1183 <entry>&pop3;</entry> 1184 <entry>no</entry> 1185 <entry>no</entry> 1186 <entry>no</entry> 1187 <entry>no</entry> 1188 </row> 1189 <row> 1190 <entry>Windows Live Hotmail</entry> 1191 <entry>no</entry> 1192 <entry>no</entry> 1193 <entry>no</entry> 1194 <entry>no</entry> 1195 </row> 1196 <row> 1197 <entry>Yahoo! Mail</entry> 1198 <entry>no</entry> 1199 <entry>no</entry> 1200 <entry>no</entry> 1201 <entry>no</entry> 1202 </row> 1203 </tbody> 1204 </tgroup> 1205 </table> 1206 </sect3> 1207 1208 <sect3 id="custom-actions"> 1209 <title>Custom Actions</title> 1210 <para> 1211 To define a custom action for a particular mailbox, edit the 1212 <filename>~/.gnome2/mail-notification/mailboxes.xml</filename> 1213 file and specify a command to be executed when the action 1214 button is clicked. 1215 </para> 1216 <note> 1217 <para> 1218 If both a built-in action and a custom action exists, the 1219 custom action overrides the built-in action. 1220 </para> 1221 </note> 1222 <para> 1223 XML attributes should be added to the 1224 <sgmltag>mailbox</sgmltag> element of the mailbox you want the 1225 actions to be available for. The following table specifies 1226 which XML attribute should be used for a particular action. 1227 </para> 1228 <table> 1229 <title>Action Attributes</title> 1230 <tgroup cols="2"> 1231 <thead> 1232 <row> 1233 <entry>Action</entry> 1234 <entry>XML Attribute</entry> 1235 </row> 1236 </thead> 1237 <tbody> 1238 <row> 1239 <entry><guilabel>Open</guilabel></entry> 1240 <entry><parameter>open-command</parameter></entry> 1241 </row> 1242 <row> 1243 <entry><guilabel>Mark as Read</guilabel></entry> 1244 <entry><parameter>mark-as-read-command</parameter></entry> 1245 </row> 1246 <row> 1247 <entry><guilabel>Mark as Spam</guilabel></entry> 1248 <entry><parameter>mark-as-spam-command</parameter></entry> 1249 </row> 1250 <row> 1251 <entry><guilabel>Delete</guilabel></entry> 1252 <entry><parameter>delete-command</parameter></entry> 1253 </row> 1254 </tbody> 1255 </tgroup> 1256 </table> 1257 <para> 1258 Before executing a command, some strings will be 1259 substituted. The following table summarizes the available 1260 substitutions. 1261 </para> 1262 <table> 1263 <title>Command String Substitutions</title> 1264 <tgroup cols="2"> 1265 <thead> 1266 <row> 1267 <entry>String</entry> 1268 <entry>Substitution</entry> 1269 </row> 1270 </thead> 1271 <tbody> 1272 <row> 1273 <entry><literal>%%</literal></entry> 1274 <entry>a single percent character</entry> 1275 </row> 1276 <row> 1277 <entry><literal>%sent-time</literal></entry> 1278 <entry> 1279 the message timestamp expressed in seconds since the 1280 Epoch (00:00:00 UTC, January 1, 1970) 1281 </entry> 1282 </row> 1283 <row> 1284 <entry><literal>%id</literal></entry> 1285 <entry> 1286 the message unique identifier 1287 </entry> 1288 </row> 1289 <row> 1290 <entry><literal>%from</literal></entry> 1291 <entry> 1292 the message sender 1293 </entry> 1294 </row> 1295 <row> 1296 <entry><literal>%subject</literal></entry> 1297 <entry> 1298 the message subject, if any 1299 </entry> 1300 </row> 1301 <row> 1302 <entry><literal>%uri</literal></entry> 1303 <entry> 1304 the message &uri;, if any 1305 </entry> 1306 </row> 1307 <row> 1308 <entry><literal>%filename</literal></entry> 1309 <entry> 1310 if the message has an &uri; and that &uri; points to a 1311 local filename, that filename 1312 </entry> 1313 </row> 1314 <row> 1315 <entry><literal>%uid</literal></entry> 1316 <entry> 1317 the Evolution message UID, if any 1318 </entry> 1319 </row> 1320 </tbody> 1321 </tgroup> 1322 </table> 1323 <note> 1324 <itemizedlist> 1325 <listitem> 1326 <para> 1327 Substitutions will be shell-quoted as appropriate, you 1328 therefore must not quote the percent strings. 1329 </para> 1330 </listitem> 1331 <listitem> 1332 <para> 1333 Keywords can be enclosed in braces, as in 1334 <literal>%{from}</literal>. 1335 </para> 1336 </listitem> 1337 </itemizedlist> 1338 </note> 1339 <para> 1340 Example: 1341 </para> 1342 <programlisting> 1343 <?xml version="1.0"?> 1344 <mailboxes> 1345 <mailbox 1346 type="custom-vfs" 1347 uri="file:///home/jylefort/Mail/misc" 1348 open-command="my-open-script %filename" 1349 mark-as-spam-command="my-spam-script %filename"/> 1350 </mailboxes></programlisting> 1351 </sect3> 1352 </sect2> 1353 1354 <sect2 id="modifying-appearance"> 1355 <title>Modifying the Appearance of &app;</title> 1356 <para> 1357 &app; sets names for several widgets and icons, so that they 1358 can easily be matched in a GTK+ resource file. 1359 </para> 1360 <para> 1361 More information about GTK+ resource files, including a 1362 description of their format, can be found in the <ulink url="http://developer.gnome.org/doc/API/2.0/gtk/gtk-Resource-Files.html" type="http">Resource Files</ulink> 1363 section of the GTK+ Reference Manual. 1364 </para> 1365 1366 <table><title>Widget Names</title> 1367 <tgroup cols="2"> 1368 <thead> 1369 <row> 1370 <entry>Widget</entry> 1371 <entry>Name</entry> 1372 </row> 1373 </thead> 1374 <tbody> 1375 <row> 1376 <entry>mail icon and message count</entry> 1377 <entry>mn-mail-icon</entry> 1378 </row> 1379 <row> 1380 <entry>tooltip section title</entry> 1381 <entry>mn-tooltip-section-title</entry> 1382 </row> 1383 <row> 1384 <entry>tooltip section body (except mail summary)</entry> 1385 <entry>mn-tooltip-section-body</entry> 1386 </row> 1387 <row> 1388 <entry>tooltip mail summary</entry> 1389 <entry>mn-message-view</entry> 1390 </row> 1391 </tbody> 1392 </tgroup> 1393 </table> 1394 1395 <table><title>Icon Names</title> 1396 <tgroup cols="2"> 1397 <thead> 1398 <row> 1399 <entry>Icon</entry> 1400 <entry>Name</entry> 1401 </row> 1402 </thead> 1403 <tbody> 1404 <row> 1405 <entry>status icon when there is new mail</entry> 1406 <entry>mn-mail</entry> 1407 </row> 1408 <row> 1409 <entry>status icon when there is no new mail</entry> 1410 <entry>mn-no-mail</entry> 1411 </row> 1412 <row> 1413 <entry>local mailbox</entry> 1414 <entry>mn-local</entry> 1415 </row> 1416 <row> 1417 <entry>remote mailbox</entry> 1418 <entry>mn-remote</entry> 1419 </row> 1420 <row> 1421 <entry>autodetect (in the <guilabel>Mailbox type</guilabel> drop-down menu)</entry> 1422 <entry>mn-unknown</entry> 1423 </row> 1424 <row> 1425 <entry>mailbox error</entry> 1426 <entry>mn-error</entry> 1427 </row> 1428 <row> 1429 <entry>Gmail mailbox</entry> 1430 <entry>mn-gmail</entry> 1431 </row> 1432 <row> 1433 <entry>Yahoo! Mail mailbox</entry> 1434 <entry>mn-yahoo</entry> 1435 </row> 1436 <row> 1437 <entry>Windows Live Hotmail mailbox</entry> 1438 <entry>mn-hotmail</entry> 1439 </row> 1440 <row> 1441 <entry>system mailbox</entry> 1442 <entry>mn-system-mailbox</entry> 1443 </row> 1444 <row> 1445 <entry>Evolution mailbox</entry> 1446 <entry>mn-evolution-mailbox</entry> 1447 </row> 1448 <row> 1449 <entry>mail reader</entry> 1450 <entry>mn-mail-reader</entry> 1451 </row> 1452 <row> 1453 <entry>open message</entry> 1454 <entry>mn-open-message</entry> 1455 </row> 1456 <row> 1457 <entry>consider new mail as read</entry> 1458 <entry>mn-consider-new-mail-as-read</entry> 1459 </row> 1460 </tbody> 1461 </tgroup> 1462 </table> 1463 1464 <sect3> 1465 <title>Examples</title> 1466 <para> 1467 You can modify the appearance of &app; by editing the 1468 <filename>~/.gtkrc-2.0</filename> file. 1469 </para> 1470 <para> 1471 To use a larger font for the message count of the mail icon, 1472 and display it on a yellow background: 1473 </para> 1474 <programlisting>style "mn-mail-icon" 1475 { 1476 font_name = "Sans 12" 1477 bg[NORMAL] = "#FFFF00" 1478 } 1479 1480 widget "*.mn-mail-icon" style "mn-mail-icon"</programlisting> 1481 <para> 1482 To use a smaller font for the mail summary tooltip messages: 1483 </para> 1484 <programlisting>style "mn-mail-summary-tooltip-messages" 1485 { 1486 font_name = "Sans 8" 1487 } 1488 1489 widget "gtk-tooltips.*.mn-message-view" 1490 style "mn-mail-summary-tooltip-messages"</programlisting> 1491 <para> 1492 To use some custom icons: 1493 </para> 1494 <programlisting>pixmap_path "/home/myaccount/icons" 1495 1496 style "mn-icons" 1497 { 1498 stock["mn-mail"] = 1499 { 1500 { "my-mail-icon.png" } 1501 } 1502 stock["mn-no-mail"] = 1503 { 1504 { "my-no-mail-icon.png" } 1505 } 1506 } 1507 1508 widget "*" style "mn-icons"</programlisting> 1509 </sect3> 1510 </sect2> 1511 1512 <sect2 id="gconf-settings"> 1513 <title>GConf Settings</title> 1514 <para> 1515 A number of advanced settings are available in the 1516 <database>/apps/mail-notification</database> namespace of the 1517 <application>GConf</application> database. To modify these 1518 settings, type the following command in a terminal: 1519 </para> 1520 <para> 1521 <command>gconf-editor /apps/mail-notification</command> 1522 </para> 1523 </sect2> 1524 </sect1> 1525 1526 <sect1 id="troubleshooting"> 1527 <title>Troubleshooting</title> 1528 <para> 1529 If &app; does not work as expected, remember that you can obtain 1530 more details by leaving your mouse over its icon. 1531 </para> 1532 <para> 1533 Additionally, a very efficient way to identify and solve 1534 problems is to run &app; using the --enable-info option and 1535 examine the output. 1536 <warning> 1537 <title>Security</title> 1538 <para> 1539 The output of --enable-info may contain sensitive 1540 information such as passwords and session transcripts. 1541 </para> 1542 </warning> 1543 </para> 1544 </sect1> 1545 1546 <sect1 id="technical-information"> 1547 <title>Technical Information</title> 1548 1549 <sect2 id="immediate-notification"> 1550 <title>Immediate Notification</title> 1551 <para> 1552 Immediate notification is the ability to detect changes to a 1553 mailbox without needing to check it periodically. It allows 1554 the status icon to be updated immediately (or within seconds) 1555 after a mailbox changes. 1556 </para> 1557 <para> 1558 Requirements for immediate notification to be enabled: 1559 </para> 1560 <variablelist> 1561 <varlistentry> 1562 <term>&maildir;, &mbox;, &mh;, &mozilla; and &sylpheed; mailboxes:</term> 1563 <listitem> 1564 <para> 1565 &gnomevfs; must support monitoring (it usually does). 1566 </para> 1567 </listitem> 1568 </varlistentry> 1569 <varlistentry> 1570 <term>&imap; mailboxes:</term> 1571 <listitem> 1572 <para> 1573 The &imap; server must support the IDLE extension, as defined by 1574 <ulink url="http://www.ietf.org/rfc/rfc2177.txt" type="http">RFC 2177</ulink>. 1575 </para> 1576 </listitem> 1577 </varlistentry> 1578 <varlistentry> 1579 <term>Evolution mailboxes:</term> 1580 <listitem> 1581 <para> 1582 There is no requirement. Immediate notification is 1583 always enabled. 1584 </para> 1585 </listitem> 1586 </varlistentry> 1587 <varlistentry> 1588 <term>Gmail, &pop3;, Windows Live Hotmail and Yahoo! Mail mailboxes:</term> 1589 <listitem> 1590 <para> 1591 Immediate notification is not supported by these mailbox types. 1592 </para> 1593 </listitem> 1594 </varlistentry> 1595 </variablelist> 1596 <note> 1597 <para> 1598 If immediate notification cannot be enabled for a mailbox 1599 (either because that type of mailbox does not support it or 1600 because the requirements are not met), the mailbox will be 1601 checked periodically according to its <link 1602 linkend="delay-between-mail-checks">Delay Between Mail 1603 Checks</link> setting. 1604 </para> 1605 </note> 1606 </sect2> 1607 1608 <sect2> 1609 <title>POP3 Implementation</title> 1610 <para> 1611 The &app; &pop3; implementation strictly conforms to 1612 <ulink url="http://www.ietf.org/rfc/rfc1939.txt" type="http">RFC 1939</ulink>, 1613 <ulink url="http://www.ietf.org/rfc/rfc2449.txt" type="http">RFC 2449</ulink>, 1614 <ulink url="http://www.ietf.org/rfc/rfc1734.txt" type="http">RFC 1734</ulink>, 1615 <ulink url="http://www.ietf.org/rfc/rfc2595.txt" type="http">RFC 2595</ulink> and 1616 <ulink url="http://www.ietf.org/rfc/rfc2384.txt" type="http">RFC 2384</ulink>. 1617 </para> 1618 <para> 1619 The AUTH, APOP and USER/PASS authentication mechanisms are 1620 supported, and the LOGIN-DELAY capability is honoured. The TOP 1621 optional command is supported. 1622 </para> 1623 <para> 1624 The authentication logic can be represented with the following 1625 pseudo-code: 1626 </para> 1627 <programlisting>success = false; 1628 1629 if (mailbox.config.authmech != autodetect) { 1630 if (mailbox.config.authmech in server.supported_authmechs) { 1631 success = server.authenticate(mailbox.config.authmech); 1632 } 1633 } else { 1634 if (has_sasl_support && server.supports_sasl) { 1635 foreach authmech in server.supported_authmechs { 1636 if (server.ssl_connection || ! authmech.plaintext) { 1637 success = server.authenticate(authmech); 1638 if (success) 1639 break; 1640 } 1641 } 1642 if (! success && server.supports_apop) { 1643 success = server.authenticate(apop); 1644 } 1645 if (! success) { 1646 success = server.authenticate(userpass); 1647 } 1648 } 1649 } 1650 1651 if (! success) { 1652 mailbox.error = "authentication failed"; 1653 }</programlisting> 1654 </sect2> 1655 1656 <sect2> 1657 <title>IMAP Implementation</title> 1658 <para> 1659 The &app; &imap; implementation strictly conforms to 1660 <ulink url="http://www.ietf.org/rfc/rfc3501.txt" type="http">RFC 3501</ulink>, 1661 <ulink url="http://www.ietf.org/rfc/rfc2177.txt" type="http">RFC 2177</ulink> and 1662 <ulink url="http://www.ietf.org/rfc/rfc2192.txt" type="http">RFC 2192</ulink>. 1663 </para> 1664 <para> 1665 The AUTHENTICATE and LOGIN authentication mechanisms are 1666 supported, and the IDLE extension is implemented. 1667 </para> 1668 <para> 1669 The authentication logic can be represented with the following 1670 pseudo-code: 1671 </para> 1672 <programlisting>success = false; 1673 1674 if (mailbox.config.authmech != autodetect) { 1675 if (mailbox.config.authmech in server.supported_authmechs) { 1676 success = server.authenticate(mailbox.config.authmech); 1677 } 1678 } else { 1679 if (has_sasl_support && server.supports_sasl) { 1680 foreach authmech in server.supported_authmechs { 1681 if (server.ssl_connection || ! authmech.plaintext) { 1682 success = server.authenticate(authmech); 1683 if (success) 1684 break; 1685 } 1686 } 1687 if (! success && server.supports_login) { 1688 server.authenticate(login); 1689 } 1690 } 1691 } 1692 1693 if (! success) { 1694 mailbox.error = "authentication failed"; 1695 }</programlisting> 1696 </sect2> 1697 </sect1> 1698 1699 <sect1 id="faq"> 1700 <title>Frequently Asked Questions</title> 1701 <qandaset defaultlabel="number"> 1702 <qandaentry> 1703 <question> 1704 <para> 1705 How can I access the <link 1706 linkend="properties">Properties</link> dialog? 1707 </para> 1708 </question> 1709 <answer> 1710 <para> 1711 Choose 1712 <menuchoice> 1713 <guimenu>System</guimenu> 1714 <guisubmenu>Preferences</guisubmenu> 1715 <guimenuitem>Mail Notification</guimenuitem> 1716 </menuchoice> (this location may vary across systems) or type 1717 <command>mail-notification -p</command> in a terminal. 1718 </para> 1719 </answer> 1720 </qandaentry> 1721 <qandaentry> 1722 <question> 1723 <para> 1724 You say that &app; supports <mailbox type>, but 1725 there is no such entry in the <link 1726 linkend="mailbox-properties">Mailbox Properties</link> 1727 dialog. 1728 </para> 1729 </question> 1730 <answer> 1731 <para> 1732 &app; was built without support for <mailbox type>. 1733 </para> 1734 <para> 1735 If you have installed &app; from a package, contact the 1736 package maintainer and ask him to enable <mailbox 1737 type> support. 1738 </para> 1739 <para> 1740 If you have built &app; yourself, install the <mailbox 1741 type> prerequisites (they are listed in the 1742 <filename>INSTALL</filename> file), then rebuild &app;. 1743 </para> 1744 </answer> 1745 </qandaentry> 1746 <qandaentry> 1747 <question> 1748 <para> 1749 I need &ssl;/&tls; for connecting to my &pop3; or &imap; 1750 server, but the &ssl;/&tls; settings are greyed out. 1751 </para> 1752 </question> 1753 <answer> 1754 <para> 1755 &app; was built without &ssl;/&tls; support. 1756 </para> 1757 <para> 1758 If you have installed &app; from a package, contact the 1759 package maintainer and ask him to enable &ssl;/&tls; 1760 support. 1761 </para> 1762 <para> 1763 If you have built &app; yourself, install the &ssl;/&tls; 1764 prerequisites (they are listed in the 1765 <filename>INSTALL</filename> file), then rebuild &app;. 1766 </para> 1767 </answer> 1768 </qandaentry> 1769 <qandaentry> 1770 <question> 1771 <para> 1772 When monitoring a &pop3; mailbox, &app; reports all 1773 messages as new. 1774 </para> 1775 </question> 1776 <answer> 1777 <para> 1778 This is caused by limitations in the &pop3; protocol. You 1779 should configure your mail reader so that it deletes mail 1780 from the server after downloading it. 1781 </para> 1782 </answer> 1783 </qandaentry> 1784 <qandaentry> 1785 <question> 1786 <para> 1787 How can I monitor multiple &imap; folders? 1788 </para> 1789 </question> 1790 <answer> 1791 <para> 1792 Add each folder as a separate &app; mailbox. 1793 </para> 1794 </answer> 1795 </qandaentry> 1796 <qandaentry> 1797 <question> 1798 <para> 1799 Can I monitor a <webmail provider> account? 1800 </para> 1801 </question> 1802 <answer> 1803 <para> 1804 &app; has no native support for <webmail provider> 1805 mailboxes. However, &app; supports the &pop3; and &imap; 1806 protocols; you can therefore use a separate application 1807 for providing &pop3; or &imap; access to the <webmail 1808 provider> account. 1809 </para> 1810 </answer> 1811 </qandaentry> 1812 <qandaentry> 1813 <question> 1814 <para> 1815 How can I access message data from the new mail command? 1816 </para> 1817 </question> 1818 <answer> 1819 <para> 1820 Parse the output of <command>mail-notification --print-summary</command>. 1821 </para> 1822 </answer> 1823 </qandaentry> 1824 <qandaentry> 1825 <question> 1826 <para> 1827 I do not use &app; but I am presented with the properties 1828 dialog each time I log in. How can I disable it? 1829 </para> 1830 </question> 1831 <answer> 1832 <orderedlist> 1833 <listitem> 1834 <para> 1835 Choose 1836 <menuchoice> 1837 <guimenu>System</guimenu> 1838 <guisubmenu>Preferences</guisubmenu> 1839 <guimenuitem>Sessions</guimenuitem> 1840 </menuchoice> (this location may vary across systems). 1841 </para> 1842 </listitem> 1843 <listitem> 1844 <para> 1845 Select the <guilabel>Startup Programs</guilabel> tab. 1846 </para> 1847 </listitem> 1848 <listitem> 1849 <para> 1850 Uncheck the <guilabel>Mail Notification</guilabel> entry. 1851 </para> 1852 </listitem> 1853 </orderedlist> 1854 </answer> 1855 </qandaentry> 1856 </qandaset> 1857 </sect1> 1858 1859 <sect1 id="about"> 1860 <title>About &app;</title> 1861 <para> 1862 &app; was written by Jean-Yves Lefort 1863 <email>jylefort@brutele.be</email>. To find more information 1864 about &app;, visit the 1865 <ulink url="http://www.nongnu.org/mailnotify" type="http">Mail Notification web site</ulink>. 1866 </para> 1867 1868 <sect2 id="problem-reports"> 1869 <title>Reporting Bugs and Other Feedback</title> 1870 <para> 1871 Bug reports and feature requests should be filed in the 1872 <ulink url="https://bugs.launchpad.net/mail-notification/" type="http">Mail Notification bug tracker</ulink>. 1873 Other feedback can be sent to Jean-Yves Lefort <email>jylefort@brutele.be</email>. 1874 </para> 1875 </sect2> 1876 1877 <sect2 id="acknowledgements"> 1878 <title>Acknowledgements</title> 1879 <itemizedlist> 1880 <!-- We don't use <firstname> and <surname> because we can't --> 1881 <!-- unambiguously split some names. --> 1882 <listitem><para>Claudio André</para></listitem> 1883 <listitem><para>Hendrik Brandt</para></listitem> 1884 <listitem><para>Kim Briggs</para></listitem> 1885 <listitem><para>Hiroshi Hasebe</para></listitem> 1886 <listitem><para>Duarte Henriques</para></listitem> 1887 <listitem><para>Nacho Hermoso de Mendoza</para></listitem> 1888 <listitem><para>Dan Korostelev</para></listitem> 1889 <listitem><para>Pav Lucistnik</para></listitem> 1890 <listitem><para>Filip Miletic</para></listitem> 1891 <listitem><para>Phil Nelson</para></listitem> 1892 <listitem><para>Daniel Nylander</para></listitem> 1893 <listitem><para>Lorenzo Orlandini</para></listitem> 1894 <listitem><para>Maurycy Pawłowski-Wieroński</para></listitem> 1895 <listitem><para>Vladimir Petkov</para></listitem> 1896 <listitem><para>Benoît Rouits</para></listitem> 1897 <listitem><para>Tomasz Sarota-Raczek</para></listitem> 1898 <listitem><para>Tomasz Sałaciński</para></listitem> 1899 <listitem><para>Edwin Shin</para></listitem> 1900 <listitem><para>Topi</para></listitem> 1901 <listitem><para>Marcel J. Zwiebel</para></listitem> 1902 </itemizedlist> 1903 </sect2> 1904 1905 <sect2 id="licensing-terms"> 1906 <title>Licensing Terms</title> 1907 &software-license; 1908 </sect2> 1909 </sect1> 1910 1911 <glossary id="glossary"> 1912 <title>Glossary</title> 1913 1914 <glossdiv><title>G</title> 1915 <glossentry id="gnomevfs"> 1916 <glossterm>GnomeVFS</glossterm> 1917 <glossdef> 1918 <para> 1919 A filesystem abstraction library allowing applications to access 1920 local, remote and virtual resources in a transparent fashion. 1921 <ulink url="http://developer.gnome.org/doc/API/2.0/gnome-vfs-2.0" type="http">GnomeVFS</ulink> 1922 is part of the <ulink url="http://www.gnome.org" type="http">GNOME Desktop Environment</ulink>. 1923 </para> 1924 </glossdef> 1925 </glossentry> 1926 </glossdiv> 1927 1928 <glossdiv><title>I</title> 1929 <glossentry> 1930 <glossterm>IMAP</glossterm> 1931 <glosssee otherterm="imap"/> 1932 </glossentry> 1933 1934 <glossentry id="imap"> 1935 <glossterm>Internet Message Access Protocol</glossterm> 1936 <acronym>IMAP</acronym> 1937 <glossdef> 1938 <para> 1939 A protocol allowing a client to access and manipulate 1940 electronic mail messages on a server. &app; implements 1941 version 4rev1 of the protocol, as defined by 1942 <ulink url="http://www.ietf.org/rfc/rfc3501.txt" type="http">RFC 3501</ulink>. 1943 </para> 1944 </glossdef> 1945 </glossentry> 1946 </glossdiv> 1947 1948 <glossdiv><title>M</title> 1949 <glossentry id="maildir"> 1950 <glossterm>Maildir</glossterm> 1951 <glossdef> 1952 <para> 1953 A mailbox format popularised by the <ulink url="http://www.qmail.org" type="http">qmail</ulink> mail transfer agent. 1954 Messages are stored in a structure of directories for reliability. 1955 </para> 1956 </glossdef> 1957 </glossentry> 1958 1959 <glossentry id="mbox"> 1960 <glossterm>mbox</glossterm> 1961 <glossdef> 1962 <para> 1963 The traditional UNIX mailbox format. Messages are 1964 stored in a single file. 1965 </para> 1966 </glossdef> 1967 </glossentry> 1968 1969 <glossentry id="mh"> 1970 <glossterm>MH</glossterm> 1971 <glossdef> 1972 <para> 1973 A mailbox format popularised by the 1974 <ulink url="http://www.ics.uci.edu/~mh" type="http">MH</ulink> mail user agent. 1975 Messages are stored as separate files for flexibility and performance. 1976 </para> 1977 </glossdef> 1978 </glossentry> 1979 1980 <glossentry id="mozilla"> 1981 <glossterm>Mozilla</glossterm> 1982 <glossdef> 1983 <para> 1984 In this manual, a Mozilla mailbox refers to a mailbox 1985 produced by a Mozilla-based mail reader (Mozilla, 1986 SeaMonkey, Thunderbird, …). This mailbox format only 1987 differs from the &mbox; format by the fact that message 1988 status information is stored in the 1989 <literal>X-Mozilla-Status</literal> header instead of the 1990 <literal>Status</literal> header. 1991 </para> 1992 </glossdef> 1993 </glossentry> 1994 </glossdiv> 1995 1996 <glossdiv><title>P</title> 1997 <glossentry> 1998 <glossterm>POP3</glossterm> 1999 <glosssee otherterm="pop3"/> 2000 </glossentry> 2001 2002 <glossentry id="pop3"> 2003 <glossterm>Post Office Protocol Version 3</glossterm> 2004 <acronym>POP3</acronym> 2005 <glossdef> 2006 <para> 2007 A protocol allowing a workstation to dynamically access 2008 a maildrop on a server host, as defined by 2009 <ulink url="http://www.ietf.org/rfc/rfc1939.txt" type="http">RFC 1939</ulink>. 2010 </para> 2011 </glossdef> 2012 </glossentry> 2013 </glossdiv> 2014 2015 <glossdiv><title>S</title> 2016 <glossentry> 2017 <glossterm>SASL</glossterm> 2018 <glosssee otherterm="sasl"/> 2019 </glossentry> 2020 2021 <glossentry id="ssl"> 2022 <glossterm>Secure Sockets Layer</glossterm> 2023 <acronym>SSL</acronym> 2024 <glossdef> 2025 <para> 2026 A protocol securing a connection through the use of 2027 cryptographic techniques. 2028 </para> 2029 </glossdef> 2030 </glossentry> 2031 2032 <glossentry id="sasl"> 2033 <glossterm>Simple Authentication and Security Layer</glossterm> 2034 <acronym>SASL</acronym> 2035 <glossdef> 2036 <para> 2037 A method for adding authentication support to 2038 connection-based protocols, as defined by 2039 <ulink url="http://www.ietf.org/rfc/rfc2222.txt" type="http">RFC 2222</ulink>. 2040 </para> 2041 </glossdef> 2042 </glossentry> 2043 2044 <glossentry> 2045 <glossterm>SSL</glossterm> 2046 <glosssee otherterm="ssl"/> 2047 </glossentry> 2048 2049 <glossentry id="sylpheed"> 2050 <glossterm>Sylpheed</glossterm> 2051 <glossdef> 2052 <para> 2053 The mailbox format used by the <ulink url="http://sylpheed.good-day.net" type="http">Sylpheed</ulink> 2054 mail user agent. The Sylpheed format adds a binary cache to MH folders 2055 for faster indexing. 2056 </para> 2057 </glossdef> 2058 </glossentry> 2059 </glossdiv> 2060 2061 <glossdiv><title>T</title> 2062 <glossentry> 2063 <glossterm>TLS</glossterm> 2064 <glosssee otherterm="tls"/> 2065 </glossentry> 2066 2067 <glossentry id="tls"> 2068 <glossterm>Transport Layer Security</glossterm> 2069 <acronym>TLS</acronym> 2070 <glossdef> 2071 <para> 2072 A protocol securing a connection through the use of 2073 cryptographic techniques, as defined by 2074 <ulink url="http://www.ietf.org/rfc/rfc2246.txt" type="http">RFC 2246</ulink>. 2075 TLS is the successor of &ssl;. 2076 </para> 2077 </glossdef> 2078 </glossentry> 2079 </glossdiv> 2080 2081 <glossdiv><title>U</title> 2082 <glossentry id="uri"> 2083 <glossterm>Uniform Resource Identifier</glossterm> 2084 <acronym>URI</acronym> 2085 <glossdef> 2086 <para> 2087 A <quote>compact string of characters for identifying an 2088 abstract or physical resource</quote>, as defined 2089 by <ulink url="http://www.ietf.org/rfc/rfc2396.txt" type="http">RFC 2396</ulink>. 2090 </para> 2091 </glossdef> 2092 </glossentry> 2093 2094 <glossentry> 2095 <glossterm>URI</glossterm> 2096 <glosssee otherterm="uri"/> 2097 </glossentry> 2098 </glossdiv> 2099 </glossary> 2100 </article>