Buffers log messages from DefaultLogger, and sends an e-mail with the results. The following Project properties are used to send the mail.

MailLogger.mailhost [default: localhost] - Mail server to use
MailLogger.port [default: 25] - Default port for SMTP
MailLogger.user [no default] - user name for SMTP auth (requires Java or Jakarta Mail)
MailLogger.password [no default] - password for SMTP auth (requires Java or Jakarta Mail)
MailLogger.ssl [default: false] - on or true if ssl is needed (requires Java or Jakarta Mail)
MailLogger.from [required] - Mail "from" address
MailLogger.from [no default] - Mail "replyto" address(es), comma-separated
MailLogger.failure.notify [default: true] - Send build failure e-mails?
MailLogger.success.notify [default: true] - Send build success e-mails?
MailLogger.failure.to [required if failure mail to be sent] - Address to send failure messages to
MailLogger.success.to [required if success mail to be sent] - Address to send success messages to
MailLogger.failure.cc [no default] - Address to send failure messages to carbon copy (cc)
MailLogger.success.to [no default] - Address to send success messages to carbon copy (cc)
MailLogger.failure.bcc [no default] - Address to send failure messages to blind carbon copy (bcc)
MailLogger.success.bcc [no default] - Address to send success messages to blind carbon copy (bcc)
MailLogger.failure.subject [default: "Build Failure"] - Subject of failed build
MailLogger.success.subject [default: "Build Success"] - Subject of successful build
MailLogger.failure.body [default: none] - fixed text of mail body for a failed build, default is to send the logfile
MailLogger.success.body [default: none] - fixed text of mail body for a successful build, default is to send the logfile
MailLogger.mimeType [default: text/plain] - MIME-Type of email
MailLogger.charset [no default] - character set of email
MailLogger.starttls.enable [default: false] - on or true if STARTTLS should be supported (requires Java or Jakarta Mail)
MailLogger.properties.file [no default] - Filename of properties file that will override other values.

These properties are set using standard Ant property setting mechanisms (<property>, command-line -D, etc). Ant properties can be overridden by specifying the filename of a properties file in the MailLogger.properties.file property . Any properties defined in that file will override Ant properties.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	MailLogger.Values

Field Summary

Modifier and Type	Field and Description
private StringBuffer	buffer Buffer in which the message is constructed prior to sending
private static final String	DEFAULT_MIME_TYPE

Inherited from org.apache.tools.ant.DefaultLogger:: emacsMode err LEFT_COLUMN_SIZE lSep msgOutputLevel out

Access	Constructor and Description
public	MailLogger()

Method Summary

Modifier and Type	Method and Description
public void	buildFinished(BuildEvent the build finished event event) Overrides org.apache.tools.ant.DefaultLogger.buildFinished. Implements org.apache.tools.ant.BuildListener.buildFinished. Sends an e-mail with the log results.
private String	getMailerImplementation()
private String	Returns: The value of the property, or default value. getValue(Map<String, Object> Properties to obtain value from properties, String suffix of property name. "MailLogger." will be prepended internally. name, String value returned if not present in the properties. Set to null to make required. defaultValue) Gets the value of a property.
protected void	log(String the message being logger message) Overrides org.apache.tools.ant.DefaultLogger.log. Receives and buffers log messages.
private void	logBuildException(String reason, BuildException e)
private void	sendMail(MailLogger.Values the various values. values, String mail body message) Send the mail
private void	sendMimeMail(Project current ant project project, MailLogger.Values various values values, String mail body message) Send the mail (MimeMail)
private Vector<EmailAddress>	splitEmailAddresses(String listString)

Inherited from org.apache.tools.ant.DefaultLogger:: buildStarted extractProjectName formatTime getBuildFailedMessage getBuildSuccessfulMessage getMessageOutputLevel getTimestamp messageLogged printMessage setEmacsMode setErrorPrintStream setMessageOutputLevel setOutputPrintStream targetFinished targetStarted taskFinished taskStarted

Field Detail

buffer	back to summary
private StringBuffer buffer Buffer in which the message is constructed prior to sending

DEFAULT_MIME_TYPE	back to summary
private static final String DEFAULT_MIME_TYPE

MailLogger	back to summary
public MailLogger()

Method Detail

buildFinished	back to summary
public void buildFinished(BuildEvent event) Overrides org.apache.tools.ant.DefaultLogger.buildFinished. Implements org.apache.tools.ant.BuildListener.buildFinished. Sends an e-mail with the log results. Parameters event:BuildEvent the build finished event Annotations @Override

buildFinished

back to summary

public void buildFinished(BuildEvent event)

Overrides org.apache.tools.ant.DefaultLogger.buildFinished.

Implements org.apache.tools.ant.BuildListener.buildFinished.

Sends an e-mail with the log results.

Parameters

event:BuildEvent: the build finished event

Annotations

@Override

getMailerImplementation	back to summary
private String getMailerImplementation()

getValue	back to summary
private String getValue(Map<String, Object> properties, String name, String defaultValue) Gets the value of a property. Parameters properties:Map<String, Object> Properties to obtain value from name:String suffix of property name. "MailLogger." will be prepended internally. defaultValue:String value returned if not present in the properties. Set to null to make required. Returns:String The value of the property, or default value.

getValue

back to summary

private String getValue(Map<String, Object> properties, String name, String defaultValue)

Gets the value of a property.

Parameters

properties:Map<String, Object>: Properties to obtain value from
name:String: suffix of property name. "MailLogger." will be prepended internally.
defaultValue:String: value returned if not present in the properties. Set to null to make required.

Returns:String

The value of the property, or default value.

log	back to summary
protected void log(String message) Overrides org.apache.tools.ant.DefaultLogger.log. Receives and buffers log messages. Parameters message:String the message being logger Annotations @Override

log

back to summary

protected void log(String message)

Overrides org.apache.tools.ant.DefaultLogger.log.

Receives and buffers log messages.

Parameters

message:String: the message being logger

Annotations

@Override

logBuildException	back to summary
private void logBuildException(String reason, BuildException e)

sendMail	back to summary
private void sendMail(MailLogger.Values values, String message) throws IOException Send the mail Parameters values:MailLogger.Values the various values. message:String mail body Exceptions IOException: thrown if sending message fails

sendMail

back to summary

private void sendMail(MailLogger.Values values, String message) throws IOException

Send the mail

Parameters

values:MailLogger.Values: the various values.
message:String: mail body

Exceptions

IOException:: thrown if sending message fails

sendMimeMail	back to summary
private void sendMimeMail(Project project, MailLogger.Values values, String message) Send the mail (MimeMail) Parameters project:Project current ant project values:MailLogger.Values various values message:String mail body

sendMimeMail

back to summary

private void sendMimeMail(Project project, MailLogger.Values values, String message)

Send the mail (MimeMail)

Parameters

project:Project: current ant project
values:MailLogger.Values: various values
message:String: mail body

splitEmailAddresses	back to summary
private Vector<EmailAddress> splitEmailAddresses(String listString)

org.apache.tools.ant.listener back to summary

private Class MailLogger.Values

Class Inheritance

extends Object

java.lang.Object
org.apache.tools.ant.listener.MailLogger.Values

Field Summary

Modifier and Type	Field and Description
private String	body
private String	charset
private String	from
private String	mailhost
private String	mimeType
private String	password
private int	port
private String	replytoList
private boolean	ssl
private boolean	starttls
private String	subject
private String	toBccList
private String	toCcList
private String	toList
private String	user

Constructor Summary

Access	Constructor and Description
private	Values()

Method Summary

Modifier and Type	Method and Description
public String	body()
public MailLogger.Values	body(String body)
public String	charset()
public MailLogger.Values	charset(String charset)
public String	from()
public MailLogger.Values	from(String from)
public String	mailhost()
public MailLogger.Values	mailhost(String mailhost)
public String	mimeType()
public MailLogger.Values	mimeType(String mimeType)
public String	password()
public MailLogger.Values	password(String password)
public int	port()
public MailLogger.Values	port(int port)
public String	replytoList()
public MailLogger.Values	replytoList(String replytoList)
public boolean	ssl()
public MailLogger.Values	ssl(boolean ssl)
public boolean	starttls()
public MailLogger.Values	starttls(boolean starttls)
public String	subject()
public MailLogger.Values	subject(String subject)
public String	toBccList()
public MailLogger.Values	toBccList(String toBccList)
public String	toCcList()
public MailLogger.Values	toCcList(String toCcList)
public String	toList()
public MailLogger.Values	toList(String toList)
public String	user()
public MailLogger.Values	user(String user)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

body	back to summary
private String body

charset	back to summary
private String charset

from	back to summary
private String from

mailhost	back to summary
private String mailhost

mimeType	back to summary
private String mimeType

password	back to summary
private String password

port	back to summary
private int port

replytoList	back to summary
private String replytoList

ssl	back to summary
private boolean ssl

starttls	back to summary
private boolean starttls

subject	back to summary
private String subject

toBccList	back to summary
private String toBccList

toCcList	back to summary
private String toCcList

toList	back to summary
private String toList

user	back to summary
private String user

Constructor Detail

Values	back to summary
private Values()

Method Detail

body	back to summary
public String body()

body	back to summary
public MailLogger.Values body(String body)

charset	back to summary
public String charset()

charset	back to summary
public MailLogger.Values charset(String charset)

from	back to summary
public String from()

from	back to summary
public MailLogger.Values from(String from)

mailhost	back to summary
public String mailhost()

mailhost	back to summary
public MailLogger.Values mailhost(String mailhost)

mimeType	back to summary
public String mimeType()

mimeType	back to summary
public MailLogger.Values mimeType(String mimeType)

password	back to summary
public String password()

password	back to summary
public MailLogger.Values password(String password)

port	back to summary
public int port()

port	back to summary
public MailLogger.Values port(int port)

replytoList	back to summary
public String replytoList()

replytoList	back to summary
public MailLogger.Values replytoList(String replytoList)

ssl	back to summary
public boolean ssl()

ssl	back to summary
public MailLogger.Values ssl(boolean ssl)

starttls	back to summary
public boolean starttls()

starttls	back to summary
public MailLogger.Values starttls(boolean starttls)

subject	back to summary
public String subject()

subject	back to summary
public MailLogger.Values subject(String subject)

toBccList	back to summary
public String toBccList()

toBccList	back to summary
public MailLogger.Values toBccList(String toBccList)

toCcList	back to summary
public String toCcList()

toCcList	back to summary
public MailLogger.Values toCcList(String toCcList)

toList	back to summary
public String toList()

toList	back to summary
public MailLogger.Values toList(String toList)

user	back to summary
public String user()

user	back to summary
public MailLogger.Values user(String user)

public Class MailLogger

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class MailLogger.Values

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail