release 1.1.1

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.1.1] (released: 2023-12-12)
+### Updated
+- add ability for primary accounts to make API calls on behalf of their subaccounts, e.g. sending messages, managing mailing lists, etc.
+
 ## [1.1.0] (released: 2023-10-23)
 ### Updated
 - add ability to get the first / last / next / previous page data.
@@ -63,7 +67,8 @@ adheres to _[Semantic Versioning][semver]_.
 - Add Import a list of bounces from CSV file API
 
 
-[1.1.0]: https://github.com/mailgun/mailgun-java/compare/release/1.0.8...release/1.1.0
+[1.1.1]: https://github.com/mailgun/mailgun-java/compare/release/1.1.0...release/1.1.1
+[1.1.0]: https://github.com/mailgun/mailgun-java/compare/release/1.0.9...release/1.1.0
 [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

README.md

@@ -76,7 +76,7 @@ Add the following to your `pom.xml`:
   <dependency>
     <groupId>com.mailgun</groupId>
     <artifactId>mailgun-java</artifactId>
-    <version>1.1.0</version>
+    <version>1.1.1</version>
   </dependency>
   ...
 </dependencies>
@@ -85,7 +85,7 @@ Add the following to your `pom.xml`:
 Gradle Groovy DSL .
 
 ```xml
-implementation 'com.mailgun:mailgun-java:1.1.0'
+implementation 'com.mailgun:mailgun-java:1.1.1'
 ```
 
 
@@ -154,6 +154,22 @@ You can specify your own logLevel, retryer, logger, errorDecoder, options.
                 .options(new Request.Options(10, TimeUnit.SECONDS, 60, TimeUnit.SECONDS, true))
 ```
 
+#### Mailgun client configuration with request interceptor for all API calls
+
+You can add your multiple custom:
+
+1) request header in format: ```(headerName, headerValue)```
+2) form property with allowed prefixes such as: ```t:, o:, h:, v:``` with the followed by any arbitrary value.
+```java
+        MailgunMessagesApi mailgunMessagesApi = MailgunClient.config(API_KEY)
+            .createApiWithRequestInterceptor(MailgunMessagesApi.class,
+                MailgunRequestInterceptor.builder()
+                    .addHeader(HEADER_ON_BEHALF_OF, SUBACCOUNT_ACCOUNT_ID)
+                    .addProperty("h:X-My-Header", "my_custom_header")
+                    .build()
+            );
+```
+
 #### Mailgun client configuration example for the [Mailgun sending emails API](https://documentation.mailgun.com/en/latest/api-sending.html)
 
 ```java
@@ -655,7 +671,7 @@ You can send email(s) with your own custom dynamic form property with allowed pr
 ```java
         MailgunMessagesApi mailgunMessagesApi = MailgunClient.config(PRIVATE_API_KEY)
                 .createApiWithRequestInterceptor(MailgunMessagesApi.class,
-                        FormPropertyRequestInterceptor.builder()
+                        MailgunRequestInterceptor.builder()
                                 .addProperty("h:Sender", EmailUtil.nameWithEmail(SENDER_NAME, SENDER_EMAIL))
                                 .addProperty("h:X-My-Header", "my_custom_header")
                                 .build()

pom.xml

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

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

@@ -1,5 +1,7 @@
 package com.mailgun.form;
 
+import com.mailgun.interceptors.MailgunRequestInterceptor;
+
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.HashMap;
@@ -15,7 +17,10 @@
  * with allowed prefixes such as: {@code t:, o:, h:, v:} with the followed by any arbitrary value
  * </p>
  * @author Vitalii Chornobryvyi
+ * @deprecated This class is deprecated and will be replaced by {@link MailgunRequestInterceptor} after 1st of the March 2024.
+ * Please consider migrating to the new class for future updates.
  */
+@Deprecated
 public class FormPropertyRequestInterceptor implements RequestInterceptor {
 	private final Map<String, Collection<String>> properties;
 

src/main/java/com/mailgun/interceptors/MailgunRequestInterceptor.java

@@ -0,0 +1,66 @@
+package com.mailgun.interceptors;
+
+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;
+
+/**
+ * <h3>
+ * Implementation of the {@link RequestInterceptor}
+ * </h3>
+ * <p>
+ * for a creating:
+ * </p>
+ * <ul>
+ *     <li>
+ *         {@link FormProperty} with allowed prefixes such as: {@code t:, o:, h:, v:} with the followed by any arbitrary value
+ *     </li>
+ *     <li>
+ *         request header in format: {@code .addHeader(headerName, headerValue)}
+ *     </li>
+ * </ul>
+ * @author Vitalii Chornobryvyi
+ */
+public class MailgunRequestInterceptor implements RequestInterceptor {
+	private final Map<String, Collection<String>> headers;
+	private final Map<String, Collection<String>> properties;
+
+	private MailgunRequestInterceptor(Map<String, Collection<String>> headers, Map<String, Collection<String>> properties) {
+		this.headers = headers;
+		this.properties = properties;
+	}
+
+	public static Builder builder() {
+		return new Builder();
+	}
+
+	@Override
+	public void apply(RequestTemplate requestTemplate) {
+		requestTemplate.headers(headers);
+		requestTemplate.queries(properties);
+	}
+
+	public static class Builder {
+		private final Map<String, Collection<String>> headers = new HashMap<>();
+		private final Map<String, Collection<String>> properties = new HashMap<>();
+
+		public Builder addHeader(String headerName, String headerValue) {
+			headers.computeIfAbsent(headerName, key -> new ArrayList<>()).add(headerValue);
+			return this;
+		}
+
+		public Builder addProperty(String propertyName, String propertyValue) {
+			properties.computeIfAbsent(propertyName, key -> new ArrayList<>()).add(propertyValue);
+			return this;
+		}
+
+		public MailgunRequestInterceptor build() {
+			return new MailgunRequestInterceptor(headers, properties);
+		}
+	}
+}

src/main/java/com/mailgun/util/Constants.java

@@ -10,6 +10,8 @@ public class Constants {
 
     public static final String ENGLISH = "en";
 
+	public static final String HEADER_ON_BEHALF_OF = "X-Mailgun-On-Behalf-Of";
+
 //    "Z" ==> "+0900"
     public static final String RFC_2822_DATE_TIME_PATTERN_TIME_ZONE_NUMERIC = "EEE, dd MMM yyyy HH:mm:ss Z";
 //    "z" ==> "UTC"