You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@james.apache.org by rc...@apache.org on 2021/01/05 04:55:48 UTC

[james-project] 09/24: JAMES-3431 RecipientRewriteTableProcessor needs to modify DSN parameters

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

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

commit 91fd382e1949db9d888262a1ceeb53093be76177
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Wed Dec 30 10:47:54 2020 +0700

    JAMES-3431 RecipientRewriteTableProcessor needs to modify DSN parameters
    
    ORCPT is preserved (should not be rewritten):
    
    ```
    The purpose of ORCPT is to preserve the original recipient of an email message, for example, if it is forwarded to another address.
    ```
    
    (source: https://www.lifewire.com/what-is-dsn-delivery-status-notification-for-smtp-email-3860942, for what it is worth)
---
 .../main/java/org/apache/mailet/DsnParameters.java |  4 ++
 .../java/org/apache/james/smtp/DSNRelayTest.java   | 47 ++++++++++++-
 .../mailets/RecipientRewriteTableProcessor.java    | 76 +++++++++++++++++++---
 3 files changed, 118 insertions(+), 9 deletions(-)

diff --git a/mailet/api/src/main/java/org/apache/mailet/DsnParameters.java b/mailet/api/src/main/java/org/apache/mailet/DsnParameters.java
index 612fbc0..6dc46ee 100644
--- a/mailet/api/src/main/java/org/apache/mailet/DsnParameters.java
+++ b/mailet/api/src/main/java/org/apache/mailet/DsnParameters.java
@@ -424,6 +424,10 @@ public class DsnParameters {
         this.rcptParameters = rcptParameters;
     }
 
+    public DsnParameters withRcptParameters(Map<MailAddress, RecipientDsnParameters> rcptParameters) {
+        return new DsnParameters(envIdParameter, retParameter, ImmutableMap.copyOf(rcptParameters));
+    }
+
     public Optional<EnvId> getEnvIdParameter() {
         return envIdParameter;
     }
diff --git a/server/mailet/integration-testing/src/test/java/org/apache/james/smtp/DSNRelayTest.java b/server/mailet/integration-testing/src/test/java/org/apache/james/smtp/DSNRelayTest.java
index 4f79750..3a1b00d 100644
--- a/server/mailet/integration-testing/src/test/java/org/apache/james/smtp/DSNRelayTest.java
+++ b/server/mailet/integration-testing/src/test/java/org/apache/james/smtp/DSNRelayTest.java
@@ -29,6 +29,7 @@ import static org.assertj.core.api.Assertions.assertThat;
 import static org.awaitility.Duration.TEN_SECONDS;
 
 import org.apache.commons.net.smtp.AuthenticatingSMTPClient;
+import org.apache.james.core.Domain;
 import org.apache.james.core.MailAddress;
 import org.apache.james.dnsservice.api.DNSService;
 import org.apache.james.dnsservice.api.InMemoryDNSService;
@@ -47,6 +48,7 @@ import org.apache.james.smtpserver.dsn.DSNEhloHook;
 import org.apache.james.smtpserver.dsn.DSNMailParameterHook;
 import org.apache.james.smtpserver.dsn.DSNMessageHook;
 import org.apache.james.smtpserver.dsn.DSNRcptParameterHook;
+import org.apache.james.transport.mailets.RecipientRewriteTable;
 import org.apache.james.transport.mailets.RemoteDelivery;
 import org.apache.james.transport.matchers.All;
 import org.apache.james.util.Host;
@@ -327,6 +329,47 @@ public class DSNRelayTest {
     }
 
     @Test
+    public void dsnShouldBeCarriedAfterRRT() throws Exception {
+        DataProbeImpl dataProbe = jamesServer.getProbe(DataProbeImpl.class);
+        dataProbe.addDomain(ANOTHER_DOMAIN);
+        dataProbe.addAddressMapping("touser", ANOTHER_DOMAIN, "touser-alias@other.com");
+
+        AuthenticatingSMTPClient smtpClient = new AuthenticatingSMTPClient("TLS", "UTF-8");
+
+        try {
+            smtpClient.connect("localhost", jamesServer.getProbe(SmtpGuiceProbe.class).getSmtpPort().getValue());
+            smtpClient.ehlo(DEFAULT_DOMAIN);
+            smtpClient.mail("<" + FROM + "> RET=HDRS ENVID=gabouzomeuh");
+            smtpClient.rcpt("<" + RECIPIENT + "> NOTIFY=FAILURE,DELAY");
+            smtpClient.sendShortMessageData("A short message...");
+        } finally {
+            smtpClient.disconnect();
+        }
+
+        calmlyAwait.atMost(TEN_SECONDS).untilAsserted(() -> assertThat(mockSMTPConfiguration.listMails())
+            .hasSize(1)
+            .extracting(Mail::getEnvelope)
+            .containsExactly(Mail.Envelope.builder()
+                .from(new MailAddress(FROM))
+                .addMailParameter(Mail.Parameter.builder()
+                    .name("RET")
+                    .value("HDRS")
+                    .build())
+                .addMailParameter(Mail.Parameter.builder()
+                    .name("ENVID")
+                    .value("gabouzomeuh")
+                    .build())
+                .addRecipient(Mail.Recipient.builder()
+                    .address(new MailAddress("touser-alias@other.com"))
+                    .addParameter(Mail.Parameter.builder()
+                        .name("NOTIFY")
+                        .value("FAILURE,DELAY")
+                        .build())
+                    .build())
+                .build()));
+    }
+
+    @Test
     public void remoteDeliveryShouldCarryOverDSNMailParameters() throws Exception {
         AuthenticatingSMTPClient smtpClient = new AuthenticatingSMTPClient("TLS", "UTF-8");
 
@@ -363,7 +406,9 @@ public class DSNRelayTest {
     private ProcessorConfiguration.Builder directResolutionTransport() {
         return ProcessorConfiguration.transport()
             .addMailet(MailetConfiguration.BCC_STRIPPER)
-            .addMailet(MailetConfiguration.LOCAL_DELIVERY)
+            .addMailet(MailetConfiguration.builder()
+                .matcher(All.class)
+                .mailet(RecipientRewriteTable.class))
             .addMailet(MailetConfiguration.builder()
                 .mailet(RemoteDelivery.class)
                 .matcher(All.class)
diff --git a/server/mailet/mailets/src/main/java/org/apache/james/transport/mailets/RecipientRewriteTableProcessor.java b/server/mailet/mailets/src/main/java/org/apache/james/transport/mailets/RecipientRewriteTableProcessor.java
index 8eef3e9..77660c2 100644
--- a/server/mailet/mailets/src/main/java/org/apache/james/transport/mailets/RecipientRewriteTableProcessor.java
+++ b/server/mailet/mailets/src/main/java/org/apache/james/transport/mailets/RecipientRewriteTableProcessor.java
@@ -31,6 +31,8 @@ import java.util.stream.Stream;
 
 import javax.mail.MessagingException;
 
+import org.apache.commons.lang3.NotImplementedException;
+import org.apache.commons.lang3.tuple.Pair;
 import org.apache.james.core.Domain;
 import org.apache.james.core.MailAddress;
 import org.apache.james.domainlist.api.DomainList;
@@ -42,6 +44,8 @@ import org.apache.james.rrt.lib.Mapping;
 import org.apache.james.rrt.lib.Mappings;
 import org.apache.james.server.core.MailImpl;
 import org.apache.james.util.MemoizedSupplier;
+import org.apache.mailet.DsnParameters;
+import org.apache.mailet.DsnParameters.RecipientDsnParameters;
 import org.apache.mailet.Mail;
 import org.apache.mailet.MailetContext;
 import org.slf4j.Logger;
@@ -58,6 +62,44 @@ import com.google.common.collect.ImmutableSet;
 public class RecipientRewriteTableProcessor {
     private static final Logger LOGGER = LoggerFactory.getLogger(RecipientRewriteTableProcessor.class);
 
+    private static class Decision {
+        private final MailAddress originalAddress;
+        private final RrtExecutionResult executionResult;
+
+        private Decision(MailAddress originalAddress, RrtExecutionResult executionResult) {
+            this.originalAddress = originalAddress;
+            this.executionResult = executionResult;
+        }
+
+        MailAddress originalAddress() {
+            return originalAddress;
+        }
+
+        RrtExecutionResult executionResult() {
+            return executionResult;
+        }
+
+        DsnParameters applyOnDsnParameters(DsnParameters dsnParameters) {
+            ImmutableMap<MailAddress, RecipientDsnParameters> rcptParameters = dsnParameters.getRcptParameters();
+
+            Optional<RecipientDsnParameters> originalRcptParameter = Optional.ofNullable(rcptParameters.get(originalAddress));
+
+            return originalRcptParameter.map(parameters -> {
+                Map<MailAddress, RecipientDsnParameters> newRcptParameters = executionResult.getNewRecipients().stream()
+                    .map(newRcpt -> Pair.of(newRcpt, parameters))
+                    .collect(Guavate.toImmutableMap(Pair::getKey, Pair::getValue));
+                Map<MailAddress, RecipientDsnParameters> rcptParametersWithoutOriginal = rcptParameters.entrySet().stream()
+                    .filter(rcpt -> !rcpt.getKey().equals(originalAddress))
+                    .collect(Guavate.toImmutableMap(Map.Entry::getKey, Map.Entry::getValue));
+
+                return dsnParameters.withRcptParameters(ImmutableMap.<MailAddress, RecipientDsnParameters>builder()
+                    .putAll(rcptParametersWithoutOriginal)
+                    .putAll(newRcptParameters)
+                    .build());
+            }).orElse(dsnParameters);
+        }
+    }
+
     private static class RrtExecutionResult {
         private static RrtExecutionResult empty() {
             return new RrtExecutionResult(ImmutableSet.of(), ImmutableSet.of());
@@ -131,7 +173,25 @@ public class RecipientRewriteTableProcessor {
     }
 
     public void processMail(Mail mail) throws MessagingException {
-        RrtExecutionResult executionResults = executeRrtFor(mail);
+        List<Decision> decisions = executeRrtFor(mail);
+
+        applyDecisionsOnMailRecipients(mail, decisions);
+        applyDecisionOnDSNParameters(mail, decisions);
+    }
+
+    private void applyDecisionOnDSNParameters(Mail mail, List<Decision> decisions) {
+        mail.dsnParameters()
+            .map(dsnParameters -> decisions.stream()
+                .reduce(dsnParameters, (parameters, decision) -> decision.applyOnDsnParameters(parameters), (a, b) -> {
+                    throw new NotImplementedException("No combiner needed as we are not in a multi-threaded environment");
+                }))
+            .ifPresent(mail::setDsnParameters);
+    }
+
+    private void applyDecisionsOnMailRecipients(Mail mail, List<Decision> decisions) throws MessagingException {
+        RrtExecutionResult executionResults = decisions.stream()
+            .map(Decision::executionResult)
+            .reduce(RrtExecutionResult.empty(), RrtExecutionResult::merge);
 
         if (!executionResults.recipientWithError.isEmpty()) {
             MailImpl newMail = MailImpl.builder()
@@ -151,8 +211,8 @@ public class RecipientRewriteTableProcessor {
         mail.setRecipients(executionResults.newRecipients);
     }
 
-    private RrtExecutionResult executeRrtFor(Mail mail) {
-        Function<MailAddress, RrtExecutionResult> convertToMappingData = recipient -> {
+    private List<Decision> executeRrtFor(Mail mail) {
+        Function<MailAddress, Decision> convertToMappingData = recipient -> {
             Preconditions.checkNotNull(recipient);
 
             return executeRrtForRecipient(mail, recipient);
@@ -161,21 +221,21 @@ public class RecipientRewriteTableProcessor {
         return mail.getRecipients()
             .stream()
             .map(convertToMappingData)
-            .reduce(RrtExecutionResult.empty(), RrtExecutionResult::merge);
+            .collect(Guavate.toImmutableList());
     }
 
-    private RrtExecutionResult executeRrtForRecipient(Mail mail, MailAddress recipient) {
+    private Decision executeRrtForRecipient(Mail mail, MailAddress recipient) {
         try {
             Mappings mappings = virtualTableStore.getResolvedMappings(recipient.getLocalPart(), recipient.getDomain());
 
             if (mappings != null && !mappings.isEmpty()) {
                 List<MailAddress> newMailAddresses = handleMappings(mappings, mail, recipient);
-                return RrtExecutionResult.success(newMailAddresses);
+                return new Decision(recipient, RrtExecutionResult.success(newMailAddresses));
             }
-            return RrtExecutionResult.success(recipient);
+            return new Decision(recipient, RrtExecutionResult.success(recipient));
         } catch (ErrorMappingException | RecipientRewriteTableException e) {
             LOGGER.warn("Could not rewrite recipient {}", recipient, e);
-            return RrtExecutionResult.error(recipient);
+            return new Decision(recipient, RrtExecutionResult.error(recipient));
         }
     }
 


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