- moved all modularized code into their own modules and fixed dependency issues (#183),

- restructured all packages (#183),
- added support for CalendarMethod in CLI (#156),
- fixed JavaDoc for Maven multi-module project (#183)
- fixed all JavaDoc problems (#156)

Author: bbottema

pom.xml

@@ -30,26 +30,10 @@
 
         <!-- core dependencies -->
         <dependency>
-            <groupId>com.sun.mail</groupId>
-            <artifactId>javax.mail</artifactId>
-            <version>1.6.2</version>
-        </dependency>
-        <dependency>
-            <groupId>com.github.bbottema</groupId>
-            <artifactId>emailaddress-rfc2822</artifactId>
-            <version>1.1.2</version>
-        </dependency>
-        <dependency>
-            <groupId>org.mnode.ical4j</groupId>
-            <artifactId>ical4j</artifactId>
-            <version>2.2.0</version>
-            <scope>test</scope>
-        </dependency>
-        <dependency><!-- Annotation processor -->
-            <groupId>com.github.therapi</groupId>
-            <artifactId>therapi-runtime-javadoc-scribe</artifactId>
-            <version>0.9.0</version>
-            <scope>provided</scope><!-- makes library mandatory if we should support CLI (even optionally) -->
+            <groupId>org.simplejavamail</groupId>
+            <artifactId>core-module</artifactId>
+            <version>${library.version}</version>
+            <scope>compile</scope>
         </dependency>
 
         <!-- optional support modules -->
@@ -65,43 +49,20 @@
             <version>${library.version}</version>
             <optional>true</optional>
         </dependency>
-        <!--<dependency>-->
-            <!--<groupId>org.simplejavamail</groupId>-->
-            <!--<artifactId>spring-module</artifactId>-->
-            <!--<version>${library.version}</version>-->
-            <!--<optional>true</optional>-->
-        <!--</dependency>-->
+
+        <!-- testing -->
         <dependency>
             <groupId>org.simplejavamail</groupId>
-            <artifactId>cli-module</artifactId>
+            <artifactId>core-test-module</artifactId>
             <version>${library.version}</version>
-            <optional>true</optional>
-        </dependency>
-
-        <!-- optional Spring support -->
-
-
-        <!-- spring support (optional) -->
-        <dependency>
-            <groupId>org.springframework</groupId>
-            <artifactId>spring-core</artifactId>
-            <version>${spring.version}</version>
-            <scope>compile</scope>
-        </dependency>
-        <dependency>
-            <groupId>org.springframework</groupId>
-            <artifactId>spring-context</artifactId>
-            <version>${spring.version}</version>
-            <scope>compile</scope>
+            <scope>test</scope>
         </dependency>
         <dependency>
-            <groupId>org.springframework</groupId>
-            <artifactId>spring-beans</artifactId>
-            <version>${spring.version}</version>
-            <scope>compile</scope>
+            <groupId>org.mnode.ical4j</groupId>
+            <artifactId>ical4j</artifactId>
+            <version>2.2.0</version>
+            <scope>test</scope>
         </dependency>
-
-        <!-- testing -->
         <dependency><!-- SMTP test server -->
             <groupId>org.subethamail</groupId>
             <artifactId>subethasmtp</artifactId>
@@ -131,7 +92,7 @@
                 </executions>
                 <configuration>
                     <classes>
-                        <param>org.simplejavamail.email.Email</param>
+                        <param>org.simplejavamail.api.email.Email</param>
                     </classes>
                 </configuration>
             </plugin>

src/main/java/org/simplejavamail/MailException.java

@@ -7,11 +7,11 @@
  * <p>
  * A note on the Javadoc-to-CLI-usage conversion: Everything is converted generically with the following exception:
  * <ul>
- * <li>[<strong>{@code (?i)Alias for:?}</strong>]:<br/>Javadoc with an "Alias for: {@ocde {@link}}" occurrence (or variation) are processed
+ * <li>[<strong>{@code (?i)Alias for:?}</strong>]:<br>Javadoc with an "Alias for: {@code {@link}}" occurrence (or variation) are processed
  * specially</li>
- * <li>[<strong>{@code (?i)(?:delegates|delegating) to:?}</strong>]:<br/>Javadoc with an "Delegates to: {@ocde {@link}}" occurrence (or variation) are
+ * <li>[<strong>{@code (?i)(?:delegates|delegating) to:?}</strong>]:<br>Javadoc with an "Delegates to: {@code {@link}}" occurrence (or variation) are
  * processed specially</li>
- * <li>[<strong>{@code (?i)(?s).*(?<examples> examples?:\s*)}</strong>]:<br/>Javadoc with an "Examples: HTML list of examples" occurrence (or
+ * <li>[<strong>{@code (?i)(?s).*(?<examples> examples?:\s*)}</strong>]:<br>Javadoc with an "Examples: HTML list of examples" occurrence (or
  * variation) are processed specially</li>
  * </ul>
  */

src/main/java/org/simplejavamail/cli/SimpleJavaMail.java

@@ -3,10 +3,11 @@
 import org.simplejavamail.converter.internal.mimemessage.MimeMessageParser;
 import org.simplejavamail.converter.internal.mimemessage.MimeMessageParser.ParsedMimeMessageComponents;
 import org.simplejavamail.converter.internal.mimemessage.MimeMessageProducerHelper;
-import org.simplejavamail.email.CalendarMethod;
-import org.simplejavamail.email.Email;
+import org.simplejavamail.api.email.CalendarMethod;
+import org.simplejavamail.api.email.Email;
 import org.simplejavamail.email.EmailBuilder;
-import org.simplejavamail.email.EmailPopulatingBuilder;
+import org.simplejavamail.api.email.EmailPopulatingBuilder;
+import org.simplejavamail.email.internal.EmailStartingBuilderImpl;
 import org.simplejavamail.internal.modules.ModuleLoader;
 
 import javax.activation.DataSource;
@@ -33,10 +34,11 @@
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static org.simplejavamail.internal.util.MiscUtil.extractCID;
 import static org.simplejavamail.internal.util.MiscUtil.readInputStreamToString;
+import static org.simplejavamail.internal.util.Preconditions.assumeNonNull;
 import static org.simplejavamail.internal.util.Preconditions.checkNonEmptyArgument;
 
 /**
- * Utility to help convert {@link org.simplejavamail.email.Email} instances to other formats (MimeMessage, EML etc.) and vice versa.
+ * Utility to help convert {@link org.simplejavamail.api.email.Email} instances to other formats (MimeMessage, EML etc.) and vice versa.
  *
  * If you use the Outlook parsing API, make sure you load the following dependency: <em>org.simplejavamail::outlook-message-parser</em>
  */
@@ -74,18 +76,20 @@ public static EmailPopulatingBuilder mimeMessageToEmailBuilder(@Nonnull final Mi
 	/**
 	 * @param msgData The content of an Outlook (.msg) message from which to create the {@link Email}.
 	 */
+	@SuppressWarnings("deprecation")
 	public static Email outlookMsgToEmail(@Nonnull final String msgData) {
-		return ModuleLoader.loadOutlookModule().outlookMsgToEmail(msgData);
+		return ModuleLoader.loadOutlookModule().outlookMsgToEmail(msgData, new EmailStartingBuilderImpl());
 	}
 
 	/**
 	 * @param msgFile The content of an Outlook (.msg) message from which to create the {@link Email}.
 	 */
+	@SuppressWarnings("deprecation")
 	public static Email outlookMsgToEmail(@Nonnull final File msgFile) {
 		if (!MSG_PATH_MATCHER.matches(msgFile.toPath())) {
 			throw new EmailConverterException(format(EmailConverterException.FILE_NOT_RECOGNIZED_AS_OUTLOOK, msgFile));
 		}
-		return ModuleLoader.loadOutlookModule().outlookMsgToEmail(msgFile);
+		return ModuleLoader.loadOutlookModule().outlookMsgToEmail(msgFile, new EmailStartingBuilderImpl());
 	}
 
 	/**
@@ -98,8 +102,9 @@ public static Email outlookMsgToEmail(@Nonnull final InputStream msgInputStream)
 	/**
 	 * @param msgInputStream The content of an Outlook (.msg) message from which to create the {@link Email}.
 	 */
+	@SuppressWarnings("deprecation")
 	public static EmailPopulatingBuilder outlookMsgToEmailBuilder(@Nonnull final InputStream msgInputStream) {
-		return ModuleLoader.loadOutlookModule().outlookMsgToEmailBuilder(msgInputStream);
+		return ModuleLoader.loadOutlookModule().outlookMsgToEmailBuilder(msgInputStream, new EmailStartingBuilderImpl());
 	}
 
 	/**
@@ -339,7 +344,7 @@ private static void buildEmailFromMimeMessage(@Nonnull final EmailPopulatingBuil
 		builder.withHTMLText(parsed.getHtmlContent());
 
 		if (parsed.getCalendarMethod() != null) {
-			builder.withCalendarText(CalendarMethod.valueOf(parsed.getCalendarMethod()), parsed.getCalendarContent());
+			builder.withCalendarText(CalendarMethod.valueOf(parsed.getCalendarMethod()), assumeNonNull(parsed.getCalendarContent()));
 		}
 
 		for (final Map.Entry<String, DataSource> cid : parsed.getCidMap().entrySet()) {

src/main/java/org/simplejavamail/converter/EmailConverter.java

@@ -1,10 +1,8 @@
 package org.simplejavamail.converter.internal.mimemessage;
 
-import net.markenwerk.utils.mail.dkim.DkimMessage;
-import net.markenwerk.utils.mail.dkim.DkimSigner;
-import org.simplejavamail.email.AttachmentResource;
-import org.simplejavamail.email.Email;
-import org.simplejavamail.email.Recipient;
+import org.simplejavamail.api.email.AttachmentResource;
+import org.simplejavamail.api.email.Email;
+import org.simplejavamail.api.email.Recipient;
 import org.simplejavamail.internal.modules.ModuleLoader;
 
 import javax.activation.DataHandler;
@@ -28,6 +26,7 @@
 
 import static java.lang.String.format;
 import static org.simplejavamail.internal.util.MiscUtil.valueNullOrEmpty;
+import static org.simplejavamail.internal.util.Preconditions.checkNonEmptyArgument;
 
 /**
  * Helper class that produces and populates a mime messages. Deals with javax.mail RFC MimeMessage stuff, as well as DKIM signing.
@@ -202,14 +201,14 @@ static void setHeaders(final Email email, final Message message)
 		}
 
 		if (email.isUseDispositionNotificationTo()) {
-			final Address address = new InternetAddress(email.getDispositionNotificationTo().getAddress(),
-					email.getDispositionNotificationTo().getName(), CHARACTER_ENCODING);
+			final Recipient dispositionTo = checkNonEmptyArgument(email.getDispositionNotificationTo(), "dispositionNotificationTo");
+			final Address address = new InternetAddress(dispositionTo.getAddress(), dispositionTo.getName(), CHARACTER_ENCODING);
 			message.setHeader("Disposition-Notification-To", address.toString());
 		}
 
 		if (email.isUseReturnReceiptTo()) {
-			final Address address = new InternetAddress(email.getReturnReceiptTo().getAddress(),
-					email.getReturnReceiptTo().getName(), CHARACTER_ENCODING);
+			final Recipient returnReceiptTo = checkNonEmptyArgument(email.getReturnReceiptTo(), "returnReceiptTo");
+			final Address address = new InternetAddress(returnReceiptTo.getAddress(), returnReceiptTo.getName(), CHARACTER_ENCODING);
 			message.setHeader("Return-Receipt-To", address.toString());
 		}
 	}
@@ -257,29 +256,23 @@ static String determineResourceName(final AttachmentResource attachmentResource,
 			resourceName = "resource" + UUID.randomUUID();
 		}
 		if (includeExtension && !valueNullOrEmpty(datasourceName)) {
-			@SuppressWarnings("UnnecessaryLocalVariable") final
-			String possibleFilename = datasourceName;
+			@SuppressWarnings("UnnecessaryLocalVariable")
+			final String possibleFilename = datasourceName;
 			if (!resourceName.contains(".") && possibleFilename.contains(".")) {
-				final String extension = possibleFilename.substring(possibleFilename.lastIndexOf("."), possibleFilename.length());
+				final String extension = possibleFilename.substring(possibleFilename.lastIndexOf("."));
 				if (!resourceName.endsWith(extension)) {
 					resourceName += extension;
 				}
 			}
 		} else if (!includeExtension && resourceName.contains(".") && resourceName.equals(datasourceName)) {
-			final String extension = resourceName.substring(resourceName.lastIndexOf("."), resourceName.length());
+			final String extension = resourceName.substring(resourceName.lastIndexOf("."));
 			resourceName = resourceName.replace(extension, "");
 		}
 		return resourceName;
 	}
 
 	/**
-	 * Primes the {@link MimeMessage} instance for signing with DKIM. The signing itself is performed by {@link DkimMessage} and {@link DkimSigner}
-	 * during the physical sending of the message.
-	 *
-	 * @param messageToSign                 The message to be signed when sent.
-	 * @param emailContainingSigningDetails The {@link Email} that contains the relevant signing information
-	 *
-	 * @return The original mime message wrapped in a new one that performs signing when sent.
+	 * @see org.simplejavamail.internal.modules.DKIMModule#signMessageWithDKIM(MimeMessage, Email)
 	 */
 	public static MimeMessage signMessageWithDKIM(final MimeMessage messageToSign, final Email emailContainingSigningDetails) {
 		return ModuleLoader.loadDKIMModule().signMessageWithDKIM(messageToSign, emailContainingSigningDetails);

src/main/java/org/simplejavamail/converter/internal/mimemessage/DKIMSigner.java

@@ -1,6 +1,6 @@
 package org.simplejavamail.converter.internal.mimemessage;
 
-import org.simplejavamail.email.Email;
+import org.simplejavamail.api.email.Email;
 
 import javax.annotation.Nonnull;
 import javax.mail.MessagingException;

src/main/java/org/simplejavamail/converter/internal/mimemessage/MimeMessageHelper.java

@@ -1,6 +1,6 @@
 package org.simplejavamail.converter.internal.mimemessage;
 
-import org.simplejavamail.email.Email;
+import org.simplejavamail.api.email.Email;
 
 import javax.annotation.Nonnull;
 import javax.mail.MessagingException;

src/main/java/org/simplejavamail/converter/internal/mimemessage/MimeMessageProducer.java

@@ -1,6 +1,6 @@
 package org.simplejavamail.converter.internal.mimemessage;
 
-import org.simplejavamail.email.Email;
+import org.simplejavamail.api.email.Email;
 
 import javax.annotation.Nonnull;
 import javax.mail.MessagingException;

src/main/java/org/simplejavamail/converter/internal/mimemessage/MimeMessageProducerAlternative.java

@@ -1,6 +1,6 @@
 package org.simplejavamail.converter.internal.mimemessage;
 
-import org.simplejavamail.email.Email;
+import org.simplejavamail.api.email.Email;
 
 import javax.annotation.Nonnull;
 import javax.mail.MessagingException;

src/main/java/org/simplejavamail/converter/internal/mimemessage/MimeMessageProducerHelper.java

@@ -1,6 +1,6 @@
 package org.simplejavamail.converter.internal.mimemessage;
 
-import org.simplejavamail.email.Email;
+import org.simplejavamail.api.email.Email;
 
 import javax.annotation.Nonnull;
 import javax.mail.MessagingException;
@@ -14,6 +14,7 @@ boolean compatibleWithEmail(@Nonnull Email email) {
 		return emailContainsMixedContent(email) && !emailContainsRelatedContent(email) && emailContainsAlternativeContent(email);
 	}
 
+	@SuppressWarnings("Duplicates")
 	@Override
 	void populateMimeMessageMultipartStructure(@Nonnull MimeMessage message, @Nonnull Email email) throws MessagingException {
 		MultipartStructureWrapper multipartStructureWrapper = new MultipartStructureWrapper();
@@ -33,6 +34,7 @@ private static class MultipartStructureWrapper {
 		private final MimeMultipart multipartRootMixed;
 		private final MimeMultipart multipartAlternativeMessages;
 
+		@SuppressWarnings("Duplicates")
 		private MultipartStructureWrapper() {
 			multipartRootMixed = new MimeMultipart("mixed");
 			final MimeBodyPart contentAlternativeMessages = new MimeBodyPart();

src/main/java/org/simplejavamail/converter/internal/mimemessage/MimeMessageProducerMixed.java

@@ -1,6 +1,6 @@
 package org.simplejavamail.converter.internal.mimemessage;
 
-import org.simplejavamail.email.Email;
+import org.simplejavamail.api.email.Email;
 
 import javax.annotation.Nonnull;
 import javax.mail.MessagingException;
@@ -14,6 +14,7 @@ boolean compatibleWithEmail(@Nonnull Email email) {
 		return emailContainsMixedContent(email) && emailContainsRelatedContent(email) && !emailContainsAlternativeContent(email);
 	}
 
+	@SuppressWarnings("Duplicates")
 	@Override
 	public void populateMimeMessageMultipartStructure(@Nonnull MimeMessage message, @Nonnull Email email) throws MessagingException {
 		MultipartStructureWrapper multipartStructureWrapper = new MultipartStructureWrapper();