| career | drupal | java | mac | mysql | perl | scala | uml | unix  

What this is

This file is included in the "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

 * Copyright 2001-2004 The Apache Software Foundation
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * See the License for the specific language governing permissions and
 * limitations under the License.

 * 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.

* 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: *

 * writer = client.sendMessageData();
 * if(writer == null) // failure
 *   return false;
 * header =
 *    new SimpleSMTPHeader("", "" "Just testing");
 * header.addCC("");
 * header.addHeaderField("Organization", "Foobar, Inc.");
 * writer.write(header.toString());
 * writer.write("This is just a test");
 * writer.close();
 * if(!client.completePendingCommand()) // failure
 *   return false;


* @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. *

* @param from The value of the From: header field. This * should be the sender's email address. * @param to The value of the To: header field. This * should be the recipient's email address. * @param subject The value of the Subject: 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: *

     * header.addHeaderField("Organization", "Foobar, Inc.");

* @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. *

* @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. The header fields CC and Subject * are only included when they are non-null. *

* @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.toString()); } if (__subject != null) { header.append("\nSubject: "); header.append(__subject); } header.append('\n'); header.append('\n'); return header.toString(); } }

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller


new blog posts


Copyright 1998-2021 Alvin Alexander,
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.