src/java/com/oroinc/net/smtp/SimpleSMTPHeader.java

/***
 * $Id: SimpleSMTPHeader.java,v 1.1 2002/04/03 01:04:37 brekke Exp $
 *
 * NetComponents Internet Protocol Library
 * Copyright (C) 1997-2002  Daniel F. Savarese
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library in the LICENSE file; if not, write
 * to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA  02111-1307  USA
 ***/

package com.oroinc.net.smtp;

/***
 * This class is used to construct a bare minimum
 * acceptable header for an email message.  To construct more
 * complicated headers you should refer to RFC 822.  When the
 * Java Mail API is finalized, you will be
 * able to use it to compose fully compliant Internet text messages.
 * <p>
 * The main purpose of the class is to faciliatate the mail sending
 * process, by relieving the programmer from having to explicitly format
 * a simple message header.  For example:
 * <pre>
 * writer = client.sendMessageData();
 * if(writer == null) // failure
 *   return false;
 * header = 
 *    new SimpleSMTPHeader("foobar@foo.com", "foo@bar.com" "Just testing"); 
 * header.addCC("bar@foo.com");
 * header.addHeaderField("Organization", "Foobar, Inc.");
 * writer.write(header.toString());
 * writer.write("This is just a test");
 * writer.close();
 * if(!client.completePendingCommand()) // failure
 *   return false;
 * </pre>
 * <p>
 * <p>
 * @author Daniel F. Savarese
 * @see SMTPClient
 ***/

public class SimpleSMTPHeader {
  private String __subject, __from, __to;
  private StringBuffer __headerFields, __cc;

  /***
   * Creates a new SimpleSMTPHeader instance initialized with the given
   * from, to, and subject header field values.
   * <p>
   * @param from  The value of the <code>From:</code> header field.  This
   *              should be the sender's email address.
   * @param from  The value of the <code>To:</code> header field.  This
   *              should be the recipient's email address.
   * @param subject  The value of the <code>Subject:</code> header field. 
   *              This should be the subject of the message.
   ***/
  public SimpleSMTPHeader(String from,  String to, String subject) {
    __to         = to;
    __from       = from;
    __subject    = subject;
    __headerFields = new StringBuffer();
    __cc           = null;
  }

  /***
   * Adds an arbitrary header field with the given value to the article
   * header.  These headers will be written before the From, To, Subject, and
   * Cc fields when the SimpleSMTPHeader is convertered to a string.
   * An example use would be:
   * <pre>
   * header.addHeaderField("Organization", "Foobar, Inc.");
   * </pre>
   * <p>
   * @param headerField  The header field to add, not including the colon.
   * @param value  The value of the added header field.
   ***/
  public void addHeaderField(String headerField, String value) {
    __headerFields.append(headerField);
    __headerFields.append(": ");
    __headerFields.append(value);
    __headerFields.append('\n');
  }


  /***
   * Add an email address to the CC (carbon copy or courtesy copy) list.
   * <p>
   * @param address The email address to add to the CC list.
   ***/
  public void addCC(String address) {
    if(__cc == null)
      __cc = new StringBuffer();
    else
      __cc.append(", ");

    __cc.append(address);
  }


  /***
   * Converts the SimpleSMTPHeader to a properly formatted header in
   * the form of a String, including the blank line used to separate
   * the header from the article body.
   * <p>
   * @return The message header in the form of a String.
   ***/
  public String toString() {
    StringBuffer header = new StringBuffer();

    if(__headerFields.length() > 0)
      header.append(__headerFields.toString());

    header.append("From: ");
    header.append(__from);
    header.append("\nTo: ");
    header.append(__to);

    if(__cc != null) {
      header.append("\nCc: ");
      header.append(__cc);
    }

    header.append("\nSubject: ");
    header.append(__subject);
    header.append('\n');

    header.append('\n');

    return header.toString();
  }
}