Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / doc / MHonArc / resources / mailtourl.html
CommitLineData
86530b38
AT
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
2<html>
3<head>
4<title>MHonArc Resources: MAILTOURL</title>
5</head>
6<body>
7<!--x-rc-nav-->
8<table border=0><tr valign="top">
9<td align="left" width="50%">[Prev:&nbsp;<a href="mailto.html">MAILTO</a>]</td><td><nobr>[<a href="../resources.html#mailtourl">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="main.html">MAIN</a>]</td></tr></table>
10<!--/x-rc-nav-->
11<hr>
12<h1>MAILTOURL</h1>
13
14<!-- *************************************************************** -->
15<hr>
16<h2>Syntax</h2>
17
18<dl>
19
20<dt><strong>Envariable</strong></dt>
21<dd><p>
22<code>M2H_MAILTOURL=</code><var>URL-template</var>
23</p>
24</dd>
25
26<dt><strong>Element</strong></dt>
27<dd><p>
28<code>&lt;MAILTOURL&gt;<br></code>
29<var>URL-template</var><br>
30<code>&lt;/MAILTOURL&gt;<br></code>
31</p>
32</dd>
33
34<dt><strong>Command-line Option</strong></dt>
35<dd><p>
36<code>-mailtourl </code><var>URL-template</var>
37</p>
38</dd>
39
40</dl>
41
42<!-- *************************************************************** -->
43<hr>
44<h2>Description</h2>
45
46<p>The MAILTOURL defines the URL template for hyperlinking mail
47addresses in message headers when the
48<a href="mailto.html">MAILTO</a> resource is active.
49</p>
50
51<DL>
52<DT><STRONG>NOTE</STRONG>
53<DD><P>The MAILTOURL resource has
54different rules for variable expansion. If a
55variable does not exactly match the set of variables available for
56the MAILTOURL, the variable text will be taken literally
57as part of the element content. Therefore, a single "<CODE>$</CODE>"
58can be used to represent a "<CODE>$</CODE>" character. </P>
59<P>Also,
60variables in the MAILTOURL should <STRONG>NOT</STRONG>
61have "<CODE>:</CODE><VAR>NU</VAR>" modifier. This will prevent the
62variables from be recognized. <EM>MHonArc</EM> will automatically
63treat the replacement value as a part of a URL string.
64</P>
65</DD></DL>
66
67<!-- *************************************************************** -->
68<hr>
69<h2>Default Setting</h2>
70
71<pre>
72mailto:$TO$
73</pre>
74
75<!-- *************************************************************** -->
76<hr>
77<h2>Resource Variables</h2>
78
79<table border=1>
80<tr bgcolor="#C0C0C0">
81<th>Variable</th><th>Value</th>
82</tr>
83<tr valign=top>
84<td align=center><a name="FROMADDR" href="../rcvars.html#FROMADDR"><strong><code>$FROMADDR$</code></strong></a></td>
85<td>The e-mail address in the <tt>From:</tt> field of the message.</td>
86</tr>
87<tr valign=top>
88<td align=center><a name="FROMADDRDOMAIN" href="../rcvars.html#FROMADDRDOMAIN"><strong><code>$FROMADDRDOMAIN$</code></strong></a></td>
89<td>The e-mail address domain of the <tt>From:</tt> field of the message.</td>
90</tr>
91<tr valign=top>
92<td align=center><a name="FROMADDRNAME" href="../rcvars.html#FROMADDRNAME"><strong><code>$FROMADDRNAME$</code></strong></a></td>
93<td>The e-mail address "username" (or local-part) of the <tt>From:</tt> field of the message.</td>
94</tr>
95<tr valign=top>
96<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
97<td>The human name of the person in the <tt>From:</tt> field of the message. If no human name is found, the username specified in the e-mail address is used.</td>
98</tr>
99<tr valign=top>
100<td align=center><a name="MSGGMTDATE" href="../rcvars.html#MSGGMTDATE"><strong><code>$MSGGMTDATE$</code></strong></a></td>
101<td>GMT date of current message.</td>
102</tr>
103<tr valign=top>
104<td align=center><a name="MSGID" href="../rcvars.html#MSGID"><strong><code>$MSGID$</code></strong></a></td>
105<td>The message-id of the message.</td>
106</tr>
107<tr valign=top>
108<td align=center><a name="MSGLOCALDATE" href="../rcvars.html#MSGLOCALDATE"><strong><code>$MSGLOCALDATE$</code></strong></a></td>
109<td>Local date of current message.</td>
110</tr>
111<tr valign=top>
112<td align=center><a name="TO" href="../rcvars.html#TO"><strong><code>$TO$</code></strong></a></td>
113<td>The email address (MAILTOURL only).</td>
114</tr>
115<tr valign=top>
116<td align=center><a name="TOADDRDOMAIN" href="../rcvars.html#TOADDRDOMAIN"><strong><code>$TOADDRDOMAIN$</code></strong></a></td>
117<td>The e-mail address domain (MAILTOURL only).</td>
118</tr>
119<tr valign=top>
120<td align=center><a name="TOADDRNAME" href="../rcvars.html#TOADDRNAME"><strong><code>$TOADDRNAME$</code></strong></a></td>
121<td>The e-mail address "username" (or local-part) (MAILTOURL only).</td>
122</tr>
123</table>
124
125<!-- *************************************************************** -->
126<hr>
127<h2>Examples</h2>
128
129<p>The following example defines how MAILTOURL can be used
130to have e-mail addresses linked to a CGI program:
131</p>
132
133<pre>
134<b>&lt;MailToURL&gt;</b>
135/cgi-bin/mailform.cgi?to=$TO$;subject=$SUBJECT$;srcid=$MSGID$
136<b>&lt;/MailToURL&gt;</b>
137</pre>
138
139<!-- *************************************************************** -->
140<hr>
141<h2>Version</h2>
142
143<p>1.0
144</p>
145
146<!-- *************************************************************** -->
147<hr>
148<h2>See Also</h2>
149
150<p>
151<a href="mailto.html">MAILTO</a>
152</p>
153
154<!-- *************************************************************** -->
155<hr>
156<!--x-rc-nav-->
157<table border=0><tr valign="top">
158<td align="left" width="50%">[Prev:&nbsp;<a href="mailto.html">MAILTO</a>]</td><td><nobr>[<a href="../resources.html#mailtourl">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="main.html">MAIN</a>]</td></tr></table>
159<!--/x-rc-nav-->
160<hr>
161<address>
162$Date: 2002/07/27 05:13:10 $ <br>
163<img align="top" src="../monicon.png" alt="">
164<a href="http://www.mhonarc.org/"><strong>MHonArc</strong></a><br>
165Copyright &#169; 1997-1998, <a href="http://www.earlhood.com/">Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org">mhonarc@mhonarc.org</a><br>
166</address>
167
168</body>
169</html>