Merge pull request #1307 from leec94/port-issue-3422

Port: Configurable email subject prefix
DependencyTrack · Jun 6, 2024 · a75b030 · a75b030
2 parents 8d9e628 + 11f944f
commit a75b030
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/...publisher/src/main/java/org/dependencytrack/notification/publisher/SendMailPublisher.java b/...publisher/src/main/java/org/dependencytrack/notification/publisher/SendMailPublisher.java
@@ -113,6 +113,9 @@ private void sendNotification(final PublishContext ctx, Notification notificatio
             return;
         }
 
+        String emailSubjectPrefix;
+        emailSubjectPrefix = publisherConfig.emailPrefix().orElse(" ");
+
         final String fromAddress = publisherConfig.fromAddress().orElse(null);
         if (fromAddress == null) {
             LOGGER.warn("From address is not configured; Skipping notification (%s)".formatted(ctx));
@@ -132,7 +135,7 @@ private void sendNotification(final PublishContext ctx, Notification notificatio
                 final var message = new MailMessage();
                 message.setFrom(fromAddress);
                 message.setTo(destination);
-                message.setSubject("[Dependency-Track] " + notification.getTitle());
+                message.setSubject(emailSubjectPrefix + " " + notification.getTitle());
                 message.setText(content);
 
                 mailClient.sendMailAndAwait(message);

diff --git a/...her/src/main/java/org/dependencytrack/notification/publisher/SendMailPublisherConfig.java b/...her/src/main/java/org/dependencytrack/notification/publisher/SendMailPublisherConfig.java
@@ -44,6 +44,7 @@ class SendMailPublisherConfig {
     private final Provider<Optional<String>> passwordProvider;
     private final Provider<Optional<Boolean>> tlsEnabledProvider;
     private final Provider<Optional<Boolean>> trustCertificateProvider;
+    private final Provider<Optional<String>> emailPrefixProvider;
 
     SendMailPublisherConfig(
             @ConfigProperty(name = "dtrack.email.smtp.enabled") final Provider<Optional<Boolean>> smtpEnabledProvider,
@@ -53,7 +54,8 @@ class SendMailPublisherConfig {
             @ConfigProperty(name = "dtrack.email.smtp.username") final Provider<Optional<String>> usernameProvider,
             @ConfigProperty(name = "dtrack.email.smtp.password") final Provider<Optional<String>> passwordProvider,
             @ConfigProperty(name = "dtrack.email.smtp.ssltls") final Provider<Optional<Boolean>> tlsEnabledProvider,
-            @ConfigProperty(name = "dtrack.email.smtp.trustcert") final Provider<Optional<Boolean>> trustCertificateProvider
+            @ConfigProperty(name = "dtrack.email.smtp.trustcert") final Provider<Optional<Boolean>> trustCertificateProvider,
+            @ConfigProperty(name = "dtrack.email.subject.prefix") final Provider<Optional<String>> emailPrefixProvider
     ) {
         this.smtpEnabledProvider = smtpEnabledProvider;
         this.fromAddressProvider = fromAddressProvider;
@@ -63,12 +65,17 @@ class SendMailPublisherConfig {
         this.passwordProvider = passwordProvider;
         this.tlsEnabledProvider = tlsEnabledProvider;
         this.trustCertificateProvider = trustCertificateProvider;
+        this.emailPrefixProvider = emailPrefixProvider;
     }
 
     Optional<Boolean> isSmtpEnabled() {
         return smtpEnabledProvider.get();
     }
 
+    Optional<String> emailPrefix() {
+        return emailPrefixProvider.get();
+    }
+
     Optional<String> fromAddress() {
         return fromAddressProvider.get();
     }

diff --git a/...isher/src/test/java/org/dependencytrack/notification/publisher/SendMailPublisherTest.java b/...isher/src/test/java/org/dependencytrack/notification/publisher/SendMailPublisherTest.java
@@ -55,7 +55,8 @@ public Map<String, String> getConfigOverrides() {
                     Map.entry("dtrack.email.smtp.enabled", "true"),
                     Map.entry("dtrack.email.smtp.server.hostname", "localhost"),
                     Map.entry("dtrack.email.smtp.server.port", "${mailpit.smtp.port}"),
-                    Map.entry("dtrack.email.smtp.from.address", "[email protected]")
+                    Map.entry("dtrack.email.smtp.from.address", "[email protected]"),
+                    Map.entry("dtrack.email.subject.prefix", "[Dependency-Track]")
             );
         }