Open Source Repository

Home /mail/mail-1.4.1 | Repository Home


com/sun/mail/dsn/DeliveryStatus.java
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 *
 * Contributor(s):
 *
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

/*
 * @(#)DeliveryStatus.java  1.6 07/05/04
 */

package com.sun.mail.dsn;

import java.io.*;
import java.util.*;

import javax.activation.*;
import javax.mail.*;
import javax.mail.internet.*;

import com.sun.mail.util.LineOutputStream;  // XXX

/**
 * A message/delivery-status message content, as defined in
 * <A HREF="http://www.ietf.org/rfc/rfc3464.txt">RFC 3464</A>.
 */
public class DeliveryStatus {

    private static boolean debug = false;

    static {
  try {
      String s = System.getProperty("mail.dsn.debug");
      // default to false
      debug = s != null && !s.equalsIgnoreCase("false");
  catch (SecurityException sex) {
      // ignore it
  }
    }

    /**
     * The DSN fields for the message.
     */
    protected InternetHeaders messageDSN;

    /**
     * The DSN fields for each recipient.
     */
    protected InternetHeaders[] recipientDSN;

    /**
     * Construct a delivery status notification with no content.
     */
    public DeliveryStatus() throws MessagingException {
  messageDSN = new InternetHeaders();
  recipientDSN = new InternetHeaders[0];
    }

    /**
     * Construct a delivery status notification by parsing the
     * supplied input stream.
     */
    public DeliveryStatus(InputStream is)
        throws MessagingException, IOException {
  messageDSN = new InternetHeaders(is);
  if (debug)
      System.out.println("DSN: got messageDSN");
  Vector v = new Vector();
  try {
      while (is.available() 0) {
    InternetHeaders h = new InternetHeaders(is);
    if (debug)
        System.out.println("DSN: got recipientDSN");
    v.addElement(h);
      }
  catch (EOFException ex) {
      if (debug)
    System.out.println("DSN: got EOFException");
  }
  if (debug)
      System.out.println("DSN: recipientDSN size " + v.size());
  recipientDSN = new InternetHeaders[v.size()];
  v.copyInto(recipientDSN);
    }

    /**
     * Return all the per-message fields in the delivery status notification.
     * The fields are defined as:
     *
     <pre>
     *    per-message-fields =
     *          [ original-envelope-id-field CRLF ]
     *          reporting-mta-field CRLF
     *          [ dsn-gateway-field CRLF ]
     *          [ received-from-mta-field CRLF ]
     *          [ arrival-date-field CRLF ]
     *          *( extension-field CRLF )
     </pre>
     */
    // XXX - could parse each of these fields
    public InternetHeaders getMessageDSN() {
  return messageDSN;
    }

    /**
     * Set the per-message fields in the delivery status notification.
     */
    public void setMessageDSN(InternetHeaders messageDSN) {
  this.messageDSN = messageDSN;
    }

    /**
     * Return the number of recipients for which we have
     * per-recipient delivery status notification information.
     */
    public int getRecipientDSNCount() {
  return recipientDSN.length;
    }

    /**
     * Return the delivery status notification information for
     * the specified recipient.
     */
    public InternetHeaders getRecipientDSN(int n) {
  return recipientDSN[n];
    }

    /**
     * Add deliver status notification information for another
     * recipient.
     */
    public void addRecipientDSN(InternetHeaders h) {
  InternetHeaders[] rh = new InternetHeaders[recipientDSN.length + 1];
  System.arraycopy(recipientDSN, 0, rh, 0, recipientDSN.length);
  recipientDSN = rh;
  recipientDSN[recipientDSN.length - 1= h;
    }

    public void writeTo(OutputStream os)
        throws IOException, MessagingException {
  // see if we already have a LOS
  LineOutputStream los = null;
  if (os instanceof LineOutputStream) {
      los = (LineOutputStreamos;
  else {
      los = new LineOutputStream(os);
  }

  writeInternetHeaders(messageDSN, los);
  los.writeln();
  for (int i = 0; i < recipientDSN.length; i++) {
      writeInternetHeaders(recipientDSN[i], los);
      los.writeln();
  }
    }

    private static void writeInternetHeaders(InternetHeaders h,
        LineOutputStream losthrows IOException {
  Enumeration e = h.getAllHeaderLines();
  try {
      while (e.hasMoreElements())
    los.writeln((String)e.nextElement());
  catch (MessagingException mex) {
      Exception ex = mex.getNextException();
      if (ex instanceof IOException)
    throw (IOException)ex;
      else
    throw new IOException("Exception writing headers: " + mex);
  }
    }

    public String toString() {
  return "DeliveryStatus: Reporting-MTA=" +
      messageDSN.getHeader("Reporting-MTA"null", #Recipients=" +
      recipientDSN.length;
    }
}