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    
020    package org.apache.james.protocols.smtp.hook;
021    
022    import org.apache.james.protocols.smtp.MailEnvelope;
023    import org.apache.james.protocols.smtp.SMTPSession;
024    import org.apache.mailet.MailAddress;
025    
026    
027    /**
028     * Simple {@link Hook} implementation which can be used as base class when writing simple {@link Hook}'s
029     * 
030     * The SMTP-Server will just accept email with this {@link Hook} in place and discard it
031     *
032     */
033    public class SimpleHook implements HeloHook, MailHook, RcptHook, MessageHook {
034    
035        /**
036         * Return {@link HookResult} with {@link HookReturnCode#OK}
037         */
038        public HookResult onMessage(SMTPSession session, MailEnvelope mail) {
039            return new HookResult(HookReturnCode.OK);
040        }
041    
042        /**
043         * Return {@link HookResult} with {@link HookReturnCode#DECLINED}
044         */
045        public HookResult doRcpt(SMTPSession session, MailAddress sender, MailAddress rcpt) {
046            return new HookResult(HookReturnCode.DECLINED);
047    
048        }
049    
050        /**
051         * Return {@link HookResult} with {@link HookReturnCode#DECLINED}
052         */
053        public HookResult doMail(SMTPSession session, MailAddress sender) {
054            return new HookResult(HookReturnCode.DECLINED);
055    
056        }
057    
058        /**
059         * Return {@link HookResult} with {@link HookReturnCode#DECLINED}
060         */
061        public HookResult doHelo(SMTPSession session, String helo) {
062            return new HookResult(HookReturnCode.DECLINED);
063        }
064    
065    }