release 1.0.9

Author: Vitalii.Chornobryvyi

CHANGELOG.md

@@ -5,6 +5,10 @@ All _notable_ changes to this project will be documented in this file.
 The format is based on _[Keep a Changelog][keepachangelog]_, and this project
 adheres to _[Semantic Versioning][semver]_.
 
+## [1.0.9] (released: 2023-09-27)
+### Updated
+- allows for appending custom MIME headers to a message
+
 ## [1.0.8] (released: 2023-05-25)
 ### Updated
 - updated dependencies
@@ -55,6 +59,7 @@ adheres to _[Semantic Versioning][semver]_.
 - Add Import a list of bounces from CSV file API
 
 
+[1.0.9]: https://github.com/mailgun/mailgun-java/compare/release/1.0.8...release/1.0.9
 [1.0.8]: https://github.com/mailgun/mailgun-java/compare/release/1.0.7...release/1.0.8
 [1.0.7]: https://github.com/mailgun/mailgun-java/compare/release/1.0.6...release/1.0.7
 [1.0.6]: https://github.com/mailgun/mailgun-java/compare/release/1.0.5...release/1.0.6

README.md

@@ -76,7 +76,7 @@ Add the following to your `pom.xml`:
   <dependency>
     <groupId>com.mailgun</groupId>
     <artifactId>mailgun-java</artifactId>
-    <version>1.0.8</version>
+    <version>1.0.9</version>
   </dependency>
   ...
 </dependencies>
@@ -85,7 +85,7 @@ Add the following to your `pom.xml`:
 Gradle Groovy DSL .
 
 ```xml
-implementation 'com.mailgun:mailgun-java:1.0.8'
+implementation 'com.mailgun:mailgun-java:1.0.9'
 ```
 
 
@@ -264,6 +264,8 @@ More information:
     - [Send email (delay example)](#send-email-delay-example)
     - [Send email (reply-to example)](#send-email-reply-to-example)
     - [Send email (mailing list example)](#send-email-mailing-list-example)
+    - [Send email (sender example)](#send-email-sender-example)
+    - [Send email (with custom form property)](#send-email-with-custom-form-property)
     - [Send email(s) in MIME format](#send-mime-emails)
   - [Store Messages](#store-messages)
     - [Set up MailgunStoreMessagesApi](#Set-up-MailgunStoreMessagesApi)
@@ -623,6 +625,52 @@ Asynchronously send email(s).
         MessageResponse messageResponse = mailgunMessagesApi.sendMessage(DOMAIN, message);
 ```
 
+#### Send email (sender example)
+```java
+        Message message = Message.builder()
+		.from(EMAIL_FROM)
+		.to(EMAIL_TO)
+		.sender(SENDER_EMAIL)
+		.subject(SUBJECT)
+		.text(TEXT)
+		.build();
+
+		MessageResponse messageResponse = mailgunMessagesApi.sendMessage(DOMAIN, message);
+```
+or sender with name and email
+```java
+        Message message = Message.builder()
+                .from(EMAIL_FROM)
+                .to(EMAIL_TO)
+                .sender(EmailUtil.nameWithEmail(SENDER_NAME, SENDER_EMAIL))
+                .subject(SUBJECT)
+                .text(TEXT)
+                .build();
+
+        MessageResponse messageResponse = mailgunMessagesApi.sendMessage(DOMAIN, message);
+```
+
+#### Send email (with custom form property)
+You can send email(s) with your own custom dynamic form property with allowed prefixes such as: ```t:, o:, h:, v:``` with the followed by any arbitrary value.
+```java
+        MailgunMessagesApi mailgunMessagesApi = MailgunClient.config(PRIVATE_API_KEY)
+                .createApiWithRequestInterceptor(MailgunMessagesApi.class,
+                        FormPropertyRequestInterceptor.builder()
+                                .addProperty("h:Sender", EmailUtil.nameWithEmail(SENDER_NAME, SENDER_EMAIL))
+                                .addProperty("h:X-My-Header", "my_custom_header")
+                                .build()
+                );
+
+        Message message = Message.builder()
+                .from(EMAIL_FROM)
+                .to(EMAIL_TO)
+                .subject(SUBJECT)
+                .text(TEXT)
+                .build();
+
+        MessageResponse messageResponse = mailgunMessagesApi.sendMessage(DOMAIN, message);
+```
+
 #### Send MIME email(s)
 Send email(s) in MIME format
 ```java

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.mailgun</groupId>
     <artifactId>mailgun-java</artifactId>
-    <version>1.0.9-SNAPSHOT</version>
+    <version>1.0.9</version>
     <packaging>jar</packaging>
 
     <name>${project.groupId}:${project.artifactId}</name>

src/main/java/com/mailgun/client/MailgunClient.java

@@ -14,6 +14,7 @@
 import feign.Feign;
 import feign.Logger;
 import feign.Request;
+import feign.RequestInterceptor;
 import feign.Retryer;
 import feign.auth.BasicAuthRequestInterceptor;
 import feign.codec.ErrorDecoder;
@@ -186,6 +187,11 @@ public <T extends MailgunApi> T createApi(Class<T> apiType) {
             return getFeignBuilder().target(apiType, url);
         }
 
+		public <T extends MailgunApi> T createApiWithRequestInterceptor(Class<T> apiType, RequestInterceptor requestInterceptor) {
+			String url = MailgunApiUtil.getFullUrl(apiType, baseUrl);
+			return getFeignBuilder().requestInterceptor(requestInterceptor).target(apiType, url);
+		}
+
         public <T extends MailgunApi> T createAsyncApi(Class<T> apiType) {
             String url = MailgunApiUtil.getFullUrl(apiType, baseUrl);
             return getAsyncFeignBuilder().target(apiType, url);

src/main/java/com/mailgun/form/FormPropertyRequestInterceptor.java

@@ -0,0 +1,50 @@
+package com.mailgun.form;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.Map;
+
+import feign.RequestInterceptor;
+import feign.RequestTemplate;
+import feign.form.FormProperty;
+
+/**
+ * <p>
+ * Implementation of the {@link RequestInterceptor} for a creating custom dynamic {@link FormProperty}
+ * with allowed prefixes such as: {@code t:, o:, h:, v:} with the followed by any arbitrary value
+ * </p>
+ * @author Vitalii Chornobryvyi
+ */
+public class FormPropertyRequestInterceptor implements RequestInterceptor {
+	private final Map<String, Collection<String>> properties;
+
+	private FormPropertyRequestInterceptor(Map<String, Collection<String>> properties) {
+		this.properties = properties;
+	}
+
+	public static Builder builder() {
+		return new Builder();
+	}
+
+	@Override
+	public void apply(RequestTemplate requestTemplate) {
+		requestTemplate.queries(properties);
+	}
+
+	public static class Builder {
+		private final Map<String, Collection<String>> properties = new HashMap<>();
+
+		private Builder() {
+		}
+
+		public Builder addProperty(String propertyName, String propertyValue) {
+			properties.computeIfAbsent(propertyName, key -> new ArrayList<>()).add(propertyValue);
+			return this;
+		}
+
+		public FormPropertyRequestInterceptor build() {
+			return new FormPropertyRequestInterceptor(properties);
+		}
+	}
+}

src/main/java/com/mailgun/model/message/Message.java

@@ -249,6 +249,14 @@ public class Message {
     @FormProperty("h:Reply-To")
     String replyTo;
 
+	/**
+	 * <p>
+	 * Specify Sender address
+	 * </p>
+	 */
+	@FormProperty("h:Sender")
+	String sender;
+
     /**
      * <p>
      * A valid JSON-encoded dictionary, where key is a plain recipient address and value is a dictionary
@@ -657,6 +665,19 @@ public MessageBuilder replyTo(String replyTo) {
             return this;
         }
 
+		/**
+		 * <p>
+		 * Specify Sender address
+		 * </p>
+		 *
+		 * @param sender Sender address
+		 * @return Returns a reference to this object so that method calls can be chained together.
+		 */
+		public MessageBuilder sender(String sender) {
+			this.sender = sender;
+			return this;
+		}
+
         /**
          * <p>
          * A dictionary, where the key is a plain recipient address