! Please note that this is a snapshot of our old Bugzilla server, which is read only since May 29, 2020. Please go to gitlab.xfce.org for our new server !
the documentation is not valid
Status:
RESOLVED: INVALID
Priority:
Very Low
Severity:
trivial
Product:
Xfce4-mailwatch-plugin
Component:
General

Comments

Description Matthias Krüger 2008-07-09 08:32:13 CEST
User-Agent:       Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.8.1.14) Gecko/20080404 Iceweasel/2.0.0.14 (Debian-2.0.0.14-2)
Build Identifier: 

The documentation of the xfce4-mailwatch-plugin (/usr/share/xfce4/doc/C/xfce4-mailwatch-plugin.html) is not valid. Even a doctype was missing.

Reproducible: Always

Steps to Reproduce:
Steps to Reproduce:
1. go to http://validator.w3.org/#validate_by_input
2. copy the content of the file /usr/share/xfce4/doc/C/xfce4-mailwatch-plugin.html into the
white field
3. press "check
Actual Results:  
The validator sais:
This page is not Valid (no Doctype found)!
Result: 	Failed validation, 3 Errors

Expected Results:  
The validator should say:
This Page Is Valid XHTML 1.0 Strict!
Result: 	Passed validation

I fixed the errors:
xfce4-mailwatch-plugin.html:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
  <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
  <title>Xfce 4 Mailwatch Plugin</title>
  <link rel="stylesheet" href="../xfce.css" type="text/css"/>
  <meta name="generator" content="Bluefish 1.0.7"/>
  <link rel="start" href="#xfce4-mailwatch-plugin" title="Xfce 4 Mailwatch Plugin"/>
  <link rel="next" href="#mailwatch-introduction" title="Introduction"/>
 </head>
 <body>
  <div class="article" lang="en">
   <div class="titlepage">
    <div>
     <div>
      <h1 class="title">
       <a name="xfce4-mailwatch-plugin"></a>Xfce 4 Mailwatch Plugin
      </h1>
     </div>
     <div>
      <div class="authorgroup">
       <div class="author">
        <h3 class="author">
         <span class="firstname">Pasi</span>
         <span class="surname"> Orovuo</span>
        </h3>
        <div class="affiliation">
         <div class="address">
          <p><code class="email">&lt;<a href="mailto:pasi.ov@gmail.com">pasi.ov@gmail.com</a>&gt;</code></p>
         </div>
        </div>
       </div>
       <div class="author">
        <h3 class="author">
        <span class="firstname">Brian</span> <span class="surname">Tarricone</span>
        </h3><div class="affiliation">
         <div class="address">
          <p><code class="email">&lt;<a href="mailto:bjt23@cornell.edu">bjt23@cornell.edu</a>&gt;</code></p>
         </div>
        </div>
       </div>
      </div>
     </div>
     <div>
      <span class="releaseinfo">This manual describes <span class="emphasis"><em><strong class="application"><code>Xfce4 Mailwatch Plugin</code></strong></em></span>
    version 0.1.0svn.
       <br></br>
      </span>
     </div>
     <div>
      <p class="copyright">Copyright © 2005-2006 Pasi Orovuo</p>
     </div>
     <div>
      <p class="copyright">Copyright © 2005-2006 Brian Tarricone</p>
     </div>
    </div>
    <hr />
   </div>
   <div class="toc">
    <p>
    <b>Table of Contents</b>
    </p>
    <dl>
     <dt>
      <span class="sect1">
       <a href="#mailwatch-introduction">Introduction</a>
      </span>
     </dt>
     <dt>
      <span class="sect1">
       <a href="#mailwatch-properties">Properties</a>
      </span>
     </dt>
     <dt>
      <span class="sect1">
       <a href="#mailwatch-mailboxes">Mailbox configuration</a>
      </span>
     </dt>
     <dd>
      <dl>
       <dt>
        <span class="sect2">
         <a href="#mailwatch-mailbox-imap">IMAP</a>
        </span>
       </dt>
       <dt>
        <span class="sect2">
         <a href="#mailwatch-mailbox-pop3">POP3</a>
        </span>
       </dt>
       <dt>
        <span class="sect2">
         <a href="#mailwatch-mailbox-gmail">GMail</a>
        </span>
       </dt>
       <dt>
        <span class="sect2">
         <a href="#mailwatch-mailbox-maildir">Maildir</a>
        </span>
       </dt>
       <dt>
        <span class="sect2">
         <a href="#mailwatch-mailbox-mbox">Mbox</a>
        </span>
       </dt>
       <dt>
        <span class="sect2">
         <a href="#mailwatch-mailbox-mh">MH Maildir</a>
        </span>
       </dt>
      </dl>
     </dd>
     <dt>
      <span class="sect1">
       <a href="#mailwatch-about">About <strong class="application"><code>Mailwatch</code></strong></a>
      </span>
     </dt>
    </dl>
   </div>
   <div class="sect1" lang="en">
    <div class="titlepage">
     <div>
      <div>
       <h2 class="title" style="clear: both"><a name="mailwatch-introduction"></a>Introduction</h2>
      </div>
     </div>
    </div>
    <p><strong class="application"><code>Xfce4 Mailwatch Plugin</code></strong> is a multi-protocol, multi-mailbox mail watcher for the
    <a href="xfce4-panel.html">Xfce4 panel</a>.
    Currently, the protocols supported are:
    
    </p>
    <div class="itemizedlist">
     <ul class="disc">
      <li>
       <p>IMAP (SSL/TLS and cleartext)</p>
     </li>
     <li>
      <p>POP3 (SSL/TLS and cleartext)</p>
     </li>
     <li>
      <p>GMail mailbox (HTTPS)</p>
     </li>
     <li>
      <p>Mbox mail spool (local)</p>
     </li>
     <li>
      <p>Maildir mail spool (local)</p>
     </li>
     <li>
      <p>MH-Maildir mail spool (local)</p>
     </li>
    </ul>
   </div>
   <p>
    
   </p>
  </div>
  <div class="sect1" lang="en">
   <div class="titlepage">
    <div>
     <div>
      <h2 class="title" style="clear: both"><a name="mailwatch-properties"></a>Properties</h2>
     </div>
    </div>
   </div>
   <p><strong class="application"><code>Xfce4 Mailwatch Plugin</code></strong> has a variety of configuration options. Access to the
    configuration is gained by right-clicking the panel icon, and by
    choosing <span><strong class="guimenuitem">Properties</strong></span>.
  </p>
   <div class="figure">
    <a name="mailwatch-properties-fig"></a>
    <p class="title"><b>Figure 1. <code class="application">Mailwatch</code> main settings</b></p>
    <div class="screenshot">
     <div class="mediaobject">
      <img src="images/mailwatch-properties.png" alt="Mailwatch properties dialog"/>
     </div>
    </div>
   </div>
   <div class="variablelist">
    <dl>
     <dt>
      <span class="term">Mailboxes</span>
     </dt>
     <dd>
      <p>The main controls for managing mailboxes are
          <span><strong class="guibutton">Add</strong></span>, <span><strong class="guibutton">Edit</strong></span>,
          and <span><strong class="guibutton">Remove</strong></span>. At later stage, we'll walk
          through adding and configuring each mailbox type.
        </p>
     </dd>
     <dt>
      <span class="term">External Programs</span>
     </dt>
     <dd>
      <p><strong class="application"><code>Mailwatch</code></strong> can launch your mail user agent (or any other
          program) when the panel icon is clicked. The name of the
          executable together with possible startup parameters goes
          in the <span><strong class="guilabel">Run on click</strong></span> entry field. You can
          also define the command to be executed when <strong class="application"><code>Mailwatch</code></strong> detects
          new mail by typing the desired command in the <span><strong class="guilabel">Run on
          new messages</strong></span> entry field. Note that the command
          is executed once for each time <strong class="application"><code>Mailwatch</code></strong> detects new mail,
          regardless of the number of new messages received.
        </p>
     </dd>
     <dt>
      <span class="term">Icons</span>
     </dt>
     <dd>
      <p>The icons that <strong class="application"><code>Mailwatch</code></strong> displays in the panel are configurable.
          Both the <span><strong class="guiicon">Normal</strong></span> and <span><strong class="guiicon">New Mail</strong></span>
          buttons present a file chooser dialog, which you can use to select
          your preferred icons.
        </p>
     </dd>
     <dt>
      <span class="term">Logging</span>
     </dt>
     <dd>
      <p><strong class="application"><code>Mailwatch</code></strong> includes a logging mechanism as well. It provides
          information about errors and other noteworthy events that take
          place. The log is accessible via the <span><strong class="guibutton">View Log</strong></span>
          button. There's also a setting to <span><strong class="guilabel">Show log status
          in icon</strong></span> in the log dialog which, if enabled, provides
          a visual indication of new log events in the panel.
        </p>
      <div class="figure">
       <a name="mailwatch-log-window-fig"></a>
        <p class="title"><b>Figure 2. Log Window</b></p>
        <div class="screenshot">
         <div class="mediaobject">
          <img src="images/mailwatch-log-window.png" alt="Mailwatch log window"/>
         </div>
        </div>
       </div>
       <div class="figure">
        <a name="mailwatch-panel-indicator-fig"></a>
        <p class="title"><b>Figure 3. Panel Indicator</b></p>
        <div class="screenshot">
         <div class="mediaobject">
          <img src="images/mailwatch-panel-indicator.png" alt="Panel indicator"/>
         </div>
        </div>
       </div>
      </dd>
     </dl>
    </div>
   </div>
   <div class="sect1" lang="en">
    <div class="titlepage">
     <div>
      <div>
       <h2 class="title" style="clear: both"><a name="mailwatch-mailboxes"></a>Mailbox configuration</h2>
      </div>
     </div>
    </div>
    <p>In this section we walk through adding and configuring each
    type of mailbox.
  </p>
    <p>To add a new mailbox, click <span><strong class="guibutton">Add</strong></span> in the
    main configuration dialog and a mailbox type selection dialog will
    appear. The dialog presents each supported mailbox type in the
    dropdown list, as well as an informative description of the mailbox
    in the label below.
  </p>
    <div class="figure">
     <a name="mailwatch-mailbox-type-fig"></a>
     <p class="title"><b>Figure 4. Mailbox type selection</b></p>
      <div class="screenshot">
       <div class="mediaobject">
        <img src="images/mailwatch-mailbox-type.png" alt="Mailbox type selection dialog"/>
       </div>
      </div>
     </div>
     <div class="sect2" lang="en">
      <div class="titlepage">
       <div>
        <div>
         <h3 class="title"><a name="mailwatch-mailbox-imap"></a>IMAP</h3>
        </div>
       </div>
      </div>
      <p><span class="acronym">IMAP</span>, acronym for <span class="emphasis"><em>Internet Message Access
      Protocol</em></span>, is a quite common mailbox format. An <span class="acronym">IMAP</span>
      mailbox is a remote mailbox, so it requires various configuration
      options to be able to contact the remote <span class="acronym">IMAP</span> server and get
      information on the mailbox.      
    </p>
      <p>To create an <span class="acronym">IMAP</span> account in <strong class="application"><code>Mailwatch</code></strong>, choose <span class="emphasis"><em>
      Remote IMAP Mailbox</em></span> in the mailbox type chooser dialog,
      and you will be presented with the <span class="acronym">IMAP</span> settings dialog.
    </p>
    <div class="figure">
     <a name="mailwatch-imap-settings-fig"></a>
     <p class="title"><b>Figure 5. IMAP Settings Dialog</b></p>
     <div class="screenshot">
      <div class="mediaobject">
       <img src="images/mailwatch-imap-settings.png" alt="Mailwatch IMAP Settings"/>
      </div>
     </div>
    </div>
    <div class="variablelist">
     <dl>
      <dt>
       <span class="term">Mailbox Name</span>
      </dt>
      <dd>
       <p>A descriptive name for the mailbox.
             The name entered here will appear on the <strong class="application"><code>Mailwatch</code></strong> icon
             tooltip, which indicates mailboxes that have new mail.
             This setting is required, regardless of the mailbox type.</p>
      </dd>
      <dt>
       <span class="term"><span class="acronym">IMAP</span> Server</span>
      </dt>
       <dd>
        <div class="itemizedlist">
         <ul class="disc">
          <li>
           <p>Mail server - The hostname of the remote mail server.</p>
          </li>
          <li>
           <p>Username - The username to use while accessing the mailbox.</p>
          </li>
          <li>
           <p>Password - The password to use.</p>
          </li>
         </ul>
        </div>
       </dd>
       <dt>
        <span class="term">Interval</span>
       </dt>
       <dd>
        <p>Defines how often <strong class="application"><code>Mailwatch</code></strong> accesses
             the mailbox to see if there's new mail. You shouldn't set
             this too low, as it will create unnecessary network traffic.
             It's not recommended to set this lower than 5 minutes,
             unless you're really sure your service provider
             is okay with that.</p>
       </dd>
      </dl>
     </div>
      <p>The default setup uses unencrypted connections and the
      default <span class="acronym">IMAP</span> folder. For most users this is enough, and everything
      should work now. Mail server implementations differ, and this
      setup might not work for you. For example, you service provider
      might require encrypted connections (which you should use wherever
      possible). For that there's the advanced settings dialog.
    </p>
      <div class="sect3" lang="en">
       <div class="titlepage">
        <div>
         <div>
          <h4 class="title"><a name="mailwatch-mailbox-imap-advanced"></a>Advanced Settings</h4>
         </div>
        </div>
       </div>
       <div class="figure">
        <a name="mailwatch-mailbox-imap-advanced-fig"></a>
        <p class="title"><b>Figure 6. Advanced <span class="acronym">IMAP</span> settings</b></p>
        <div class="screenshot">
         <div class="mediaobject">
          <img src="images/mailwatch-imap-advanced.png" alt="Advanced IMAP settings"/>
         </div>
        </div>
       </div>
       <div class="variablelist">
        <dl>
         <dt>
          <span class="term">Connection</span>
         </dt>
         <dd>
          <p>If your <span class="acronym">IMAP</span> service provider supports encryption
              for client connections, you should take advantage of that.
              There are generally two implementations of encrypted
              connections. The most common one, even though it's against
              the <span class="acronym">IMAP</span> RFC uses the port 993 for client connections.
              In this scheme, the connection is encrypted from the
              beginning, as the encryption is initialized before the
              actual <span class="acronym">IMAP</span> traffic. The other, less common method, uses
              the ordinary <span class="acronym">IMAP</span> port for initializing
              the connection and then, before any sensitive data is
              transmitted, initializes the encryption with the
              <span class="emphasis"><em>STARTTLS</em></span> command. <strong class="application"><code>Mailwatch</code></strong> provides
              default settings for these setups, which are
              <span><strong class="guimenuitem">Use SSL/TLS on alternate port</strong></span> and
              <span><strong class="guimenuitem">Use SSL/TLS via STARTTLS</strong></span>
              respectively.
            </p>
          <p>There's also the possibility of using a non-standard <span class="acronym">IMAP</span>
              port, if your service provider so requires. Just check the
              box, and type in the appropriate port.  The box will pre-fill
              the default port for the selected connection type.
            </p>
         </dd>
         <dt>
          <span class="term">Folders</span>
         </dt>
         <dd>
          <p>In addition of the connection related settings, you can
              set the directory on the server where your mail is stored using
              the <span><strong class="guilabel">IMAP server directory</strong></span> text box.  This
              setting may not be necessary on some systems.  If you see a large
              number of strange folder names when looking in the <span><strong class="guilabel">New
              mail folders</strong></span> dialog box, you may need to set this,
              often to something like "mail", "Mail", or "Maildir".
            </p>
         </dd>
        </dl>
       </div>
      </div>
      <div class="sect3" lang="en">
       <div class="titlepage">
        <div>
         <div>
          <h4 class="title"><a name="mailwatch-mailbox-imap-folders"></a>New mail folders</h4>
         </div>
        </div>
       </div>
       <div class="screenshot">
        <div class="mediaobject">
         <img src="images/mailwatch-imap-new-folders.png" alt="IMAP new mail folders settings"/>
        </div>
       </div>
       <p>Since <span class="acronym">IMAP</span> supports viewing mail in multiple folders, it's
        possible that you'd receive new mail in folders other than your
        inbox.  If that's the case, you can use the <span><strong class="guilabel">New Mail
        Folders</strong></span>  dialog to instruct <strong class="application"><code>Mailwatch</code></strong> to check mail in
        multiple folders.
      </p>
     </div>
    </div>
    <div class="sect2" lang="en">
     <div class="titlepage">
      <div>
       <div>
        <h3 class="title"><a name="mailwatch-mailbox-pop3"></a>POP3</h3>
       </div>
      </div>
     </div>
     <p><span class="acronym">POP3</span>, short for <span class="emphasis"><em>Post Office Protocol Version 3
      </em></span>, is another common type of remote mailboxes. Because
      of its remote nature, the settings for <span class="acronym">POP3</span> are almost the same
      as <span class="acronym">IMAP</span>, with some omissions as, <span class="acronym">POP3</span> isn't as advanced a protocol
      as <span class="acronym">IMAP</span>.
    </p>
     <div class="figure">
      <a name="mailwatch-mailbox-pop3-fig"></a>
      <p class="title"><b>Figure 7. POP3 Settings</b></p>
      <div class="screenshot">
       <div class="mediaobject">
        <img src="images/mailwatch-pop3-settings.png" alt="Mailwatch POP3 settings"/>
       </div>
      </div>
     </div>
     <div class="variablelist">
      <dl>
       <dt>
        <span class="term">Mailbox Name</span>
       </dt>
       <dd>
        <p>A descriptive name for the mailbox.
             The name entered here will appear on the <strong class="application"><code>Mailwatch</code></strong> icon
             tooltip, which indicates mailboxes that have new mail.
             This setting is required, regardless of the mailbox type.</p>
       </dd>
       <dt>
        <span class="term"><span class="acronym">POP3</span> Server</span>
       </dt>
       <dd>
        <div class="itemizedlist">
         <ul class="disc">
          <li>
           <p>Mail server - Hostname of the <span class="acronym">POP3</span> server.</p>
          </li>
          <li>
           <p>Username - Username to authenticate with.</p>
          </li>
          <li>
           <p>Password - Password to use in authentication.</p>
          </li>
         </ul>
        </div>
       </dd>
       <dt>
        <span class="term">Interval</span>
       </dt>
       <dd>
        <p>Defines how often <strong class="application"><code>Mailwatch</code></strong> accesses
             the mailbox to see if there's new mail. You shouldn't set
             this too low, as it will create unnecessary network traffic.
             It's not recommended to set this lower than 5 minutes,
             unless you're really sure your service provider
             is okay with that.</p>
       </dd>
      </dl>
     </div>
     <p>While for most users providing these settings should be enough,
      there are also advanced settings for those who need additional
      features.
    </p>
     <div class="sect3" lang="en">
      <div class="titlepage">
       <div>
        <div>
         <h4 class="title"><a name="mailwatch-mailbox-pop3-advanced"></a>Advanced Settings</h4>
        </div>
       </div>
      </div>
      <div class="figure">
       <a name="mailwatch-mailbox-pop3-advanced-fig"></a>
       <p class="title"><b>Figure 8. <span class="acronym">POP3</span> Advanced Settings</b></p>
       <div class="screenshot">
        <div class="mediaobject">
         <img src="images/mailwatch-pop3-advanced.png" alt="POP3 Advanced Settings dialog"/>
        </div>
       </div>
      </div>
      <div class="variablelist">
       <dl>
        <dt>
         <span class="term">Connection</span>
        </dt>
        <dd>
         <p>
              By default, due common practice, <strong class="application"><code>Mailwatch</code></strong> attempts
              to access the mailbox without encrypting the traffic
              between the local host and the mail server. For those,
              whose service provider supports encrypted connections,
              <strong class="application"><code>Mailwatch</code></strong> supports two different methods of encryption. 
              First one, quite commonly used, is to use an alternate
              port (default: 995) for encrypted connections. This way,
              the connection is encrypted from the beginning. The
              setting to choose from the dropdown list is
              <span><strong class="guimenuitem">Use SSL/TLS on alternate port</strong></span>
              for this method. The other, that uses the default <span class="acronym">POP3</span>
              port 110 and takes advantage of the
              <span class="emphasis"><em>STARTTLS</em></span> method of the protocol,
              is chosen with
              <span><strong class="guimenuitem">Use SSL/TLS via STARTTLS</strong></span>.
              If your service provider requires a port that is different
              of the defaults provided, you may define it by checking
              the <span><strong class="guilabel">Use non-standard POP3 port</strong></span>
              checkbox, and typing in the correct port number.
            </p>
        </dd>
       </dl>
      </div>
     </div>
    </div>
    <div class="sect2" lang="en">
     <div class="titlepage">
      <div>
       <div>
        <h3 class="title"><a name="mailwatch-mailbox-gmail"></a>GMail</h3>
       </div>
      </div>
     </div>
     <p>Mailwatch can also watch your
      <a href="http://gmail.com/">GMail</a> mailbox.
      Mailwatch does this securely by using HTTPS and GMail's RSS feed.
    </p>
     <div class="figure">
      <a name="mailwatch-mailbox-gmail-fig"></a>
      <p class="title"><b>Figure 9. GMail Settings</b></p>
      <div class="screenshot">
       <div class="mediaobject">
        <img src="images/mailwatch-gmail-settings.png" alt="GMail Settings"/>
       </div>
      </div>
     </div>
     <div class="variablelist">
      <dl>
       <dt>
        <span class="term">GMail Server</span>
       </dt>
       <dd>
        <div class="itemizedlist">
         <ul class="disc">
          <li>
           <p>Username - Your GMail username.</p>
          </li>
          <li>
           <p>Password - Your GMail password.</p>
          </li>
         </ul>
        </div>
       </dd>
      </dl>
     </div>
    </div>
    <div class="sect2" lang="en">
     <div class="titlepage">
      <div>
       <div>
        <h3 class="title"><a name="mailwatch-mailbox-maildir"></a>Maildir</h3>
       </div>
      </div>
     </div>
     <p>Maildir is a mailbox format for local mailboxes and thus
      there is no hostname, etc. to configure, but merely a directory
      where your mail is stored. A Maildir mailbox has a certain
      distinguishable hierarchy, which defines the mailbox (and which
      Mailwatch expects to find). A Maildir consists of a top level
      directory (<code class="filename">~/.maildir</code> for
      example), which contains three subdirectories
      (<code class="filename">cur</code>,
      <code class="filename">new</code>,
      <code class="filename">tmp</code>).
    </p>
     <div class="figure">
      <a name="mailwatch-mailbox-maildir-fig"></a>
      <p class="title"><b>Figure 10. Maildir Settings</b></p>
      <div class="screenshot">
       <div class="mediaobject">
        <img src="images/mailwatch-maildir-settings.png" alt="Mailwatch Maildir Settings"/>
       </div>
      </div>
     </div>
     <div class="variablelist">
      <dl>
       <dt>
        <span class="term">Mailbox Name</span>
       </dt>
       <dd>
        <p>A descriptive name for the mailbox.
             The name entered here will appear on the <strong class="application"><code>Mailwatch</code></strong> icon
             tooltip, which indicates mailboxes that have new mail.
             This setting is required, regardless of the mailbox type.</p></dd><dt><span class="term">Maildir Path</span></dt><dd><p>The toplevel directory of your Maildir.  (Note: This is the
            main mail folder, not any of the three subdirectories.)
          </p>
       </dd>
       <dt>
        <span class="term">Interval</span>
       </dt>
       <dd>
        <p>Defines how often <strong class="application"><code>Mailwatch</code></strong> checks the
             mailbox for new mail. It is safe to set a value as low as
             1 minute, as this is presumably on a local filesystem, or
             at least a local network.</p>
       </dd>
      </dl>
     </div>
    </div>
    <div class="sect2" lang="en">
     <div class="titlepage">
      <div>
       <div>
        <h3 class="title"><a name="mailwatch-mailbox-mbox"></a>Mbox</h3>
       </div>
      </div>
     </div>
     <p>Mbox is another very common local mailbox format in which each
      folder is a single, large file that contains all your messages.
      Because of this, Mbox expects to find a specially-formatted Mbox
      file instead of a directory tree.
    </p>
     <div class="figure">
      <a name="mailwatch-mailbox-mbox-fig"></a>
      <p class="title"><b>Figure 11. Mbox Settings</b></p>
      <div class="screenshot">
       <div class="mediaobject">
        <img src="images/mailwatch-mbox-settings.png" alt="Mbox Settings Dialog"/>
       </div>
      </div>
     </div>
     <div class="variablelist">
      <dl>
       <dt>
        <span class="term">Mailbox Name</span>
       </dt>
       <dd>
        <p>A descriptive name for the mailbox.
             The name entered here will appear on the <strong class="application"><code>Mailwatch</code></strong> icon
             tooltip, which indicates mailboxes that have new mail.
             This setting is required, regardless of the mailbox type.</p>
       </dd>
       <dt>
        <span class="term">Mbox Filename</span>
       </dt>
       <dd>
        <p>The location of your Mbox file (often
            <code class="filename">/var/mail/</code><code class="envar">$USER</code>).
          </p>
       </dd>
        <dt>
         <span class="term">Interval</span>
        </dt>
       <dd>
        <p>Defines how often <strong class="application"><code>Mailwatch</code></strong> checks the
             mailbox for new mail. It is safe to set a value as low as
             1 minute, as this is presumably on a local filesystem, or
             at least a local network.</p>
       </dd>
      </dl>
     </div>
    </div>
    <div class="sect2" lang="en">
     <div class="titlepage">
      <div>
       <div>
        <h3 class="title"><a name="mailwatch-mailbox-mh"></a>MH Maildir</h3>
       </div>
      </div>
     </div>
     <p>MH Maildir is a variant of the Maildir format.  For a MH
      Maildir, <strong class="application"><code>Mailwatch</code></strong> reads your
      <code class="envar">$HOME</code><code class="filename">/.mh_profile</code> for its
      configuration, so there are no actual settings specific to MH
      mailboxes.
    </p>
     <div class="figure">
      <a name="mailwatch-mailbox-mh-fig"></a>
      <p class="title"><b>Figure 12. MH Maildir Settings</b></p>
      <div class="screenshot">
       <div class="mediaobject">
        <img src="images/mailwatch-mh-settings.png" alt="MH Settings Dialog"/>
       </div>
      </div>
     </div>
     <div class="variablelist">
      <dl>
       <dt>
        <span class="term">Mailbox Name</span>
       </dt>
       <dd>
        <p>A descriptive name for the mailbox.
             The name entered here will appear on the <strong class="application"><code>Mailwatch</code></strong> icon
             tooltip, which indicates mailboxes that have new mail.
             This setting is required, regardless of the mailbox type.</p>
       </dd>
       <dt>
        <span class="term">Interval</span>
       </dt>
       <dd>
        <p>Defines how often <strong class="application"><code>Mailwatch</code></strong> checks the
             mailbox for new mail. It is safe to set a value as low as
             1 minute, as this is presumably on a local filesystem, or
             at least a local network.</p>
       </dd>
      </dl>
     </div>
    </div>
   </div>
   <div class="sect1" lang="en">
    <div class="titlepage">
     <div>
      <div>
       <h2 class="title" style="clear: both"><a name="mailwatch-about"></a>About <strong class="application"><code>Mailwatch</code></strong></h2>
      </div>
     </div>
    </div>
    <p><strong class="application"><code>Xfce4 Mailwatch Plugin</code></strong> is written and maintained by Brian Tarricone
    <code class="email">&lt;<a href="mailto:bjt23@cornell.edu">bjt23@cornell.edu</a>&gt;</code> and Pasi Orovuo
    <code class="email">&lt;<a href="mailto:pasi.ov@gmail.com">pasi.ov@gmail.com</a>&gt;</code>. For more information,
    please visit the <a href="http://spuriousinterrupt.org/projects/mailwatch">
    <strong class="application"><code>Mailwatch</code></strong> website</a>.
  </p>
    <p>All <strong class="application"><code>Mailwatch</code></strong> related bugs should be reported on
    <a href="http://bugzilla.xfce.org/">Xfce
    Bugzilla</a>, under the Xfce Panel Plugins product, mailwatch component.
  </p>
    <p>If you have problems using <strong class="application"><code>Mailwatch</code></strong>, use the
    <a href="http://foo-projects.org/mailman/listinfo/xfce">
    Xfce general discussion list</a> for questions. Development
    discussion takes place on the
    <a href="http://foo-projects.org/mailman/listinfo/xfce4-dev">Xfce4-dev mailing list</a>.
  </p>
    <p><strong class="application"><code>Xfce4 Mailwatch Plugin</code></strong> is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License
    as published by the Free Software Foundation; either version 2
    of the License, or (at your option) any later version.
  </p>
    <p>You should have received a copy of the GNU General Public
    License along with this program; if not, write to the Free
    Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA  02110-1301, USA.
  </p>
   </div>
  </div>
 </body>
</html>

xfce.css:

body 		{ font: "Vera Sans", "Arial", "Helvetica", "sans-serif"; 
    		  margin: 2em; background-color: #F3F4F8}
h1,h2,h3,h4	{ color: #11375F; }
h2              { margin-top: 1.5em; border-bottom: solid 1px; }
h3              { margin-top: 1em; margin-bottom: 0; }
dt              { margin-top: 0.2em; }
a		{ font-weight: bold; text-decoration: none; }
a:link,a:active { color: #1A5593; }
a:visited	{ color: #1A5593; }
a:hover		{ color: #3366FF; text-decoration: underline; }
hr		{ background-color: #11375F; border-style: solid; }
li		{ list-style-type: square; }
dt		{ font-weight: bold; }
.programlisting { background-color: #F8F9FD; border-color: #8593B3;
		  border-width: 1px; border-style: solid; padding: 0.5em; }
disc            { list-style-type:disc }
Comment 1 Brian J. Tarricone (not reading bugmail) 2008-08-16 09:55:46 CEST
The html is automatically generated, so there's not much I can do, unless you want to submit a patch for the .xsl stylesheet.
Comment 2 Ján Sučan editbugs 2013-11-01 16:58:00 CET
The documentation is no longer distributed with mailwatch plugin. It was moved to goodies.xfce.org.

I dont know exactly which status to choose to close this bug, but because now the subject of this bug report is not a part of mailwatch file tree I am choosing 'Invalid'.

Bug #4210

Reported by:
Matthias Krüger
Reported on: 2008-07-09
Last modified on: 2013-11-01

People

Assignee:
Florian Rivoal
CC List:
1 user

Version

Version:
1.1.0 or older

Attachments

Additional information