src/main/org/apache/tools/ant/taskdefs/email/Mailer.java

/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2002 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Ant", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */
package org.apache.tools.ant.taskdefs.email;

import java.util.Vector;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Task;

/**
 * Base class for the various emailing implementations.
 *
 * @author roxspring@yahoo.com Rob Oxspring
 * @since 1.5
 */
abstract class Mailer
{
    protected String host = null;
    protected int port = -1;
    protected Message message;
    protected EmailAddress from;
    protected Vector toList = null;
    protected Vector ccList = null;
    protected Vector bccList = null;
    protected Vector files = null;
    protected String subject = null;
    protected Task task;
    protected boolean includeFileNames = false;

    /** sets the mail server
     * @param host
     */
    public void setHost( String host )
    {
        this.host = host;
    }

    /** sets the smtp port
     * @param port
     */
    public void setPort( int port )
    {
        this.port = port;
    }

    /** sets the message
     * @param m
     */
    public void setMessage( Message m )
    {
        this.message = m;
    }

    /** sets the address to send from
     * @param from
     */
    public void setFrom( EmailAddress from )
    {
        this.from = from;
    }

    /** set the to addresses
     * @param list
     */
    public void setToList( Vector list )
    {
        this.toList = list;
    }

    /** sets the cc addresses
     * @param list
     */
    public void setCcList( Vector list )
    {
        this.ccList = list;
    }

    /** sets the bcc addresses
     * @param list
     */
    public void setBccList( Vector list )
    {
        this.bccList = list;
    }

    /** sets the files to attach
     * @param files
     */
    public void setFiles( Vector files )
    {
        this.files = files;
    }

    /** sets the subject
     * @param subject
     */
    public void setSubject( String subject )
    {
        this.subject = subject;
    }

    /** sets the owning task
     * @param task
     */
    public void setTask( Task task )
    {
        this.task = task;
    }

    /** indicates whether filenames should be listed in the body
     * @param b
     */
    public void setIncludeFileNames( boolean b )
    {
        this.includeFileNames = b;
    }

    /** This method should send the email
     * @throws BuildException
     */
    public abstract void send()
        throws BuildException;
}