[OpenSPARC-T2-DV] / tools / perl-5.8.0 / doc / MHonArc / resources / datefields.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
<html>
<head>
<title>MHonArc Resources: DATEFIELDS</title>
</head>
<body>
<!--x-rc-nav-->
<table border=0><tr valign="top">
<td align="left" width="50%">[Prev:&nbsp;<a href="conlen.html">CONLEN</a>]</td><td><nobr>[<a href="../resources.html#datefields">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="daybegin.html">DAYBEGIN</a>]</td></tr></table>
<!--/x-rc-nav-->
<hr>
<h1>DATEFIELDS</h1>

<!-- *************************************************************** -->
<hr>
<h2>Syntax</h2>

<dl>

<dt><strong>Envariable</strong></dt>
<dd><p><br>
<code>M2H_DATEFIELDS=</code><var>field1</var><code>:</code><var
>field2</var><code>:</code><var>...</var><code>:</code><var
>fieldN</var>
</p>
</dd>

<dt><strong>Element</strong></dt>
<dd><p>
<code>&lt;DATEFIELDS&gt;</code><br>
<var>field1</var><code>:</code><var
>field2</var><code>:</code><var>...</var><code>:</code><var
>fieldN</var><br>
<code>&lt;/DATEFIELDS&gt;</code><br>
</p>
</dd>

<dt><strong>Command-line Option</strong></dt>
<dd><p>
<code>-datefields </code><var>field1</var><code>:</code><var
>field2</var><code>:</code><var>...</var><code>:</code><var
>fieldN</var>
</p>
</dd>

</dl>

<!-- *************************************************************** -->
<hr>
<h2>Description</h2>

<p>DATEFIELDS specify the message header fields mhonarc will search to
determine the dates of messages.  Each field will be checked in
the ordered specified.
</p>
<p>The value of the DATEFIELDS is a colon separated
list of message header fields to check.  Since it is legal for
multiple fields with the same name to appear in a message header
(e.g. <tt>Received</tt>), indexed fields are supported.  For example,
</p>
<pre>
<b>&lt;DateFields&gt;</b>
received[1]:received[0]:date
<b>&lt;/DateFields&gt;</b>
</pre>
<p>The example says that mhonarc should check the second received
field, then the first received field, and then the first date field
to determine the date of a message.
</p>
<p>Indexing starts at 0.  I.e. An index of 0 denotes the first
occurrence of the field, 1 denotes the second, etc.
If no integer index is specified, then 0 is used.
</p>

<!-- *************************************************************** -->
<hr>
<h2>Default Setting</h2>

<pre>
received:date
</pre>

<!-- *************************************************************** -->
<hr>
<h2>Resource Variables</h2>

<p>N/A
</p>

<!-- *************************************************************** -->
<hr>
<h2>Examples</h2>

<h3>Using composition date</h3>
<p>By default. mhonarc looks at the <tt>Received</tt> fields of
a message to determine a message's date.  This tends to be more
accurate as it tells when the message was actually received (it is
better to trust a date/time you have control over vs what the sender
has control over).  However, you may want to have the date based
upon the time the sender composed the message.  The <tt>Date</tt>
field usually reflects the composition date.  Therefore, the following
setting can be used:
</p>
<pre>
<b>&lt;DateFields&gt;</b>
date:received
<b>&lt;/DateFields&gt;</b>
</pre>

<h3>Indexed fields</h3>
<p>Specified indexed fields can be used if mail you archive is known to
following a specific delivery path.  Here is an example
scenario:
</p>
<ol>
<li>All incoming mail is first delivered to a central POP mail server
    of our ISP.</li>
<li><a href="http://www.tuxedo.org/~esr/fetchmail/"><tt>fetchmail</tt></a>
    is used to download the mail from the POP server to our local
    SMTP server.</li>
<li>The local SMTP server delivers the mail to a local user account that
    is used to archive the mail.</li>
</ol>

<p>With this scenario, we prefer to use the date stamp from the ISP
server since our local system may not always be up.  Each step above
causes a <tt>Received</tt> header field to be added to the message.
Since <tt>Received</tt> fields are listed from final delivery point to
starting delivery point (i.e. each step inserts a <tt>Received</tt>
field above existing header fields), we want to base the message
date on the 3rd <tt>Received</tt> field (the one created by the
ISP mail server).  Hence, DATEFIELDS shall be set to the following:
</p>
<pre>
<b>&lt;DateFields&gt;</b>
received[2]:received[1]:received[0]:date
<b>&lt;/DateFields&gt;</b>
</pre>
<p>We still specify fallback fields just-in-case.
</p>


<!-- *************************************************************** -->
<hr>
<h2>Version</h2>

<p>2.1.1
</p>

<!-- *************************************************************** -->
<hr>
<h2>See Also</h2>

<p>
<a href="fromfields.html">FROMFIELDS</a>
</p>

<!-- *************************************************************** -->
<hr>
<!--x-rc-nav-->
<table border=0><tr valign="top">
<td align="left" width="50%">[Prev:&nbsp;<a href="conlen.html">CONLEN</a>]</td><td><nobr>[<a href="../resources.html#datefields">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="daybegin.html">DAYBEGIN</a>]</td></tr></table>
<!--/x-rc-nav-->
<hr>
<address>
$Date: 2002/09/04 04:09:30 $ <br>
<img align="top" src="../monicon.png" alt="">
<a href="http://www.mhonarc.org/"
><strong>MHonArc</strong></a><br>
Copyright &#169; 1998,2002, <a href="http://www.earlhood.com/"
>Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org"
>mhonarc@mhonarc.org</a><br>
</address>

</body>
</html>
Commit	Line	Data
86530b38 AT	1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
	2	<html>
	3	<head>
	4	<title>MHonArc Resources: DATEFIELDS</title>
	5	</head>
	6	<body>
	7	<!--x-rc-nav-->
	8	<table border=0><tr valign="top">
	9	<td align="left" width="50%">[Prev: <a href="conlen.html">CONLEN</a>]</td><td><nobr>[<a href="../resources.html#datefields">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="daybegin.html">DAYBEGIN</a>]</td></tr></table>
	10	<!--/x-rc-nav-->
	11	<hr>
	12	<h1>DATEFIELDS</h1>
	13
	14	<!-- *************************************************************** -->
	15	<hr>
	16	<h2>Syntax</h2>
	17
	18	<dl>
	19
	20	<dt><strong>Envariable</strong></dt>
	21	<dd><p><br>
	22	<code>M2H_DATEFIELDS=</code><var>field1</var><code>:</code><var
	23	>field2</var><code>:</code><var>...</var><code>:</code><var
	24	>fieldN</var>
	25	</p>
	26	</dd>
	27
	28	<dt><strong>Element</strong></dt>
	29	<dd><p>
	30	<code><DATEFIELDS></code><br>
	31	<var>field1</var><code>:</code><var
	32	>field2</var><code>:</code><var>...</var><code>:</code><var
	33	>fieldN</var><br>
	34	<code></DATEFIELDS></code><br>
	35	</p>
	36	</dd>
	37
	38	<dt><strong>Command-line Option</strong></dt>
	39	<dd><p>
	40	<code>-datefields </code><var>field1</var><code>:</code><var
	41	>field2</var><code>:</code><var>...</var><code>:</code><var
	42	>fieldN</var>
	43	</p>
	44	</dd>
	45
	46	</dl>
	47
	48	<!-- *************************************************************** -->
	49	<hr>
	50	<h2>Description</h2>
	51
	52	<p>DATEFIELDS specify the message header fields mhonarc will search to
	53	determine the dates of messages. Each field will be checked in
	54	the ordered specified.
	55	</p>
	56	<p>The value of the DATEFIELDS is a colon separated
	57	list of message header fields to check. Since it is legal for
	58	multiple fields with the same name to appear in a message header
	59	(e.g. <tt>Received</tt>), indexed fields are supported. For example,
	60	</p>
	61	<pre>
	62	<b><DateFields></b>
	63	received[1]:received[0]:date
	64	<b></DateFields></b>
65	</pre>
66	<p>The example says that mhonarc should check the second received
67	field, then the first received field, and then the first date field
68	to determine the date of a message.
69	</p>
70	<p>Indexing starts at 0. I.e. An index of 0 denotes the first
71	occurrence of the field, 1 denotes the second, etc.
72	If no integer index is specified, then 0 is used.
73	</p>
74
75	<!-- *************************************************************** -->
76	<hr>
77	<h2>Default Setting</h2>
78
79	<pre>
80	received:date
81	</pre>
82
83	<!-- *************************************************************** -->
84	<hr>
85	<h2>Resource Variables</h2>
86
87	<p>N/A
88	</p>
89
90	<!-- *************************************************************** -->
91	<hr>
92	<h2>Examples</h2>
93
94	<h3>Using composition date</h3>
95	<p>By default. mhonarc looks at the <tt>Received</tt> fields of
96	a message to determine a message's date. This tends to be more
97	accurate as it tells when the message was actually received (it is
98	better to trust a date/time you have control over vs what the sender
99	has control over). However, you may want to have the date based
100	upon the time the sender composed the message. The <tt>Date</tt>
101	field usually reflects the composition date. Therefore, the following
102	setting can be used:
103	</p>
104	<pre>
105	<b><DateFields></b>
106	date:received
107	<b></DateFields></b>
108	</pre>
109
110	<h3>Indexed fields</h3>
111	<p>Specified indexed fields can be used if mail you archive is known to
112	following a specific delivery path. Here is an example
113	scenario:
114	</p>
115	<ol>
116	<li>All incoming mail is first delivered to a central POP mail server
117	of our ISP.</li>
118	<li><a href="http://www.tuxedo.org/~esr/fetchmail/"><tt>fetchmail</tt></a>
119	is used to download the mail from the POP server to our local
120	SMTP server.</li>
121	<li>The local SMTP server delivers the mail to a local user account that
122	is used to archive the mail.</li>
123	</ol>
124
125	<p>With this scenario, we prefer to use the date stamp from the ISP
126	server since our local system may not always be up. Each step above
127	causes a <tt>Received</tt> header field to be added to the message.
128	Since <tt>Received</tt> fields are listed from final delivery point to
129	starting delivery point (i.e. each step inserts a <tt>Received</tt>
130	field above existing header fields), we want to base the message
131	date on the 3rd <tt>Received</tt> field (the one created by the
132	ISP mail server). Hence, DATEFIELDS shall be set to the following:
133	</p>
134	<pre>
135	<b><DateFields></b>
136	received[2]:received[1]:received[0]:date
137	<b></DateFields></b>
138	</pre>
139	<p>We still specify fallback fields just-in-case.
140	</p>
141
142
143	<!-- *************************************************************** -->
144	<hr>
145	<h2>Version</h2>
146
147	<p>2.1.1
148	</p>
149
150	<!-- *************************************************************** -->
151	<hr>
152	<h2>See Also</h2>
153
154	<p>
155	<a href="fromfields.html">FROMFIELDS</a>
156	</p>
157
158	<!-- *************************************************************** -->
159	<hr>
160	<!--x-rc-nav-->
161	<table border=0><tr valign="top">
162	<td align="left" width="50%">[Prev: <a href="conlen.html">CONLEN</a>]</td><td><nobr>[<a href="../resources.html#datefields">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="daybegin.html">DAYBEGIN</a>]</td></tr></table>
163	<!--/x-rc-nav-->
164	<hr>
165	<address>
166	$Date: 2002/09/04 04:09:30 $ <br>
167	<img align="top" src="../monicon.png" alt="">
168	<a href="http://www.mhonarc.org/"
169	><strong>MHonArc</strong></a><br>
170	Copyright © 1998,2002, <a href="http://www.earlhood.com/"
171	>Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org"
172	>mhonarc@mhonarc.org</a><br>
173	</address>
174
175	</body>
176	</html>