| 1 | <html>
|
|---|
| 2 |
|
|---|
| 3 | <head>
|
|---|
| 4 | <meta http-equiv="Content-Language" content="en-us">
|
|---|
| 5 | <title>MimeMail Task</title>
|
|---|
| 6 | <link rel="stylesheet" type="text/css" href="../stylesheets/antmanual.css">
|
|---|
| 7 | </head>
|
|---|
| 8 |
|
|---|
| 9 | <body>
|
|---|
| 10 |
|
|---|
| 11 | <h2><a name="mimemail">MimeMail</a></h2>
|
|---|
| 12 |
|
|---|
| 13 | <h3><i>Deprecated</i></h3>
|
|---|
| 14 | <p><i>This task has been deprecated. Use the <a href="../CoreTasks/mail.html">mail</a> task instead.</i></p>
|
|---|
| 15 |
|
|---|
| 16 | <h3>Description</h3>
|
|---|
| 17 | <p>Sends SMTP mail with MIME attachments.
|
|---|
| 18 | <a href="http://java.sun.com/products/javamail/index.html">JavaMail</a>
|
|---|
| 19 | and <a href="http://java.sun.com/products/javabeans/glasgow/jaf.html">Java
|
|---|
| 20 | Activation Framework</a> are required for this task.</p>
|
|---|
| 21 | <p>Multiple files can be attached using <a href="../CoreTypes/fileset.html">FileSets.</a></p>
|
|---|
| 22 | <h3>Parameters</h3>
|
|---|
| 23 | <table border="1" cellpadding="2" cellspacing="0">
|
|---|
| 24 | <tr>
|
|---|
| 25 | <td valign="top"><b>Attribute</b></td>
|
|---|
| 26 | <td valign="top"><b>Description</b></td>
|
|---|
| 27 | <td align="center" valign="top"><b>Required</b></td>
|
|---|
| 28 | </tr>
|
|---|
| 29 | <tr>
|
|---|
| 30 | <td valign="top">message</td>
|
|---|
| 31 | <td valign="top">The message body</td>
|
|---|
| 32 | <td valign="top" align="center" rowspan="2">No, but only one of of 'message' or
|
|---|
| 33 | 'messageFile' may be specified. If not specified, a fileset must be
|
|---|
| 34 | provided.</td>
|
|---|
| 35 | </tr>
|
|---|
| 36 | <tr>
|
|---|
| 37 | <td valign="top">messageFile</td>
|
|---|
| 38 | <td valign="top">A filename to read and used as the message body</td>
|
|---|
| 39 | </tr>
|
|---|
| 40 | <tr>
|
|---|
| 41 | <td valign="top">messageMimeType</td>
|
|---|
| 42 | <td valign="top">MIME type to use for 'message' or 'messageFile' when
|
|---|
| 43 | attached.</td>
|
|---|
| 44 | <td align="center" valign="top">No, defaults to "text/plain"</td>
|
|---|
| 45 | </tr>
|
|---|
| 46 | <tr>
|
|---|
| 47 | <td valign="top">tolist</td>
|
|---|
| 48 | <td valign="top">Comma-separated list of To: recipients</td>
|
|---|
| 49 | <td valign="top" align="center" rowspan="3">Yes, at least one of 'tolist', 'cclist',
|
|---|
| 50 | or 'bcclist' must be specified.</td>
|
|---|
| 51 | </tr>
|
|---|
| 52 | <tr>
|
|---|
| 53 | <td valign="top">cclist</td>
|
|---|
| 54 | <td valign="top">Comma-separated list of CC: recipients</td>
|
|---|
| 55 | <td valign="top" align="center"> </td>
|
|---|
| 56 | </tr>
|
|---|
| 57 | <tr>
|
|---|
| 58 | <td valign="top">bcclist</td>
|
|---|
| 59 | <td valign="top">Comma-separated list of BCC: recipients</td>
|
|---|
| 60 | <td valign="top" align="center"> </td>
|
|---|
| 61 | </tr>
|
|---|
| 62 | <tr>
|
|---|
| 63 | <td valign="top">mailhost</td>
|
|---|
| 64 | <td valign="top">Host name of the mail server.</td>
|
|---|
| 65 | <td valign="top" align="center">No, default to "localhost"</td>
|
|---|
| 66 | </tr>
|
|---|
| 67 | <tr>
|
|---|
| 68 | <td valign="top">subject</td>
|
|---|
| 69 | <td valign="top">Email subject line.</td>
|
|---|
| 70 | <td valign="top" align="center">No</td>
|
|---|
| 71 | </tr>
|
|---|
| 72 | <tr>
|
|---|
| 73 | <td valign="top">from</td>
|
|---|
| 74 | <td valign="top">Email address of sender.</td>
|
|---|
| 75 | <td valign="top" align="center">Yes</td>
|
|---|
| 76 | </tr>
|
|---|
| 77 | <tr>
|
|---|
| 78 | <td valign="top">failonerror</td>
|
|---|
| 79 | <td valign="top">Stop the build process if an error occurs sending the
|
|---|
| 80 | e-mail.</td>
|
|---|
| 81 | <td valign="top" align="center">No, default to "true"</td>
|
|---|
| 82 | </tr>
|
|---|
| 83 | </table>
|
|---|
| 84 | <h3>Examples</h3>
|
|---|
| 85 | <p><b>Send a single HTML file as the body of a message</b></p>
|
|---|
| 86 | <pre> <mimemail messageMimeType="text/html" messageFile="overview-summary.html"
|
|---|
| 87 | tolist="you" subject="JUnit Test Results: ${TODAY}" from="me"/></pre>
|
|---|
| 88 | <p><b>Sends all files in a directory as attachments</b></p>
|
|---|
| 89 | <pre> <mimemail message="See attached files" tolist="you" subject="Attachments" from="me">
|
|---|
| 90 | <fileset dir=".">
|
|---|
| 91 | <include name="dist/*.*"/>
|
|---|
| 92 | </fileset>
|
|---|
| 93 | </mimemail>
|
|---|
| 94 | </pre>
|
|---|
| 95 | <hr><p align="center">Copyright © 2001-2002,2004 The Apache Software Foundation. All rights
|
|---|
| 96 | Reserved.</p>
|
|---|
| 97 |
|
|---|
| 98 | </body>
|
|---|
| 99 | </html>
|
|---|
| 100 |
|
|---|
