Mailer

java.lang.Object
- org.apache.tools.ant.taskdefs.email.Mailer

```
public abstract class Mailer
extends Object
```
Base class for the various emailing implementations.

Since:

Ant 1.5

Field Summary

Fields
Modifier and Type	Field and Description
`protected Vector<EmailAddress>`	`bccList`
`protected Vector<EmailAddress>`	`ccList`
`protected Vector<File>`	`files`
`protected EmailAddress`	`from`
`protected Vector<Header>`	`headers`
`protected String`	`host`
`protected boolean`	`includeFileNames`
`protected Message`	`message`
`protected String`	`password`
`protected int`	`port`
`protected Vector<EmailAddress>`	`replyToList`
`protected boolean`	`SSL`
`protected String`	`subject`
`protected Task`	`task`
`protected Vector<EmailAddress>`	`toList`
`protected String`	`user`

Constructor Summary

Constructors
Constructor and Description

Mailer()

Constructors
Constructor and Description
`Mailer()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected String`	`getDate()` Return the current Date in a format suitable for a SMTP date header.
`protected boolean`	`isPortExplicitlySpecified()` Whether the port has been explicitly specified by the user.
`protected boolean`	`isStartTLSEnabled()`
`abstract void`	`send()` Send the email.
`void`	`setBccList(Vector<EmailAddress> list)` Set the bcc addresses.
`void`	`setCcList(Vector<EmailAddress> list)` Set the cc addresses.
`void`	`setEnableStartTLS(boolean b)` Set whether to allow authentication to switch to a TLS connection via STARTTLS.
`void`	`setFiles(Vector<File> files)` Set the files to attach.
`void`	`setFrom(EmailAddress from)` Set the address to send from.
`void`	`setHeaders(Vector<Header> v)` Set the generic headers to add to the email.
`void`	`setHost(String host)` Set the mail server.
`void`	`setIgnoreInvalidRecipients(boolean b)` Whether invalid recipients should be ignored (but a warning will be logged) instead of making the task fail.
`void`	`setIncludeFileNames(boolean b)` Indicate whether filenames should be listed in the body.
`void`	`setMessage(Message m)` Set the message.
`void`	`setPassword(String password)` Set the password for smtp auth.
`void`	`setPort(int port)` Set the smtp port.
`void`	`setPortExplicitlySpecified(boolean explicit)` Whether the port has been explicitly specified by the user.
`void`	`setReplyToList(Vector<EmailAddress> list)` Set the replyto addresses.
`void`	`setSSL(boolean ssl)` Set whether to send the mail through SSL.
`void`	`setSubject(String subject)` Set the subject.
`void`	`setTask(Task task)` Set the owning task.
`void`	`setToList(Vector<EmailAddress> list)` Set the to addresses.
`void`	`setUser(String user)` Set the user for smtp auth.
`protected boolean`	`shouldIgnoreInvalidRecipients()` Whether invalid recipients should be ignored.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - bccList
```
protected Vector<EmailAddress> bccList
```
  - ccList
```
protected Vector<EmailAddress> ccList
```
  - files
```
protected Vector<File> files
```
  - from
```
protected EmailAddress from
```
  - headers
```
protected Vector<Header> headers
```
  - host
```
protected String host
```
  - includeFileNames
```
protected boolean includeFileNames
```
  - message
```
protected Message message
```
  - password
```
protected String password
```
  - port
```
protected int port
```
  - replyToList
```
protected Vector<EmailAddress> replyToList
```
  - SSL
```
protected boolean SSL
```
  - subject
```
protected String subject
```
  - task
```
protected Task task
```
  - toList
```
protected Vector<EmailAddress> toList
```
  - user
```
protected String user
```
- Constructor Detail
  - Mailer
```
public Mailer()
```
- Method Detail
  - getDate
```
protected final String getDate()
```
    Return the current Date in a format suitable for a SMTP date header.
    
    Returns:
    
    the current date in SMTP suitable format.
    
    Since:
    
    Ant 1.5
  - isPortExplicitlySpecified
```
protected boolean isPortExplicitlySpecified()
```
    Whether the port has been explicitly specified by the user.
    
    Since:
    
    Ant 1.8.2
  - isStartTLSEnabled
```
protected boolean isStartTLSEnabled()
```
  - send
```
public abstract void send()
                   throws BuildException
```
    Send the email.
    
    Throws:
    
    BuildException - if the email can't be sent.
  - setBccList
```
public void setBccList(Vector<EmailAddress> list)
```
    Set the bcc addresses.
    
    Parameters:
    
    list - a vector of the bcc addresses.
  - setCcList
```
public void setCcList(Vector<EmailAddress> list)
```
    Set the cc addresses.
    
    Parameters:
    
    list - a vector of cc addresses.
  - setEnableStartTLS
```
public void setEnableStartTLS(boolean b)
```
    Set whether to allow authentication to switch to a TLS connection via STARTTLS.
    
    Parameters:
    
    b - boolean; if true STARTTLS will be supported.
    
    Since:
    
    Ant 1.8.0
  - setFiles
```
public void setFiles(Vector<File> files)
```
    Set the files to attach.
    
    Parameters:
    
    files - list of files to attach to the email.
  - setFrom
```
public void setFrom(EmailAddress from)
```
    Set the address to send from.
    
    Parameters:
    
    from - the sender.
  - setHeaders
```
public void setHeaders(Vector<Header> v)
```
    Set the generic headers to add to the email.
    
    Parameters:
    
    v - a Vector presumed to contain Header objects.
    
    Since:
    
    Ant 1.7
  - setHost
```
public void setHost(String host)
```
    Set the mail server.
    
    Parameters:
    
    host - the mail server name.
  - setIgnoreInvalidRecipients
```
public void setIgnoreInvalidRecipients(boolean b)
```
    Whether invalid recipients should be ignored (but a warning will be logged) instead of making the task fail.
    Even with this property set to true the task will still fail if the mail couldn't be sent to any recipient at all.
    
    Since:
    
    Ant 1.8.0
  - setIncludeFileNames
```
public void setIncludeFileNames(boolean b)
```
    Indicate whether filenames should be listed in the body.
    
    Parameters:
    
    b - if true list attached file names in the body content.
  - setMessage
```
public void setMessage(Message m)
```
    Set the message.
    
    Parameters:
    
    m - the message content.
  - setPassword
```
public void setPassword(String password)
```
    Set the password for smtp auth.
    
    Parameters:
    
    password - the authentication password.
    
    Since:
    
    Ant 1.6
  - setPort
```
public void setPort(int port)
```
    Set the smtp port.
    
    Parameters:
    
    port - the SMTP port.
  - setPortExplicitlySpecified
```
public void setPortExplicitlySpecified(boolean explicit)
```
    Whether the port has been explicitly specified by the user.
    
    Since:
    
    Ant 1.8.2
  - setReplyToList
```
public void setReplyToList(Vector<EmailAddress> list)
```
    Set the replyto addresses.
    
    Parameters:
    
    list - a vector of reployTo addresses.
    
    Since:
    
    Ant 1.6
  - setSSL
```
public void setSSL(boolean ssl)
```
    Set whether to send the mail through SSL.
    
    Parameters:
    
    ssl - if true use SSL transport.
    
    Since:
    
    Ant 1.6
  - setSubject
```
public void setSubject(String subject)
```
    Set the subject.
    
    Parameters:
    
    subject - the subject line.
  - setTask
```
public void setTask(Task task)
```
    Set the owning task.
    
    Parameters:
    
    task - the owning task instance.
  - setToList
```
public void setToList(Vector<EmailAddress> list)
```
    Set the to addresses.
    
    Parameters:
    
    list - a vector of recipient addresses.
  - setUser
```
public void setUser(String user)
```
    Set the user for smtp auth.
    
    Parameters:
    
    user - the username.
    
    Since:
    
    Ant 1.6
  - shouldIgnoreInvalidRecipients
```
protected boolean shouldIgnoreInvalidRecipients()
```
    Whether invalid recipients should be ignored.
    
    Since:
    
    Ant 1.8.0

Class Mailer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

bccList

ccList

files

from

headers

host

includeFileNames

message

password

port

replyToList

SSL

subject

task

toList

user

Constructor Detail

Mailer

Method Detail

getDate

isPortExplicitlySpecified

isStartTLSEnabled

send

setBccList

setCcList

setEnableStartTLS

setFiles

setFrom

setHeaders

setHost

setIgnoreInvalidRecipients

setIncludeFileNames

setMessage

setPassword

setPort

setPortExplicitlySpecified

setReplyToList

setSSL

setSubject

setTask

setToList

setUser

shouldIgnoreInvalidRecipients