<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<!-- Documenting T:NAnt.Core.Tasks.MailTask-->
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title><mail> Task</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a href="http://nant.sourceforge.net">
<b>NAnt</b>
</a>
<img alt="->" src="../images/arrow.gif" />
<a href="../index.html">Help</a>
<img alt="->" src="../images/arrow.gif" />
<a href="../tasks/index.html">Task Reference</a>
<img alt="->" src="../images/arrow.gif" /> <mail></td>
<td class="NavBar-Cell" align="right">
v0.92</td>
</tr>
</table>
<h1><mail></h1>
<p> Sends an SMTP message. </p>
<p> Text and text files to include in the message body may be specified as well as binary attachments. </p>
<h3>Parameters</h3>
<div class="table">
<table>
<tr>
<th>Attribute</th>
<th style="text-align: center;">Type</th>
<th>Description</th>
<th style="text-align: center;">Required</th>
</tr>
<tr>
<td valign="top" class="required">from</td>
<td style="text-align: center;">string</td>
<td> Email address of sender. </td>
<td style="text-align: center;">True</td>
</tr>
<tr>
<td valign="top">bcclist</td>
<td style="text-align: center;">string</td>
<td> Semicolon-separated list of BCC: recipient email addresses. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">cclist</td>
<td style="text-align: center;">string</td>
<td> Semicolon-separated list of CC: recipient email addresses. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">format</td>
<td style="text-align: center;">
<a href="../enums/NAnt.Core.Tasks.MailTask.MailFormat.html">MailFormat</a>
</td>
<td>
<i>Deprecated.</i> Format of the message. The default is <code>Text</code>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">isbodyhtml</td>
<td style="text-align: center;">bool</td>
<td> Indicates whether or not the body of the email is in html format. The default value is <code>false</code>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">mailhost</td>
<td style="text-align: center;">string</td>
<td> Host name of mail server. The default is <code>localhost</code>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">mailport</td>
<td style="text-align: center;">int</td>
<td> The port number used to connect to the mail server. The default is <code>25</code>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">message</td>
<td style="text-align: center;">string</td>
<td> Text to send in body of email message. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">password</td>
<td style="text-align: center;">string</td>
<td> The password to use when connecting to the smtp host. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">replyto</td>
<td style="text-align: center;">string</td>
<td> Reply to email address. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">ssl</td>
<td style="text-align: center;">bool</td>
<td> Indicates whether or not ssl should be used to connect to the smtp host. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">subject</td>
<td style="text-align: center;">string</td>
<td> Text to send in subject line of email message. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">tolist</td>
<td style="text-align: center;">string</td>
<td> Semicolon-separated list of recipient email addresses. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">user</td>
<td style="text-align: center;">string</td>
<td> The username to use when connecting to the smtp host. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">failonerror</td>
<td style="text-align: center;">bool</td>
<td> Determines if task failure stops the build, or is just reported. The default is <b>true</b>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">if</td>
<td style="text-align: center;">bool</td>
<td> If <b>true</b> then the task will be executed; otherwise, skipped. The default is <b>true</b>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">unless</td>
<td style="text-align: center;">bool</td>
<td> Opposite of <code>if</code>. If <b>false</b> then the task will be executed; otherwise, skipped. The default is <b>false</b>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">verbose</td>
<td style="text-align: center;">bool</td>
<td> Determines whether the task should report detailed build log messages. The default is <b>false</b>. </td>
<td style="text-align: center;">False</td>
</tr>
</table>
</div>
<h3>Nested Elements:</h3>
<!--Element-->
<h4>
<a id="files">
</a>
<<a href="../types/fileset.html">files</a>>
</h4>
<div class="nested-element"> Files that are transmitted as part of the body of the email message. <p /></div>
<h4>
<a id="files">
</a>
</<a href="../types/fileset.html">files</a>>
</h4>
<!--Element-->
<h4>
<a id="attachments">
</a>
<<a href="../types/fileset.html">attachments</a>>
</h4>
<div class="nested-element"> Attachments that are transmitted with the message. <p /></div>
<h4>
<a id="attachments">
</a>
</<a href="../types/fileset.html">attachments</a>>
</h4>
<h3>Examples</h3>
<ul class="examples">
<li>
<p> Sends an email from <code>nant@sourceforge.net</code> to three recipients with a subject about the attachments. The body of the message will be the combined contents of all <code>.txt</code> files in the base directory. All zip files in the base directory will be included as attachments. The message will be sent using the <code>smtpserver.anywhere.com</code> SMTP server. </p>
<pre class="code">
<mail
from="nant@sourceforge.net"
tolist="recipient1@sourceforge.net"
cclist="recipient2@sourceforge.net"
bcclist="recipient3@sourceforge.net"
subject="Msg 7: With attachments"
mailhost="smtpserver.anywhere.com">
<files>
<include name="*.txt" />
</files>
<attachments>
<include name="*.zip" />
</attachments>
</mail>
</pre>
</li>
<li>
<p> Sends an email from a gmail account to multiple recipients. This example illustrates how to add a recipient's name to an email address. </p>
<pre class="code">
<mail
from="+xxxx+@gmail.com"
tolist="(Rep A) recipient1@sourceforge.net;(Rep B) recipient2@sourceforge.net"
subject="Sample Email"
mailhost="smtp.gmail.com"
mailport="465"
ssl="true"
user="+xxxx+@gmail.com"
password="p@ssw0rd!"
message="Email from NAnt" />
</pre>
<p> Email addresses in any of the lists (to, cc, bcc, from) can be in one of the five listed formats below. </p>
<ul style="list-style-type: disc;">
<li>Full Name <address@abcxyz.com></li>
<li><address@abcxyz.com> Full Name</li>
<li>(Full Name) address@abcxyz.com</li>
<li>address@abcxyz.com (Full Name)</li>
<li>address@abcxyz.com</li>
</ul>
<p> Remember to use &gt; and &lt; XML entities for the angle brackets. </p>
</li>
</ul>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.92.4543.0)
</div>
</body>
</html>
