charlesb 01/05/20 09:43:29
Added: src/xdocs architecture1_2.xml listservs.xml matchers.xml
Log:
Hacking existing html docs to xml
Revision Changes Path
1.1 jakarta-james/src/xdocs/architecture1_2.xml
Index: architecture1_2.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>James 1.2 - Notes for developers</title>
<author email="[EMAIL PROTECTED]">Charles Benett</author>
</properties>
<body>
<section name="Architecture">
<p>
JAMES is a multi-protocol message processing and storage engine. JAMES
currently consists of:
<ul>
<li> two mail prototcol servers (SMTP and POP3),</li>
<li> a remote administration server,</li>
<li> a mail processing engine that supports the Mailet API</li>
<li> file-system message storage and a message storage interface
to RDBMS's</li>
<li> file-system user record storage and an experimental interface
to LDAP directories</li>
<li> beta support for TLS (SSL) for POP3 and remote administration</li>
</ul>
</p>
<p>
JAMES is built on top of Avalon, the Java Apache Server Framework.
Versions 1.1 and 1.2 of James use a slightly older version of Avalon,
specifically the <code>avalon-james-1-1b1</code> branch. We intend to
migrate to the new Avalon in the near future.</p>
</section>
</body>
</document>
1.1 jakarta-james/src/xdocs/listservs.xml
Index: listservs.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>James 1.2.1 - Mailets</title>
<author email="[EMAIL PROTECTED]">Serge Knystautas</author>
</properties>
<body>
<section name="Mailets">
<p>
Several mailets are included with James 1.2.1, they are described below.
</p>
</section>
<section name="Avalon Listserv">
<p>
<b>An Avalon-based listserv.</b>
This uses settings specified in the JAMES.conf.xml file, and uses an
Avalon UserRepository manager as the listserv members.
</p>
<p>
Required parameters:
<br>
<members> The URL to the Avalon UserRepository.
</br>
<br>
<membersonly> Either true or false. Indicates whether only
members of this listserv can send messages to it.
</br>
<br>
<attachmentsallowed> Either true or false. Indicates whether
you can send attachments to this listserv.
</br>
<br>
<replytolist> Either true or false. Indicates whether the Reply-To
header is set, which will direct replies to the list itself.
</br>
Optional parameters:
<br>
<subjectprefix> This text will be put in brackets at the beginning
of the subject of the message if specified.
</br>
</p>
</section>
<section name="Avalon Listserv Manager">
<p>
<b>An Avalon-based listserv manager.</b>
Handles adding a removing members to the specified UserRepository.
</p>
<p>
Required parameters:
<br>
<members>
</br>
</p>
</section>
</body>
</document>
1.1 jakarta-james/src/xdocs/matchers.xml
Index: matchers.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>James 1.2.1 - Matchers</title>
<author email="[EMAIL PROTECTED]">Serge Knystautas</author>
</properties>
<body>
<section name="Matchers">
<p>
Several matchers are included with James 1.2.1, they are described below.
</p>
</section>
<section name="All">
<p>
<b>Universal match</b>
Matches all recipients of all mails reaching it.
</p>
<p>
Condition:
<br>
none
</br>
</p>
</section>
<section name="CommandForListserv">
<p>
<b>Intercept commands for Listserv Manager</b>
Matches the on and off version of the address specified.
<br>
For instance, if the match was specified as
[EMAIL PROTECTED], then this match would
match [EMAIL PROTECTED] and [EMAIL PROTECTED]
</br>
<br>
Useful to channel listserv commands to a different mailet.
</br>
</p>
<p>
Condition:
<br>
listserv address to use as base.
</br>
</p>
</section>
<section name="HostIs">
<p>
<b>Match by Recipient Host</b>
Matches recipients where the domain of the recipient's email address
matches the host specified in the condition.
<br>
This is a string comparison and does not check DNS information.
</br>
</p>
<p>
Condition:
<br>
the hostname to compare to the recipient's domain name.
</br>
</p>
</section>
<section name="HostIsLocal">
<p>
<b>Match by Recipient Host</b>
Matches recipients where the domain of the recipient's email
address matches one of the hosts handled by this server.
</p>
<p>
Condition:
<br>
none
</br>
</p>
</section>
<section name="RecipientIs">
<p>
<b>Match by Recipient</b>
Matches recipients where the domain of the recipient's email address
matches the host specified in the condition.
</p>
<p>
Condition:
<br>
a comma or space delimited list of email addresses.
</br>
</p>
</section>
<section name="RecipientIsLocal">
<p>
<b>Match by Recipient User and Host</b>
Matches the recipient's domain against the hosts handled by this server
and the recipient's user against the user accounts of this server.
</p>
<p>
Condition:
<br>
none
</br>
</p>
</section>
<section name="RelayLimit">
<p>
<b>Match by Hops</b>
Matches mail is it has been relayed more than the number
specified in the condition.
<br>
Determines number of hops by counting the number of Received
headers in the message.
</br>
</p>
<p>
Condition:
<br>
the number of hops at which this message should start matching.
</br>
</p>
</section>
<section name="RemoteInNetwork">
<p>
<b>Match by SMTP Sender</b>
Matches mail if the IP address of the sending machine
is in one of the networks specified in the condition.
</p>
<p>
Condition:
<br>
a comma or space delimited list of IP addresses and networks.
Networks are specified by leaving off the appropriate subnet mask as is
done in /etc/hosts.allow and /etc/hosts.deny in unix,
e.g., 38.177.223.
</br>
</p>
</section>
<section name="RemoteNotInNetwork">
<p>
<b>Match by SMTP Sender</b>
Matches mail if the IP address of the sending machine
is not in one of the networks specified in the condition.
</p>
<p>
Condition:
<br>
a comma or space delimited list of IP addresses and networks.
Networks are specified by leaving off the appropriate subnet mask as is
done in /etc/hosts.allow and /etc/hosts.deny in unix,
e.g., 38.177.223.
</br>
</p>
</section>
<section name="SenderInFakeDomain">
<p>
<b>Verify Sender's Domain</b>
Does a DNS lookup for MX, A or CNAME record on the sending email
address's domain part. If no DNS records are found, the mail is matche d.
(useful for blocking mail with forged email addresses.)
</p>
<p>
Condition:
<br>
none
</br>
</p>
</section>
<section name="SenderIs">
<p>
<b>Match by Sender</b>
Matches mail if sender is one of the email addresses
specified in the condition.
</p>
<p>
Condition:
<br>
a comma or space delimited list of email addresses.
</br>
</p>
</section>
<section name="SubjectIs">
<p>
<b>Match by Subject</b>
Matches mail if the subject is the same as the one specified
in the condition.
</p>
<p>
Condition:
<br>
a subject to match.
</br>
</p>
</section>
<section name="SubjectStartsWith">
<p>
<b>Match by Subject</b>
Matches mail if the subject starts with the one specified
in the condition.
</p>
<p>
Condition:
<br>
a subject fragment to match.
</br>
</p>
</section>
<section name="UserIs">
<p>
<b>Match by Recipient</b>
Matches mail if the user part of a recipient's email address matches one
of the users specified in the condition. The user portion of an email
address is the part before the @ symbol.
</p>
<p>
Condition:
<br>
a comma or space delimited list of users.
</br>
</p>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
