Merge pull request #1 from V1ncNet/release/2.0.0

Release v2.0.0

Author: V1ncNet

.github/workflows/maven.yml

@@ -0,0 +1,53 @@
+name: Java CI with Maven
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up AdoptOpenJDK 8
+        uses: actions/setup-java@v2
+        with:
+          java-version: '8'
+          distribution: 'adopt'
+      - name: Cache local Maven repository
+        uses: actions/cache@v2
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
+
+      - name: Lint sources
+        run: mvn -B checkstyle:check
+      - name: Compile sources
+        run: mvn -B compile test-compile
+      - name: Run tests
+        run: mvn -B test
+      - name: Package artifact
+        run: mvn -B -fae -DskipTests=true package
+
+      - name: Report Checkstyle results
+        if: always()
+        uses: jwgmeligmeyling/[email protected]
+        with:
+          path: '**/checkstyle-result.xml'
+      - name: Report Surefire results
+        if: always()
+        uses: ScaCap/action-surefire-report@v1
+
+      - name: Aggregate JavaDoc
+        if: github.ref == 'refs/heads/main'
+        run: mvn -B javadoc:aggregate
+      - name: Deploy API docs
+        if: github.ref == 'refs/heads/main'
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages
+          folder: target/site/apidocs

.gitignore

@@ -1,14 +1,12 @@
 ### Maven ###
 target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+pom.xml.next
+release.properties
+dependency-reduced-pom.xml
+buildNumber.properties
 
 ### IntelliJ IDEA ###
-.idea
-*.iws
 *.iml
-*.ipr
-
-### VS Code ###
-.vscode/
-
-### MacOS ###
-.DS_Store

.idea/.gitignore

@@ -1,6 +1,6 @@
                                  Apache License
                            Version 2.0, January 2004
-                        http://www.apache.org/licenses/
+                        https://www.apache.org/licenses/
 
    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
@@ -186,13 +186,13 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2021 Vincent Nadoll
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
 
-       http://www.apache.org/licenses/LICENSE-2.0
+       https://www.apache.org/licenses/LICENSE-2.0
 
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,

.idea/codeStyles/Project.xml

@@ -1,31 +1,80 @@
-Spring Boot DKIM JavaMail
-===
+# Spring Boot Mail Extensions
 
-This project provides an easy way to digitally sign your emails. Therefore, this project uses the
-[java-utils-mail-dkim](https://github.com/markenwerk/java-utils-mail-dkim) library from Markenwerk and extends Spring's
-JavaMailSender to sign MIME messages before they were transported to the SMTP server. To verify the signed parts of the
-email you must configure your DNS. This authentication method is called DKIM (DomainKeys Identified Mail).
+This project aims to extend Spring's `JavaMailSender` with useful features. Therefore, the library provides two advanced
+sender extensions. Library and starters are compatible with Spring Framework >5.2.x and Spring Boot >2.2.x
+
+
+## Library
+
+The library currently provides two combinable sender implementations.
+
+The `DkimJavaMailSender` uses Markenwerk's [java-utils-mail-dkim](https://github.com/markenwerk/java-utils-mail-dkim)
+library and extends Spring's `JavaMailSender` to sign MIME messages before they were transported to the SMTP server. To
+verify the signed parts of the email you must configure your DNS. This authentication method is called **DKIM**
+(DomainKeys Identified Mail). In case you are not using the starter, you must configure the `DkimSigner` yourself.
+
+The `ConcurrentJavaMailSender` enqueues any supported MIME message to be sent immediately or after a configurable
+cooldown. By splitting potential large amounts of messages into smaller batches your application is capable of **dealing
+with** common problems or restrictions of your SMTP server or provider, like **rate limits**. The dispatch happens on
+another thread, so you don't block your main thread in case of a **slow SMTP server**.
 
 
 ## Usage
 
-Include the `spring-boot-starter-dkim-javamail` dependency in your `pom.xml` and adjust your `application.properties` or
-`application.yml` as described in [Configuration](#Configuration).
+This project provides 4 artifacts. Depending on your scope and infrastructure you may want just the library. Include
+the `mail-extensions` and `utils-mail-dkim` libraries in your Spring Project **in case you don't want or can use the
+Starters**. Adjust your `pom.xml` as followed:
+
+```xml
+<dependency>
+    <groupId>de.vinado.spring</groupId>
+    <artifactId>mail-extensions</artifactId>
+    <version>2.0.0</version>
+</dependency>
+<dependency>
+    <groupId>net.markenwerk</groupId>
+    <artifactId>utils-mail-dkim</artifactId>
+    <version>1.4.0</version>
+</dependency>
+```
+
+---
+
+Those who use Spring Boot can choose between 3 Spring Boot starters.
+
+1. `mail-extensions-concurrent-javamail-spring-boot-starter`
+2. `mail-extensions-dkim-javamail-spring-boot-starter`
+3. `mail-extensions-all-spring-boot-starter`
+
+Include one of the above in your `pom.xml` and adjust your `application.properties` or `application.yml` as described in
+[Configuration](#Configuration).
 
 The starter, as well as the other artifacts are hosted in the
-[Maven Central Repository](https://search.maven.org/artifact/de.vinado.boot/spring-boot-starter-dkim-javamail/1.2.2/jar).
-You can use it with the following coordinates:
+[Maven Central Repository](https://search.maven.org/artifact/de.vinado.boot/mail-extensions-spring-boot/2.0.0/pom).
+You can use it with one of the following coordinates:
 
 ```xml
 <dependency>
     <groupId>de.vinado.boot</groupId>
-    <artifactId>spring-boot-starter-dkim-javamail</artifactId>
-    <version>1.2.2</version>
+    <artifactId>mail-extensions-concurrent-javamail-spring-boot-starter</artifactId>
+    <version>2.0.0</version>
+</dependency>
+
+<dependency>
+    <groupId>de.vinado.boot</groupId>
+    <artifactId>mail-extensions-dkim-javamail-spring-boot-starter</artifactId>
+    <version>2.0.0</version>
+</dependency>
+
+<dependency>
+    <groupId>de.vinado.boot</groupId>
+    <artifactId>mail-extensions-all-spring-boot-starter</artifactId>
+    <version>2.0.0</version>
 </dependency>
 ```
 
-Version `v1.0.0` is still available in the
-[JitPack repository](https://jitpack.io/#V1ncNet/spring-boot-dkim-javamail/v1.0.0).
+Version `v1.x` is still available in an archived [Git repository](https://github.com/V1ncNet/spring-boot-dkim-javamail).
+
 
 ## Setup
 
@@ -37,32 +86,43 @@ setup instructions on how to create an RSA keypair and properly configure DNS.
 
 ### Configuration
 
-The starter uses auto configuration to avoid Java-based adjustments. The mandatory configuration looks like this:
+The starter uses autoconfiguration to avoid Java-based adjustments. The mandatory configuration looks like this:
 
 ```properties
-dkim.signing-domain=domain.tld
-dkim.selector=default
-dkim.private-key=file:/path/to/your/private.key.der
-#dkim.private-key=classpath:/path/to/your/private.key.der
-#dkim.private-key=/path/to/your/private.key.der
+javamail.dkim.signing-domain=domain.tld
+javamail.dkim.selector=default
+javamail.dkim.private-key=file:/path/to/your/private.key.der
+#javamail.dkim.private-key=classpath:/path/to/your/private.key.der
 ```
 
 The example assumes your TXT record uses the domain `default._domainkey.domain.tld`. The following example contains
 optional properties which configures the DKIM signer itself:
 
 ```properties
-dkim.signer.identity=
-dkim.signer.header-canonicalization=SIMPLE
-dkim.signer.body-canonicalization=RELAXED
-dkim.signer.signing-algorithm=SHA256_WITH_RSA
-dkim.signer.length-param=true
-dkim.signer.copy-header-fields=false
-dkim.signer.check-domain-key=true
+javamail.dkim.signer.identity=
+javamail.dkim.signer.header-canonicalization=SIMPLE
+javamail.dkim.signer.body-canonicalization=RELAXED
+javamail.dkim.signer.signing-algorithm=SHA256_WITH_RSA
+javamail.dkim.signer.length-param=true
+javamail.dkim.signer.copy-header-fields=false
+javamail.dkim.signer.check-domain-key=true
 ```
 
 To learn more about the identity and canonicalization read the [specification](https://tools.ietf.org/html/rfc6376)
 about DKIM.
 
+---
+
+The concurrent sender can be configured as follows. This sender is deactivated by default.
+
+```properties
+javamail.concurrent.enabled=true
+javamail.concurrent.batch-size=20
+# 20 seconds cooldown
+javamail.concurrent.cooldown-millis=20000
+```
+
+
 ## Licence
 
 Apache License 2.0 - [Vinado](https://vinado.de) - Built with :heart: in Dresden