# <mail>

[This is preliminary documentation and subject to change.]

Sends an SMTP message.

Text and text files to include in the message body may be specified as well as binary attachments.

### Parameters

Attribute | Type | Description | Required
--- | --- | --- | ---
from | string | Email address of sender. | True
bcclist | string | Semicolon-separated list of BCC: recipient email addresses. | False
cclist | string | Semicolon-separated list of CC: recipient email addresses. | False
format | MailFormat | Format of the message. The default is `Text`. | False
mailhost | string | Host name of mail server. The default is `localhost`. | False
message | string | Text to send in body of email message. | False
subject | string | Text to send in subject line of email message. | False
tolist | string | Semicolon-separated list of recipient email addresses. | False
failonerror | bool | Determines if task failure stops the build, or is just reported. The default is true. | False
if | bool | If true then the task will be executed; otherwise, skipped. The default is true. | False
unless | bool | Opposite of `if`. If false then the task will be executed; otherwise, skipped. The default is false. | False
verbose | bool | Determines whether the task should report detailed build log messages. The default is false. | False

### Nested Elements:

#### <files>

Files that are transmitted as part of the body of the email message.

#### </files>

#### <attachments>

Attachments that are transmitted with the message.

#### </attachments>

### Examples

- Sends an email from `nant@sourceforge.net` to three recipients with a subject about the attachments. The body of the message will be the combined contents of all `.txt` files in the base directory. All zip files in the base directory will be included as attachments. The message will be sent using the `smtpserver.anywhere.com` SMTP server.

                  <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>

### Requirements

Assembly: NAnt.Core (0.91.3881.0)