001    /****************************************************************
002     * Licensed to the Apache Software Foundation (ASF) under one   *
003     * or more contributor license agreements.  See the NOTICE file *
004     * distributed with this work for additional information        *
005     * regarding copyright ownership.  The ASF licenses this file   *
006     * to you under the Apache License, Version 2.0 (the            *
007     * "License"); you may not use this file except in compliance   *
008     * with the License.  You may obtain a copy of the License at   *
009     *                                                              *
010     *   http://www.apache.org/licenses/LICENSE-2.0                 *
011     *                                                              *
012     * Unless required by applicable law or agreed to in writing,   *
013     * software distributed under the License is distributed on an  *
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
015     * KIND, either express or implied.  See the License for the    *
016     * specific language governing permissions and limitations      *
017     * under the License.                                           *
018     ****************************************************************/
019    package org.apache.james.protocols.smtp.hook;
020    
021    import org.apache.james.protocols.smtp.MailEnvelope;
022    import org.apache.james.protocols.smtp.SMTPSession;
023    
024    /**
025     * Custom message handlers must implement this interface The message hooks will
026     * be server-wide common to all the SMTPHandlers, therefore the handlers must
027     * store all the state information in the SMTPSession object
028     */
029    public interface MessageHook extends Hook{
030            /**
031             * Handle Message
032             */
033            HookResult onMessage(SMTPSession session, MailEnvelope mail);
034    
035    }