Class Mailer
java.lang.Object
org.apache.tools.ant.taskdefs.email.Mailer
- Direct Known Subclasses:
MimeMailer
Base class for the various emailing implementations.
- Since:
- Ant 1.5
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Vector<EmailAddress>protected Vector<EmailAddress>protected EmailAddressprotected Stringprotected booleanprotected Messageprotected Stringprotected intprotected Vector<EmailAddress>protected booleanprotected Stringprotected Taskprotected Vector<EmailAddress>protected String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected final StringgetDate()Return the current Date in a format suitable for a SMTP date header.protected booleanWhether the port has been explicitly specified by the user.protected booleanabstract voidsend()Send the email.voidsetBccList(Vector<EmailAddress> list) Set the bcc addresses.voidsetCcList(Vector<EmailAddress> list) Set the cc addresses.voidsetEnableStartTLS(boolean b) Set whether to allow authentication to switch to a TLS connection via STARTTLS.voidSet the files to attach.voidsetFrom(EmailAddress from) Set the address to send from.voidsetHeaders(Vector<Header> v) Set the generic headers to add to the email.voidSet the mail server.voidsetIgnoreInvalidRecipients(boolean b) Whether invalid recipients should be ignored (but a warning will be logged) instead of making the task fail.voidsetIncludeFileNames(boolean b) Indicate whether filenames should be listed in the body.voidSet the message.voidsetPassword(String password) Set the password for smtp auth.voidsetPort(int port) Set the smtp port.voidsetPortExplicitlySpecified(boolean explicit) Whether the port has been explicitly specified by the user.voidsetReplyToList(Vector<EmailAddress> list) Set the replyTo addresses.voidsetSSL(boolean ssl) Set whether to send the mail through SSL.voidsetSubject(String subject) Set the subject.voidSet the owning task.voidsetToList(Vector<EmailAddress> list) Set the to addresses.voidSet the user for smtp auth.protected booleanWhether invalid recipients should be ignored.
-
Field Details
-
host
-
port
protected int port -
user
-
password
-
SSL
protected boolean SSL -
message
-
from
-
replyToList
-
toList
-
ccList
-
bccList
-
files
-
subject
-
task
-
includeFileNames
protected boolean includeFileNames -
headers
-
-
Constructor Details
-
Mailer
public Mailer()
-
-
Method Details
-
setHost
Set the mail server.- Parameters:
host- the mail server name.
-
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.- Parameters:
explicit- boolean- Since:
- Ant 1.8.2
-
isPortExplicitlySpecified
protected boolean isPortExplicitlySpecified()Whether the port has been explicitly specified by the user.- Returns:
- boolean
- Since:
- Ant 1.8.2
-
setUser
Set the user for smtp auth.- Parameters:
user- the username.- Since:
- Ant 1.6
-
setPassword
Set the password for smtp auth.- Parameters:
password- the authentication password.- 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
-
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
-
isStartTLSEnabled
protected boolean isStartTLSEnabled() -
setMessage
Set the message.- Parameters:
m- the message content.
-
setFrom
Set the address to send from.- Parameters:
from- the sender.
-
setReplyToList
Set the replyTo addresses.- Parameters:
list- a vector of replyTo addresses.- Since:
- Ant 1.6
-
setToList
Set the to addresses.- Parameters:
list- a vector of recipient addresses.
-
setCcList
Set the cc addresses.- Parameters:
list- a vector of cc addresses.
-
setBccList
Set the bcc addresses.- Parameters:
list- a vector of the bcc addresses.
-
setFiles
Set the files to attach.- Parameters:
files- list of files to attach to the email.
-
setSubject
Set the subject.- Parameters:
subject- the subject line.
-
setTask
Set the owning task.- Parameters:
task- the owning task instance.
-
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.
-
setHeaders
Set the generic headers to add to the email.- Parameters:
v- a Vector presumed to contain Header objects.- Since:
- Ant 1.7
-
send
Send the email.- Throws:
BuildException- if the email can't be sent.
-
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.
- Parameters:
b- boolean- Since:
- Ant 1.8.0
-
shouldIgnoreInvalidRecipients
protected boolean shouldIgnoreInvalidRecipients()Whether invalid recipients should be ignored.- Returns:
- boolean
- Since:
- Ant 1.8.0
-
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
-