[james-project] 05/08: JAMES-3431 RCPT hook for handling ORCPT & NOTIFY parameters

[bt...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git

commit 2a2423c3a15a98b142847524527ada8b1ead10bc
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Thu Dec 10 11:28:40 2020 +0700

    JAMES-3431 RCPT hook for handling ORCPT & NOTIFY parameters
---
 .../apache/james/protocols/smtp/hook/RcptHook.java | 11 ++++
 .../james/smtpserver/dsn/DSNRcptParameterHook.java | 76 ++++++++++++++++++++++
 2 files changed, 87 insertions(+)

diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/RcptHook.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/RcptHook.java
index 510b6ec..e5fc611 100644
--- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/RcptHook.java
+++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/RcptHook.java
@@ -62,6 +62,17 @@ public interface RcptHook extends Hook {
         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<String, String> parameters) {
         return doRcpt(session, sender, rcpt);
     }
diff --git a/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/dsn/DSNRcptParameterHook.java b/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/dsn/DSNRcptParameterHook.java
new file mode 100644
index 0000000..f146fef
--- /dev/null
+++ b/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/dsn/DSNRcptParameterHook.java
@@ -0,0 +1,76 @@
+/****************************************************************
+ * 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.smtpserver.dsn;
+
+import static org.apache.james.protocols.api.ProtocolSession.State.Transaction;
+import static org.apache.mailet.DsnParameters.NOTIFY_PARAMETER;
+import static org.apache.mailet.DsnParameters.ORCPT_PARAMETER;
+
+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.api.ProtocolSession;
+import org.apache.james.protocols.smtp.SMTPSession;
+import org.apache.james.protocols.smtp.hook.HookResult;
+import org.apache.james.protocols.smtp.hook.RcptHook;
+import org.apache.mailet.DsnParameters;
+import org.apache.mailet.DsnParameters.RecipientDsnParameters;
+
+import com.google.common.collect.ImmutableMap;
+import com.google.common.collect.ImmutableSet;
+
+public class DSNRcptParameterHook implements RcptHook {
+    public static class Builder {
+        private final ImmutableMap.Builder<MailAddress, RecipientDsnParameters> entries;
+
+        public Builder() {
+            entries = ImmutableMap.builder();
+        }
+
+        public Builder add(MailAddress recipient, RecipientDsnParameters parameters) {
+            entries.put(recipient, parameters);
+            return this;
+        }
+
+        public ImmutableMap<MailAddress, RecipientDsnParameters> build() {
+            return entries.build();
+        }
+    }
+
+    public static final ProtocolSession.AttachmentKey<Builder> DSN_RCPT_PARAMETERS =
+        ProtocolSession.AttachmentKey.of("DSN_RCPT_PARAMETERS", Builder.class);
+
+    @Override
+    public Set<String> supportedParameters() {
+        return ImmutableSet.of(ORCPT_PARAMETER, NOTIFY_PARAMETER);
+    }
+
+    @Override
+    public HookResult doRcpt(SMTPSession session, MaybeSender sender, MailAddress rcpt, Map<String, String> parameters) {
+        Builder builder = session.getAttachment(DSN_RCPT_PARAMETERS, Transaction)
+            .orElse(new Builder());
+        DsnParameters.RecipientDsnParameters.fromSMTPArgLine(parameters)
+            .ifPresent(rcptParameters ->
+                session.setAttachment(DSN_RCPT_PARAMETERS, builder.add(rcpt, rcptParameters), Transaction));
+        return HookResult.DECLINED;
+    }
+}


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org