manual/mod/mod_imap.html

	mod_imap.html revision 240a5b8962329911d02566b600be6226e1f857ae
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync     This file is generated from xml source: DO NOT EDIT
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync--><title>mod_imap - Apache HTTP Server</title><link rel="stylesheet" type="text/css" href="/style/manual.css"/></head><body><blockquote><div align="center"><img src="/images/sub.gif" alt="[APACHE DOCUMENTATION]"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_imap</h1><table bgcolor="#cccccc" cellpadding="0" cellspacing="1"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td>Server-side imagemap processing</td></tr><tr><td><a class="help" href="module-dict.html#Status">Status:</a></td><td>Base</td></tr><tr><td><a class="help" href="module-dict.html#ModuleIdentifier">Module&nbsp;Identifier:</a></td><td>imap_module</td></tr></table></td></tr></table><h2>Summary</h2>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    <p>This module processes <code>.map</code> files, thereby
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    replacing the functionality of the <code>imagemap</code> CGI
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    program. Any directory or document type configured to use the
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    handler <code>imap-file</code> (using either
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    <a class="directive" href="mod_mime.html#addhandler"><code class="directive">AddHandler</code></a> or
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    <a class="directive" href="core.html#sethandler"><code class="directive">SetHandler</code></a>)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    will be processed by this module.</p>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    <p>The following directive will activate files ending with
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    <code>.map</code> as imagemap files:</p>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>AddHandler imap-file map</code></td></tr></table></blockquote>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    <p>Note that the following is still supported:</p>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>AddType application/x-httpd-imap map</code></td></tr></table></blockquote>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    <p>However, we are trying to phase out "magic MIME types" so we
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    are deprecating this method.</p>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<h2>Directives</h2><ul><li><a href="#imapbase">ImapBase</a></li><li><a href="#imapdefault">ImapDefault</a></li><li><a href="#imapmenu">ImapMenu</a></li></ul><h2>New Features</h2>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    <p>The imagemap module adds some new features that were not
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    possible with previously distributed imagemap programs.</p>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    <ul>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      <li>URL references relative to the Referer: information.</li>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      <li>Default &lt;BASE&gt; assignment through a new map
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      directive <code>base</code>.</li>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      <li>No need for <code>imagemap.conf</code> file.</li>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      <li>Point references.</li>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      <li>Configurable generation of imagemap menus.</li>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    </ul>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<h2>Imagemap File</h2>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    <p>The lines in the imagemap files can have one of several
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    formats:</p>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      directive value [x,y ...]<br/>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      directive value "Menu text" [x,y ...]<br/>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      directive value x,y ... "Menu text"
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync</code></td></tr></table></blockquote>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    <p>The directive is one of <code>base</code>,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    <code>default</code>, <code>poly</code>, <code>circle</code>,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    <code>rect</code>, or <code>point</code>. The value is an
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    absolute or relative URL, or one of the special values listed
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    below. The coordinates are <code>x,y</code> pairs separated by
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    whitespace. The quoted text is used as the text of the link if
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    a imagemap menu is generated. Lines beginning with '#' are
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    comments.</p>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync<h3>Imagemap File Directives</h3>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    <p>There are six directives allowed in the imagemap file. The
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    directives can come in any order, but are processed in the
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    order they are found in the imagemap file.</p>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    <dl>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      <dt><code>base</code> Directive</dt>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      <dd>Has the effect of <code>&lt;BASE HREF="value"&gt;</code>.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      The non-absolute URLs of the map-file are taken relative to
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      this value. The <code>base</code> directive overrides
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      ImapBase as set in a .htaccess file or in the server
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      configuration files. In the absence of an ImapBase
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      configuration directive, <code>base</code> defaults to
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      <code>http://server_name/</code>.<br/>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync       <code>base_uri</code> is synonymous with <code>base</code>.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      Note that a trailing slash on the URL is significant.</dd>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      <dt><code>default</code> Directive</dt>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      <dd>The action taken if the coordinates given do not fit any
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      of the <code>poly</code>, <code>circle</code> or
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      <code>rect</code> directives, and there are no
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      <code>point</code> directives. Defaults to
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      <code>nocontent</code> in the absence of an ImapDefault
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      configuration setting, causing a status code of <code>204 No
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      Content</code> to be returned. The client should keep the
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      same page displayed.</dd>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      <dt><code>poly</code> Directive</dt>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      <dd>Takes three to one-hundred points, and is obeyed if the
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      user selected coordinates fall within the polygon defined by
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync      these points.</dd>

      <dt><code>circle</code></dt>

      <dd>Takes the center coordinates of a circle and a point on
      the circle. Is obeyed if the user selected point is with the
      circle.</dd>

      <dt><code>rect</code> Directive</dt>

      <dd>Takes the coordinates of two opposing corners of a
      rectangle. Obeyed if the point selected is within this
      rectangle.</dd>

      <dt><code>point</code> Directive</dt>

      <dd>Takes a single point. The point directive closest to the
      user selected point is obeyed if no other directives are
      satisfied. Note that <code>default</code> will not be
      followed if a <code>point</code> directive is present and
      valid coordinates are given.</dd>
    </dl>


<h3>Values</h3>

    <p>The values for each of the directives can any of the following:</p>


    <dl>
      <dt>a URL</dt>

      <dd>The URL can be relative or absolute URL. Relative URLs
      can contain '..' syntax and will be resolved relative to the
      <code>base</code> value.<br/>
       <code>base</code> itself will not resolved according to the
      current value. A statement <code>base mailto:</code> will
      work properly, though.</dd>

      <dt><code>map</code></dt>

      <dd>Equivalent to the URL of the imagemap file itself. No
      coordinates are sent with this, so a menu will be generated
      unless ImapMenu is set to 'none'.</dd>

      <dt><code>menu</code></dt>

      <dd>Synonymous with <code>map</code>.</dd>

      <dt><code>referer</code></dt>

      <dd>Equivalent to the URL of the referring document. Defaults
      to <code>http://servername/</code> if no Referer: header was
      present.</dd>

      <dt><code>nocontent</code></dt>

      <dd>Sends a status code of <code>204 No Content</code>,
      telling the client to keep the same page displayed. Valid for
      all but <code>base</code>.</dd>

      <dt><code>error</code></dt>

      <dd>Fails with a <code>500 Server Error</code>. Valid for all
      but <code>base</code>, but sort of silly for anything but
      <code>default</code>.</dd>
    </dl>


<h3>Coordinates</h3>

    <dl>
      <dt><code>0,0 200,200</code></dt>

      <dd>A coordinate consists of an <code>x</code> and a <code>y</code>
      value separated by a comma. The coordinates are separated
      from each other by whitespace. To accommodate the way Lynx
      handles imagemaps, should a user select the coordinate
      <code>0,0</code>, it is as if no coordinate had been
      selected.</dd>
    </dl>


<h3>Quoted Text</h3>

    <dl>
      <dt><code>"Menu Text"</code></dt>

      <dd>After the value or after the coordinates, the line
      optionally may contain text within double quotes. This string
      is used as the text for the link if a menu is
      generated:<br/>
       <code>&lt;a HREF="http://foo.com/"&gt;Menu
      text&lt;/a&gt;</code><br/>
       If no quoted text is present, the name of the link will be
      used as the text:<br/>
       <code>&lt;a
      HREF="http://foo.com/"&gt;http://foo.com&lt;/a&gt;</code><br/>
       It is impossible to escape double quotes within this
      text.</dd>
    </dl>

<h2>Example Mapfile</h2>

<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
      #Comments are printed in a 'formatted' or
      'semiformatted' menu.<br/>
       #And can contain html tags. &lt;hr&gt;<br/>
       base referer<br/>
       poly map "Could I have a menu, please?" 0,0 0,10 10,10
      10,0<br/>
       rect .. 0,0 77,27 "the directory of the referer"<br/>
       circle http://www.inetnebr.com/lincoln/feedback/ 195,0
      305,27<br/>
       rect another_file "in same directory as referer" 306,0
      419,27<br/>
       point http://www.zyzzyva.com/ 100,100<br/>
       point http://www.tripod.com/ 200,200<br/>
       rect mailto:nate@tripod.com 100,150 200,0 "Bugs?"<br/>
</code></td></tr></table></blockquote>

<h2>Referencing your mapfile</h2>

<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
      &lt;A HREF="/maps/imagemap1.map"&gt;<br/>
       &lt;IMG ISMAP SRC="/images/imagemap1.gif"&gt;<br/>
       &lt;/A&gt;
</code></td></tr></table></blockquote>
<hr/><h2><a name="ImapBase">ImapBase</a> <a name="imapbase">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Default base for imagemap files</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>ImapBase map|referer|<em>URL</em></td></tr><tr><td><a class="help" href="directive-dict.html#Default">Default:</a></td><td><code>ImapBase http://servername/</code></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a class="help" href="directive-dict.html#Override">Override:</a></td><td>Indexes</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Base</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_imap</td></tr></table></td></tr></table>
    <p>The <code class="directive">ImapBase</code> directive sets the default
    <code>base</code> used in the imagemap files. Its value is
    overridden by a <code>base</code> directive within the imagemap
    file. If not present, the <code>base</code> defaults to
    <code>http://servername/</code>.</p>
<hr/><h2><a name="ImapDefault">ImapDefault</a> <a name="imapdefault">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Default action when an imagemap is called with coordinates
that are not explicitly mapped</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>ImapDefault error|nocontent|map|referer|<em>URL</em></td></tr><tr><td><a class="help" href="directive-dict.html#Default">Default:</a></td><td><code>ImapDefault nocontent</code></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a class="help" href="directive-dict.html#Override">Override:</a></td><td>Indexes</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Base</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_imap</td></tr></table></td></tr></table>
    <p>The <code class="directive">ImapDefault</code> directive sets the default
    <code>default</code> used in the imagemap files. Its value is
    overridden by a <code>default</code> directive within the
    imagemap file. If not present, the <code>default</code> action
    is <code>nocontent</code>, which means that a <code>204 No
    Content</code> is sent to the client. In this case, the client
    should continue to display the original page.</p>
<hr/><h2><a name="ImapMenu">ImapMenu</a> <a name="imapmenu">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Action if no coordinates are given when calling
an imagemap</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>ImapMenu
    none|formatted|semiformatted|unformatted</td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a class="help" href="directive-dict.html#Override">Override:</a></td><td>Indexes</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Base</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_imap</td></tr></table></td></tr></table>
    <p>The <code class="directive">ImapMenu</code> directive determines the
    action taken if an imagemap file is called without valid
    coordinates.</p>

    <dl>
      <dt><code>none</code></dt>

      <dd>If ImapMenu is <code>none</code>, no menu is generated,
      and the <code>default</code> action is performed.</dd>

      <dt><code>formatted</code></dt>

      <dd>A <code>formatted</code> menu is the simplest menu.
      Comments in the imagemap file are ignored. A level one header
      is printed, then an hrule, then the links each on a separate
      line. The menu has a consistent, plain look close to that of
      a directory listing.</dd>

      <dt><code>semiformatted</code></dt>

      <dd>In the <code>semiformatted</code> menu, comments are
      printed where they occur in the imagemap file. Blank lines
      are turned into HTML breaks. No header or hrule is printed,
      but otherwise the menu is the same as a
      <code>formatted</code> menu.</dd>

      <dt><code>unformatted</code></dt>

      <dd>Comments are printed, blank lines are ignored. Nothing is
      printed that does not appear in the imagemap file. All breaks
      and headers must be included as comments in the imagemap
      file. This gives you the most flexibility over the appearance
      of your menus, but requires you to treat your map files as
      HTML instead of plaintext.</dd>
    </dl>
<hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img src="/images/index.gif" alt="Index"/></a><a href="../"><img src="/images/home.gif" alt="Home"/></a></blockquote></body></html>