org.apache.james.protocols.smtp.hook.RcptHook Maven / Gradle / Ivy
/****************************************************************
* 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.protocols.smtp.hook;
import java.util.Map;
import java.util.Set;
import org.apache.james.core.MailAddress;
import org.apache.james.core.MaybeSender;
import org.apache.james.protocols.smtp.SMTPSession;
import com.google.common.collect.ImmutableSet;
/**
* Implement this interfaces to hook in the RCPT Command
*/
public interface RcptHook extends Hook {
/**
* @return RCPT parameters supported by this hook
*/
default Set supportedParameters() {
return ImmutableSet.of();
}
/**
* Return the HookResult after run the hook
*
* @deprecated Use {@link #doRcpt(SMTPSession, MaybeSender, MailAddress)} instead
*
* @param session the SMTPSession
* @param sender the sender MailAddress
* @param rcpt the recipient MailAddress
* @return HookResult
*/
@Deprecated
default HookResult doRcpt(SMTPSession session, MailAddress sender, MailAddress rcpt) {
return doRcpt(session, MaybeSender.of(sender), rcpt);
}
/**
* Return the HookResult after run the hook
*
* this strongly typed version smoothly handle null sender and should be prefered.
*/
default HookResult doRcpt(SMTPSession session, MaybeSender sender, MailAddress rcpt) {
return doRcpt(session, sender.asOptional().orElse(null), rcpt);
}
/**
* Return the HookResult after run the hook.
*
* This variation of doRcpt method allows access to RCPT extra parameters.
*
* @param session the SMTPSession
* @param sender the sender MailAddress
* @param rcpt the recipient MailAddress
* @param parameters parameters passed to the RCPT commands
* @return HookResult
*/
default HookResult doRcpt(SMTPSession session, MaybeSender sender, MailAddress rcpt, Map parameters) {
return doRcpt(session, sender, rcpt);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy