| 1 | <!--
|
|---|
| 2 | Licensed to the Apache Software Foundation (ASF) under one or more
|
|---|
| 3 | contributor license agreements. See the NOTICE file distributed with
|
|---|
| 4 | this work for additional information regarding copyright ownership.
|
|---|
| 5 | The ASF licenses this file to You under the Apache License, Version 2.0
|
|---|
| 6 | (the "License"); you may not use this file except in compliance with
|
|---|
| 7 | the License. You may obtain a copy of the License at
|
|---|
| 8 |
|
|---|
| 9 | http://www.apache.org/licenses/LICENSE-2.0
|
|---|
| 10 |
|
|---|
| 11 | Unless required by applicable law or agreed to in writing, software
|
|---|
| 12 | distributed under the License is distributed on an "AS IS" BASIS,
|
|---|
| 13 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|---|
| 14 | See the License for the specific language governing permissions and
|
|---|
| 15 | limitations under the License.
|
|---|
| 16 | -->
|
|---|
| 17 | <html>
|
|---|
| 18 |
|
|---|
| 19 | <head>
|
|---|
| 20 | <meta http-equiv="Content-Language" content="en-us">
|
|---|
| 21 | <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
|---|
| 22 | <title>MimeMail Task</title>
|
|---|
| 23 | </head>
|
|---|
| 24 |
|
|---|
| 25 | <body>
|
|---|
| 26 |
|
|---|
| 27 | <h2><a name="mimemail">MimeMail</a></h2>
|
|---|
| 28 |
|
|---|
| 29 | <h3><i>Deprecated</i></h3>
|
|---|
| 30 | <p><i>This task has been deprecated. Use the <a href="../CoreTasks/mail.html">mail</a> task instead.</i></p>
|
|---|
| 31 |
|
|---|
| 32 | <h3>Description</h3>
|
|---|
| 33 | <p>Sends SMTP mail with MIME attachments.
|
|---|
| 34 | <a href="http://java.sun.com/products/javamail/index.html">JavaMail</a>
|
|---|
| 35 | and <a href="http://java.sun.com/products/javabeans/glasgow/jaf.html">Java
|
|---|
| 36 | Activation Framework</a> are required for this task.</p>
|
|---|
| 37 | <p>Multiple files can be attached using <a href="../CoreTypes/fileset.html">FileSets.</a></p>
|
|---|
| 38 | <h3>Parameters</h3>
|
|---|
| 39 | <table border="1" cellpadding="2" cellspacing="0">
|
|---|
| 40 | <tr>
|
|---|
| 41 | <td valign="top"><b>Attribute</b></td>
|
|---|
| 42 | <td valign="top"><b>Description</b></td>
|
|---|
| 43 | <td align="center" valign="top"><b>Required</b></td>
|
|---|
| 44 | </tr>
|
|---|
| 45 | <tr>
|
|---|
| 46 | <td valign="top">message</td>
|
|---|
| 47 | <td valign="top">The message body</td>
|
|---|
| 48 | <td valign="top" align="center" rowspan="2">No, but only one of of 'message' or
|
|---|
| 49 | 'messageFile' may be specified. If not specified, a fileset must be
|
|---|
| 50 | provided.</td>
|
|---|
| 51 | </tr>
|
|---|
| 52 | <tr>
|
|---|
| 53 | <td valign="top">messageFile</td>
|
|---|
| 54 | <td valign="top">A filename to read and used as the message body</td>
|
|---|
| 55 | </tr>
|
|---|
| 56 | <tr>
|
|---|
| 57 | <td valign="top">messageMimeType</td>
|
|---|
| 58 | <td valign="top">MIME type to use for 'message' or 'messageFile' when
|
|---|
| 59 | attached.</td>
|
|---|
| 60 | <td align="center" valign="top">No, defaults to "text/plain"</td>
|
|---|
| 61 | </tr>
|
|---|
| 62 | <tr>
|
|---|
| 63 | <td valign="top">tolist</td>
|
|---|
| 64 | <td valign="top">Comma-separated list of To: recipients</td>
|
|---|
| 65 | <td valign="top" align="center" rowspan="3">Yes, at least one of 'tolist', 'cclist',
|
|---|
| 66 | or 'bcclist' must be specified.</td>
|
|---|
| 67 | </tr>
|
|---|
| 68 | <tr>
|
|---|
| 69 | <td valign="top">cclist</td>
|
|---|
| 70 | <td valign="top">Comma-separated list of CC: recipients</td>
|
|---|
| 71 | <td valign="top" align="center"> </td>
|
|---|
| 72 | </tr>
|
|---|
| 73 | <tr>
|
|---|
| 74 | <td valign="top">bcclist</td>
|
|---|
| 75 | <td valign="top">Comma-separated list of BCC: recipients</td>
|
|---|
| 76 | <td valign="top" align="center"> </td>
|
|---|
| 77 | </tr>
|
|---|
| 78 | <tr>
|
|---|
| 79 | <td valign="top">mailhost</td>
|
|---|
| 80 | <td valign="top">Host name of the mail server.</td>
|
|---|
| 81 | <td valign="top" align="center">No, default to "localhost"</td>
|
|---|
| 82 | </tr>
|
|---|
| 83 | <tr>
|
|---|
| 84 | <td valign="top">subject</td>
|
|---|
| 85 | <td valign="top">Email subject line.</td>
|
|---|
| 86 | <td valign="top" align="center">No</td>
|
|---|
| 87 | </tr>
|
|---|
| 88 | <tr>
|
|---|
| 89 | <td valign="top">from</td>
|
|---|
| 90 | <td valign="top">Email address of sender.</td>
|
|---|
| 91 | <td valign="top" align="center">Yes</td>
|
|---|
| 92 | </tr>
|
|---|
| 93 | <tr>
|
|---|
| 94 | <td valign="top">failonerror</td>
|
|---|
| 95 | <td valign="top">Stop the build process if an error occurs sending the
|
|---|
| 96 | e-mail.</td>
|
|---|
| 97 | <td valign="top" align="center">No, default to "true"</td>
|
|---|
| 98 | </tr>
|
|---|
| 99 | </table>
|
|---|
| 100 | <h3>Examples</h3>
|
|---|
| 101 | <p><b>Send a single HTML file as the body of a message</b></p>
|
|---|
| 102 | <pre> <mimemail messageMimeType="text/html" messageFile="overview-summary.html"
|
|---|
| 103 | tolist="you" subject="JUnit Test Results: ${TODAY}" from="me"/></pre>
|
|---|
| 104 | <p><b>Sends all files in a directory as attachments</b></p>
|
|---|
| 105 | <pre> <mimemail message="See attached files" tolist="you" subject="Attachments" from="me">
|
|---|
| 106 | <fileset dir=".">
|
|---|
| 107 | <include name="dist/*.*"/>
|
|---|
| 108 | </fileset>
|
|---|
| 109 | </mimemail>
|
|---|
| 110 | </pre>
|
|---|
| 111 |
|
|---|
| 112 |
|
|---|
| 113 | </body>
|
|---|
| 114 | </html>
|
|---|
| 115 |
|
|---|
