272 lines
16 KiB
HTML
272 lines
16 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE html
|
||
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html lang="en-us" xml:lang="en-us">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
<meta name="security" content="public" />
|
||
|
|
<meta name="Robots" content="index,follow" />
|
||
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
||
|
|
<meta name="DC.Type" content="topic" />
|
||
|
|
<meta name="DC.Title" content="Module mod_imap" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 2002,2006" />
|
||
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2002,2006" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="rzaiemod_imap" />
|
||
|
|
<meta name="DC.Language" content="en-us" />
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
||
|
|
<title>Module mod_imap</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzaiemod_imap"><a name="rzaiemod_imap"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<!--Java sync-link--><h1 class="topictitle1">Module mod_imap</h1>
|
||
|
|
<div><div class="important"><span class="importanttitle">Important:</span> Information
|
||
|
|
for this topic supports the latest PTF levels for HTTP Server for i5/OS .
|
||
|
|
It is recommended that you install the latest PTFs to upgrade to the latest
|
||
|
|
level of the HTTP Server for i5/OS. Some of the topics documented here are
|
||
|
|
not available prior to this update. See <a href="http://www-03.ibm.com/servers/eserver/iseries/software/http/services/service.html" target="_blank">http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm</a> <img src="www.gif" alt="Link outside Information Center" /> for more information. </div>
|
||
|
|
<p><strong>Summary</strong></p>
|
||
|
|
<p>The module mod_imap provides for .map files, replacing the functionality
|
||
|
|
of the imagemap CGI program. Any directory or document type configured to
|
||
|
|
use the handler imap-file (using either AddHandler or SetHandler) will be
|
||
|
|
processed by this module. This module is in the default HTTP Server distribution.
|
||
|
|
The following directive will activate files ending with Map as imagemap files: </p>
|
||
|
|
<pre class="block">AddHandler imap-file map </pre>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> The following is still supported: </div>
|
||
|
|
<pre class="block">AddType application/x-httpd-imap map </pre>
|
||
|
|
<p><strong>Features</strong> </p>
|
||
|
|
<ul><li>URL references relative to the Referer: information</li>
|
||
|
|
<li>Default <BASE> assignment through a new map directive base</li>
|
||
|
|
<li>No need for imagemap.conf file</li>
|
||
|
|
<li>Point references</li>
|
||
|
|
<li>Configurable generation of imagemap lists</li>
|
||
|
|
</ul>
|
||
|
|
<p>See <a href="#imagemapinfo">Additional information on Imagemap files</a> for more information on Imagemaps.</p>
|
||
|
|
<p><strong>Directives</strong></p>
|
||
|
|
<ul><li><a href="#imapbase">ImapBase</a></li>
|
||
|
|
<li><a href="#imapdefault">ImapDefault</a></li>
|
||
|
|
<li><a href="#imapmenu">ImapMenu</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="hr" id="imapbase"><a name="imapbase"><!-- --></a><h2 class="topictitle2">ImapBase</h2>
|
||
|
|
<div>
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_imap </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: ImapBase <em>map | referer | URL</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: ImapBase map </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="imapbase__imapbase_context"><a name="imapbase__imapbase_context"><!-- --></a>server config,
|
||
|
|
virtual host, directory, .htaccess </span></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: Indexes </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="imapbase__imapbase_origin"><a name="imapbase__imapbase_origin"><!-- --></a>Apache </span></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: ImapBase map </td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p>The ImapBase directive sets the default base used in the imagemap files.
|
||
|
|
Its value is overridden by a base directive within the imagemap file. If not
|
||
|
|
present, the base defaults to http://servername/. </p>
|
||
|
|
<dl class="block"><dt class="dlterm"><strong>Parameter</strong>: <em>map | referer | URL</em></dt>
|
||
|
|
<dd><ul><li>The <em>map</em> parameter is equivalent to the URL of the imagemap file
|
||
|
|
itself. No coordinates are sent with this, so a list will be generated unless
|
||
|
|
Imaplist is set to none. </li>
|
||
|
|
<li>The <em>referer</em> parameter is equivalent to the URL of the referring
|
||
|
|
document. Defaults to http://servername/ if no Referer. </li>
|
||
|
|
<li>The <em>URL</em> parameter can be relative or absolute. Relative URLs can
|
||
|
|
contain '..' syntax and will be resolved relative to the base value . The
|
||
|
|
base value itself will not be resolved according to the current value. The
|
||
|
|
statement base mailto: will work properly, though. </li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="hr" id="imapdefault"><a name="imapdefault"><!-- --></a><h2 class="topictitle2">ImapDefault</h2>
|
||
|
|
<div>
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_imap </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: ImapDefault <em>error | nocontent | map |
|
||
|
|
referer | URL</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: ImapDefault nocontent </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="imapdefault__imapdefault_context"><a name="imapdefault__imapdefault_context"><!-- --></a>server config,
|
||
|
|
virtual host, directory, .htaccess </span></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: Indexes </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="imapdefault__imapdefault_origin"><a name="imapdefault__imapdefault_origin"><!-- --></a>Apache </span></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: ImapDefault nocontent </td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p>The ImapDefault directive sets the default used in the imagemap files.
|
||
|
|
Its value is overridden by a default directive within the imagemap file. If
|
||
|
|
not present, the default action is nocontent, which means that a 204 No Content
|
||
|
|
is sent to the client. In this case, the client should continue to display
|
||
|
|
the original page. </p>
|
||
|
|
<dl class="block"><dt class="dlterm"><strong>Parameter</strong>: <em>error | nocontent | map | referer | URL </em></dt>
|
||
|
|
<dd><ul><li>The <em>error</em> parameter fails with a 500 Server Error. Valid for all
|
||
|
|
but base , but sort of useless for anything but default. </li>
|
||
|
|
<li>The <em>nocontent</em> parameter sends a status code of 204 No Content,
|
||
|
|
telling the client to keep the same page displayed. Valid for all but base.
|
||
|
|
</li>
|
||
|
|
<li>The <em>map</em> parameter is equivalent to the URL of the imagemap file
|
||
|
|
itself. No coordinates are sent with this, so a list will be generated unless
|
||
|
|
Imaplist is set to none. </li>
|
||
|
|
<li>The <em>referer</em> parameter is equivalent to the URL of the referring
|
||
|
|
document. Defaults to http://servername/ if no Referer. </li>
|
||
|
|
<li>The URL parameter can be relative or absolute. Relative URLs can contain
|
||
|
|
'..' syntax and will be resolved relative to the base value . The base value
|
||
|
|
itself will not be resolved according to the current value. However, the statement
|
||
|
|
base mailto: will work properly. </li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="hr" id="imapmenu"><a name="imapmenu"><!-- --></a><h2 class="topictitle2">ImapMenu</h2>
|
||
|
|
<div>
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_imap </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: Imapmenu<em>none | formatted | semiformatted
|
||
|
|
| unformatted </em></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: Imapmenu formatted </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="imapmenu__imapmenu_context"><a name="imapmenu__imapmenu_context"><!-- --></a>server config,
|
||
|
|
virtual host, directory, .htaccess </span></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: Indexes </td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="imapmenu__imapmenu_origin"><a name="imapmenu__imapmenu_origin"><!-- --></a>Apache</span></td>
|
||
|
|
</tr>
|
||
|
|
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: ImapMenu formatted </td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p>The ImapMenu directive determines the action taken if an imagemap file
|
||
|
|
is called without valid coordinates. </p>
|
||
|
|
<dl class="block"><dt class="dlterm"><strong>Parameter</strong>: <em>none | formatted | semiformatted | unformatted </em></dt>
|
||
|
|
<dd><ul><li>The <em>none</em> parameter means no menu is generated and the default action
|
||
|
|
is performed </li>
|
||
|
|
<li>The <em>formatted</em> parameter formatted menu which 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. </li>
|
||
|
|
<li>The <em>semiformatted</em> parameter generates a semiformatted 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 formatted menu. </li>
|
||
|
|
<li>The <em>unformatted</em> parameter generates an unformatted menu, 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 menu, but requires you to treat your map files as HTML instead of
|
||
|
|
plaintext.</li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="hr" id="imagemapinfo"><a name="imagemapinfo"><!-- --></a><h2 class="topictitle2">Additional information on Imagemap files</h2>
|
||
|
|
<div><p>The lines in the imagemap files can have one of several formats: </p>
|
||
|
|
<pre class="block">directive value [x,y ...]
|
||
|
|
directive value "Menu text" [x,y ...]
|
||
|
|
directive value x,y ... "Menu text"</pre>
|
||
|
|
<p>The directive is one of base, default, poly, circle, rect, or point. The
|
||
|
|
value is an absolute or relative URL, or one of the special values listed
|
||
|
|
below. The coordinates are x,y pairs separated by whitespace. The quoted text
|
||
|
|
is used as the text of the link if a imagemap list is generated. Lines beginning
|
||
|
|
with '#' are comments. </p>
|
||
|
|
<p><strong>Imagemap File Directives </strong></p>
|
||
|
|
<p>There are six directives allowed in the imagemap file. The directives can
|
||
|
|
come in any order, but are processed in the order they are found in the imagemap
|
||
|
|
file. </p>
|
||
|
|
<ul><li>base directive - Has the effect of <BASE HREF="value">. The non-absolute
|
||
|
|
URLs of the map-file are taken relative to this value. The base directive
|
||
|
|
overrides ImapBase as set in a .htaccess file or in the server configuration
|
||
|
|
files. In the absence of an ImapBase configuration directive, base defaults
|
||
|
|
to http://server_name/. </li>
|
||
|
|
<li>base_uri - Is synonymous with base. Note that a trailing slash on the
|
||
|
|
URL is significant. </li>
|
||
|
|
<li>default directive - The action taken if the coordinates given do not fit
|
||
|
|
any of the poly, circle or rect directives, and there are no point directives.
|
||
|
|
Defaults to nocontent in the absence of an ImapDefault configuration setting,
|
||
|
|
causing a status code of 204 No Content to be returned. The client should
|
||
|
|
keep the same page displayed. </li>
|
||
|
|
<li>poly directive - Takes three to one-hundred points, and is obeyed if the
|
||
|
|
user selected coordinates fall within the polygon defined by these points.
|
||
|
|
</li>
|
||
|
|
<li>circle directive - Takes the center coordinates of a circle and a point
|
||
|
|
on the circle. Is obeyed if the user selected point is with the circle. </li>
|
||
|
|
<li>rect directive - Takes the coordinates of two opposing corners of a rectangle.
|
||
|
|
Obeyed if the point selected is within this rectangle. </li>
|
||
|
|
<li>point directive - Takes a single point. The point directive closest to
|
||
|
|
the user selected point is obeyed if no other directives are satisfied. Note
|
||
|
|
that default will not be followed if a point directive is present and valid
|
||
|
|
coordinates are given. </li>
|
||
|
|
</ul>
|
||
|
|
<p><strong>Values</strong> </p>
|
||
|
|
<p>The values for each of the directives can be any of the following: </p>
|
||
|
|
<ul><li>URL - The URL can be relative or absolute. Relative URLs can contain '..'
|
||
|
|
syntax and will be resolved relative to the base valu . The base value itself
|
||
|
|
will not be resolved according to the current value. The statement base mailto:
|
||
|
|
will work properly, though. </li>
|
||
|
|
<li>Map - Equivalent to the URL of the imagemap file itself. No coordinates
|
||
|
|
are sent with this, so a list will be generated unless Imaplist is set to
|
||
|
|
none. </li>
|
||
|
|
<li>Menu - Synonymous with map. </li>
|
||
|
|
<li>Referer - Equivalent to the URL of the referring document. Defaults to
|
||
|
|
http://servername/ if no Referer: </li>
|
||
|
|
<li>nocontent - Sends a status code of 204 No Content, telling the client
|
||
|
|
to keep the same page displayed. Valid for all but base. </li>
|
||
|
|
<li>Error - Fails with a 500 Server Error. Valid for all but base , but sort
|
||
|
|
of useless for anything but default. </li>
|
||
|
|
</ul>
|
||
|
|
<p><strong>Coordinates</strong></p>
|
||
|
|
<p>0,0 200,200 - A coordinate consists of an x and a y 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 0,0, it
|
||
|
|
is as if no coordinate had been selected. </p>
|
||
|
|
<p><strong>Quoted Text</strong> </p>
|
||
|
|
<p>list Text - 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 list is generated: </p>
|
||
|
|
<pre class="block"><A HREF="http://QIBM.com/">list text</A>
|
||
|
|
If quoted text is not present, the name of the link will be used as the text:
|
||
|
|
<A HREF="http://QIBM.com/">http://QIBM.com</A></pre>
|
||
|
|
<p>It is impossible to escape double quotes within this text. </p>
|
||
|
|
<p><strong>Example Mapfile </strong></p>
|
||
|
|
<pre class="block">#Comments are printed in a 'formatted' or 'semiformatted' list.
|
||
|
|
#And can contain html tags. <hr>
|
||
|
|
base referer
|
||
|
|
poly map "Could I have a list, please?" 0,0 0,10 10,10 10,0
|
||
|
|
rect .. 0,0 77,27 "the directory of the referer"
|
||
|
|
circle http://www.ibmdc.com/lincoln/feedback/ 195,0 305,27
|
||
|
|
rect another_file "in same directory as referer" 306,0 419,27
|
||
|
|
point http://www.ibmda.com/ 100,100
|
||
|
|
point http://www.ibmdb.com/ 200,200
|
||
|
|
rect mailto:me@ibm.com 100,150 200,0 "Bugs?" </pre>
|
||
|
|
<p><strong>Referencing your mapfile </strong></p>
|
||
|
|
<pre class="block"><A HREF="/maps/imagemap1.map">
|
||
|
|
<IMG ISMAP SRC="/images/imagemap1.gif">
|
||
|
|
</A></pre>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|