diff options
Diffstat (limited to 'framework/src/ant/apache-ant-1.9.6/manual/Tasks/mimemail.html')
| -rw-r--r-- | framework/src/ant/apache-ant-1.9.6/manual/Tasks/mimemail.html | 115 |
1 files changed, 115 insertions, 0 deletions
diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/mimemail.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/mimemail.html new file mode 100644 index 00000000..ba066a6b --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/mimemail.html @@ -0,0 +1,115 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<head> +<meta http-equiv="Content-Language" content="en-us"> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>MimeMail Task</title> +</head> + +<body> + +<h2><a name="mimemail">MimeMail</a></h2> + +<h3><i>Deprecated</i></h3> +<p><i>This task has been deprecated. Use the <a href="../Tasks/mail.html">mail</a> task instead.</i></p> + +<h3>Description</h3> +<p>Sends SMTP mail with MIME attachments. +<a href="http://www.oracle.com/technetwork/java/index-138643.html">JavaMail</a> +and <a href="http://www.oracle.com/technetwork/java/javase/jaf-135115.html">Java +Activation Framework</a> are required for this task.</p> +<p>Multiple files can be attached using <a href="../Types/fileset.html">FileSets.</a></p> +<h3>Parameters</h3> +<table border="1" cellpadding="2" cellspacing="0"> + <tr> + <td valign="top"><b>Attribute</b></td> + <td valign="top"><b>Description</b></td> + <td align="center" valign="top"><b>Required</b></td> + </tr> + <tr> + <td valign="top">message</td> + <td valign="top">The message body</td> + <td valign="top" align="center" rowspan="2">No, but only one of of 'message' or + 'messageFile' may be specified. If not specified, a fileset must be + provided.</td> + </tr> + <tr> + <td valign="top">messageFile</td> + <td valign="top">A filename to read and used as the message body</td> + </tr> + <tr> + <td valign="top">messageMimeType</td> + <td valign="top">MIME type to use for 'message' or 'messageFile' when + attached.</td> + <td align="center" valign="top">No, defaults to "text/plain"</td> + </tr> + <tr> + <td valign="top">tolist</td> + <td valign="top">Comma-separated list of To: recipients</td> + <td valign="top" align="center" rowspan="3">Yes, at least one of 'tolist', 'cclist', + or 'bcclist' must be specified.</td> + </tr> + <tr> + <td valign="top">cclist</td> + <td valign="top">Comma-separated list of CC: recipients</td> + <td valign="top" align="center"> </td> + </tr> + <tr> + <td valign="top">bcclist</td> + <td valign="top">Comma-separated list of BCC: recipients</td> + <td valign="top" align="center"> </td> + </tr> + <tr> + <td valign="top">mailhost</td> + <td valign="top">Host name of the mail server.</td> + <td valign="top" align="center">No, default to "localhost"</td> + </tr> + <tr> + <td valign="top">subject</td> + <td valign="top">Email subject line.</td> + <td valign="top" align="center">No</td> + </tr> + <tr> + <td valign="top">from</td> + <td valign="top">Email address of sender.</td> + <td valign="top" align="center">Yes</td> + </tr> + <tr> + <td valign="top">failonerror</td> + <td valign="top">Stop the build process if an error occurs sending the + e-mail.</td> + <td valign="top" align="center">No, default to "true"</td> + </tr> +</table> +<h3>Examples</h3> +<p><b>Send a single HTML file as the body of a message</b></p> +<pre> <mimemail messageMimeType="text/html" messageFile="overview-summary.html" + tolist="you" subject="JUnit Test Results: ${TODAY}" from="me"/></pre> +<p><b>Sends all files in a directory as attachments</b></p> +<pre> <mimemail message="See attached files" tolist="you" subject="Attachments" from="me"> + <fileset dir="."> + <include name="dist/*.*"/> + </fileset> + </mimemail> +</pre> + + +</body> +</html> + |