JAMES-2340 IsMarkedAsSpam matcher should accept a dynamic spam status header
diff --git a/server/apps/distributed-app/docs/modules/ROOT/partials/IsMarkedAsSpam.adoc b/server/apps/distributed-app/docs/modules/ROOT/partials/IsMarkedAsSpam.adoc
index 7277a9d..1f2bf1e 100644
--- a/server/apps/distributed-app/docs/modules/ROOT/partials/IsMarkedAsSpam.adoc
+++ b/server/apps/distributed-app/docs/modules/ROOT/partials/IsMarkedAsSpam.adoc
@@ -14,4 +14,15 @@
<targetFolderName>Spam</targetFolderName>
</mailet>
<!-- End of SpamAssassing mailets pipeline -->
+....
+
+In order to use this with `rspamd`, we need to declare a condition for the matcher.
+Eg: With the recipient header for RSpamD being *org.apache.james.rspamd.status*,
+then the configuration would be:
+
+....
+<!-- SpamAssassing mailets pipeline -->
+ <mailet match="IsMarkedAsSpam=org.apache.james.rspamd.status" class="WithStorageDirective">
+ <targetFolderName>Spam</targetFolderName>
+ </mailet>
....
\ No newline at end of file
diff --git a/server/mailet/mailets/src/main/java/org/apache/james/transport/matchers/IsMarkedAsSpam.java b/server/mailet/mailets/src/main/java/org/apache/james/transport/matchers/IsMarkedAsSpam.java
index 8c7f0d9..a5ef1aa 100644
--- a/server/mailet/mailets/src/main/java/org/apache/james/transport/matchers/IsMarkedAsSpam.java
+++ b/server/mailet/mailets/src/main/java/org/apache/james/transport/matchers/IsMarkedAsSpam.java
@@ -21,6 +21,9 @@
import java.util.Collection;
import java.util.Locale;
+import java.util.Optional;
+
+import javax.mail.MessagingException;
import org.apache.james.core.MailAddress;
import org.apache.james.spamassassin.SpamAssassinResult;
@@ -51,9 +54,18 @@
private static final String YES = "yes";
+ private String spamStatusHeader = SpamAssassinResult.STATUS_MAIL.asString();
+
@Override
public String getMatcherInfo() {
- return "Has org.apache.james.spamassassin.status per recipient header with a Yes value";
+ return "Has " + spamStatusHeader + " per recipient header with a Yes value";
+ }
+
+ @Override
+ public void init() throws MessagingException {
+ spamStatusHeader = Optional.ofNullable(getCondition())
+ .filter(s -> !s.isEmpty())
+ .orElse(SpamAssassinResult.STATUS_MAIL.asString());
}
@Override
@@ -67,7 +79,7 @@
public boolean isMarkedAsSpam(Mail mail, MailAddress recipient) {
return mail.getPerRecipientSpecificHeaders().getHeadersForRecipient(recipient)
.stream()
- .filter(header -> header.getName().equals(SpamAssassinResult.STATUS_MAIL.asString()))
+ .filter(header -> header.getName().equals(spamStatusHeader))
.anyMatch(header -> header.getValue().toLowerCase(Locale.US).startsWith(YES));
}
diff --git a/server/mailet/mailets/src/test/java/org/apache/james/transport/matchers/IsMarkedAsSpamTest.java b/server/mailet/mailets/src/test/java/org/apache/james/transport/matchers/IsMarkedAsSpamTest.java
index d49c66e..5841ee5 100644
--- a/server/mailet/mailets/src/test/java/org/apache/james/transport/matchers/IsMarkedAsSpamTest.java
+++ b/server/mailet/mailets/src/test/java/org/apache/james/transport/matchers/IsMarkedAsSpamTest.java
@@ -26,6 +26,7 @@
import org.apache.mailet.Attribute;
import org.apache.mailet.PerRecipientHeaders;
import org.apache.mailet.base.test.FakeMail;
+import org.apache.mailet.base.test.FakeMatcherConfig;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
@@ -151,4 +152,29 @@
Collection<MailAddress> matches = matcher.match(mail);
assertThat(matches).contains(new MailAddress("to@james.org"));
}
+
+ @Test
+ void isMarkedAsSpamShouldAcceptDynamicSpamStatusPackageHeader() throws Exception {
+ FakeMatcherConfig matcherConfig = FakeMatcherConfig.builder()
+ .matcherName("IsMarkedAsSpam")
+ .condition("custom.package")
+ .build();
+
+ matcher.init(matcherConfig);
+
+ FakeMail mail = FakeMail.builder()
+ .name("name")
+ .sender("sender@james.org")
+ .recipient("to@james.org")
+ .addHeaderForRecipient(PerRecipientHeaders.Header.builder()
+ .name("custom.package")
+ .value("Yes, hits=6.8 required=5.0")
+ .build(),
+ new MailAddress("to@james.org"))
+ .attribute(Attribute.convertToAttribute("custom.package", "Yes, hits=6.8 required=5.0"))
+ .build();
+
+ Collection<MailAddress> matches = matcher.match(mail);
+ assertThat(matches).contains(new MailAddress("to@james.org"));
+ }
}