/****************************************************************
    * Licensed to the Apache Software Foundation (ASF) under one   *
    * or more contributor license agreements.  See the NOTICE file *
    * distributed with this work for additional information        *
    * regarding copyright ownership.  The ASF licenses this file   *
    * to you 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   *
    *                                                              *
   *   http://www.apache.org/licenses/LICENSE-2.0                 *
   *                                                              *
   * Unless required by applicable law or agreed to in writing,   *
   * software distributed under the License is distributed on an  *
   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
   * KIND, either express or implied.  See the License for the    *
   * specific language governing permissions and limitations      *
   * under the License.                                           *
   ****************************************************************/
  
  
  
  package org.apache.james.transport.mailets;
  
  import org.apache.mailet.MailAddress;
  
  import javax.mail.MessagingException;
  import javax.mail.internet.InternetAddress;
  import java.util.HashSet;
  import java.util.Collection;
  
  /**
   * <P>Sends a notification message to the sender of a message.</P>
   * <P>A sender of the notification message can optionally be specified.
   * If one is not specified, the postmaster's address will be used.<BR>
   * The "To:" header of the notification message can be set to "unaltered";
   * if missing will be set to the sender of the notified message.<BR>
   * A notice text can be specified, and in such case will be inserted into the 
   * notification inline text.<BR>
   * If the notified message has an "error message" set, it will be inserted into the 
   * notification inline text. If the <CODE>attachStackTrace</CODE> init parameter
   * is set to true, such error message will be attached to the notification message.<BR>
   * The notified messages are attached in their entirety (headers and
   * content) and the resulting MIME part type is "message/rfc822".</P>
   * <P>Supports the <CODE>passThrough</CODE> init parameter (true if missing).</P>
   *
   * <P>Sample configuration:</P>
   * <PRE><CODE>
   * &lt;mailet match="All" class="NotifySender">
   *   &lt;sender&gt;<I>an address or postmaster or sender or unaltered, default=postmaster</I>&lt;/sender&gt;
   *   &lt;attachError&gt;<I>true or false, default=false</I>&lt;/attachError&gt;
   *   &lt;prefix&gt;<I>optional subject prefix prepended to the original message</I>&lt;/prefix&gt;
   *   &lt;inline&gt;<I>see {@link Resend}, default=none</I>&lt;/inline&gt;
   *   &lt;attachment&gt;<I>see {@link Resend}, default=message</I>&lt;/attachment&gt;
   *   &lt;passThrough&gt;<I>true or false, default=true</I>&lt;/passThrough&gt;
   *   &lt;fakeDomainCheck&gt;<I>true or false, default=true</I>&lt;/fakeDomainCheck&gt;
   *   &lt;to&gt;<I>unaltered or sender or from(optional, defaults to sender)</I>&lt;/to&gt;
   *   &lt;debug&gt;<I>true or false, default=false</I>&lt;/debug&gt;
   * &lt;/mailet&gt;
   * </CODE></PRE>
   *
   * <P>The behaviour of this mailet is equivalent to using Resend with the following
   * configuration:</P>
   * <PRE><CODE>
   * &lt;mailet match="All" class="Resend">
   *   &lt;sender&gt;<I>an address or postmaster or sender or unaltered</I>&lt;/sender&gt;
   *   &lt;attachError&gt;<I>true or false</I>&lt;/attachError&gt;
   *   &lt;message&gt;<I><B>dynamically built</B></I>&lt;/message&gt;
   *   &lt;prefix&gt;<I>a string</I>&lt;/prefix&gt;
   *   &lt;passThrough&gt;true&lt;/passThrough&gt;
   *   &lt;fakeDomainCheck&gt;<I>true or false</I>&lt;/fakeDomainCheck&gt;
   *   &lt;to&gt;<I>unaltered or sender or from&lt</I>;/to&gt;
   *   &lt;recipients&gt;<B>sender</B>&lt;/recipients&gt;
   *   &lt;inline&gt;none&lt;/inline&gt;
   *   &lt;attachment&gt;message&lt;/attachment&gt;
   *   &lt;isReply&gt;true&lt;/isReply&gt;
   *   &lt;debug&gt;<I>true or false</I>&lt;/debug&gt;
   * &lt;/mailet&gt;
   * </CODE></PRE>
   * <P><I>notice</I>, <I>sendingAddress</I> and <I>attachStackTrace</I> can be used instead of
   * <I>message</I>, <I>sender</I> and <I>attachError</I>; such names are kept for backward compatibility.</P>
   *
   * @version CVS $Revision: 426007 $ $Date: 2006-07-27 09:52:06 +0100 (Thu, 27 Jul 2006) $
   */
  public class NotifySender extends AbstractNotify {
  
      /**
       * Return a string describing this mailet.
       *
       * @return a string describing this mailet
       */
      public String getMailetInfo() {
          return "NotifySender Mailet";
      }
  
      /** Gets the expected init parameters. */
      protected  String[] getAllowedInitParameters() {
          String[] allowedArray = {
  //            "static",
              "debug",
             "passThrough",
             "fakeDomainCheck",
             "inline",
             "attachment",
             "message",
             "notice",
             "sender",
             "sendingAddress",
             "prefix",
             "attachError",
             "attachStackTrace",
             "to"
         };
         return allowedArray;
     }
     
     /* ******************************************************************** */
     /* ****************** Begin of getX and setX methods ****************** */
     /* ******************************************************************** */
 
     /**
      * @return <CODE>SpecialAddress.SENDER</CODE>, indicating the sender of the current mail
      */
     protected Collection getRecipients() {
         Collection newRecipients = new HashSet();
         newRecipients.add(SpecialAddress.SENDER);
         return newRecipients;
     }
 
     /**
      * @return <CODE>SpecialAddress.UNALTERED</CODE> if specified or <CODE>SpecialAddress.SENDER</CODE> if missing
      */
     protected InternetAddress[] getTo() throws MessagingException {
         String addressList = getInitParameter("to");
         InternetAddress[] iaarray = new InternetAddress[1];
         iaarray[0] = SpecialAddress.SENDER.toInternetAddress();
         if (addressList != null) {
             MailAddress specialAddress = getSpecialAddress(addressList,
                                             new String[] {"sender", "unaltered", "from"});
             if (specialAddress != null) {
                 iaarray[0] = specialAddress.toInternetAddress();
             } else {
                 log("\"to\" parameter ignored, set to sender");
             }
         }
         return iaarray;
     }
 
     /**
      * @return the <CODE>attachStackTrace</CODE> init parameter, 
      * or the <CODE>attachError</CODE> init parameter if missing,
      * or false if missing 
      */
     protected boolean attachError() throws MessagingException {
         String parameter = getInitParameter("attachStackTrace");
         if (parameter == null) {
             return super.attachError();
         }        
         return new Boolean(parameter).booleanValue();
     }
 
     /* ******************************************************************** */
     /* ******************* End of getX and setX methods ******************* */
     /* ******************************************************************** */
     
 }