Revert originalId / originalSentDate, as it doesn't make sense and makes things significantly more difficult to understand

Author: bbottema

modules/core-module/src/main/java/org/simplejavamail/api/email/Email.java

@@ -196,12 +196,6 @@ public class Email implements Serializable {
 	@Nullable
 	private final Date sentDate;
 
-	/**
-	 * @see EmailPopulatingBuilder#getOriginalSentDate()
-	 */
-	@Nullable
-	private final Date originalSentDate;
-
 	/**
 	 * Simply transfers everything from {@link EmailPopulatingBuilder} to this Email instance.
 	 *
@@ -247,7 +241,6 @@ public Email(@NotNull final EmailPopulatingBuilder builder) {
 		originalSmimeDetails = builder.getOriginalSmimeDetails();
 
 		sentDate = builder.getSentDate();
-		originalSentDate = builder.getOriginalSentDate();
 
 		x509CertificateForSmimeEncryption = builder.getX509CertificateForSmimeEncryption();
 		pkcs12ConfigForSmimeSigning = builder.getPkcs12ConfigForSmimeSigning();
@@ -326,19 +319,15 @@ public boolean equals(final Object o) {
 	@Override
 	public String toString() {
 		String s = "Email{" +
-				"\n\tid=" + id;
-		if (originalSentDate != null) {
-			s += "\n\toriginalSentDate=" + originalSentDate;
-		}
-		s += "\n\tsentDate=" + sentDate +
+				"\n\tid=" + id + ("\n\tsentDate=" + sentDate +
 				"\n\tfromRecipient=" + fromRecipient +
 				",\n\treplyToRecipient=" + replyToRecipient +
 				",\n\tbounceToRecipient=" + bounceToRecipient +
 				",\n\ttext='" + text + '\'' +
 				",\n\ttextHTML='" + textHTML + '\'' +
 				",\n\ttextCalendar='" + textCalendar + '\'' +
 				",\n\tsubject='" + subject + '\'' +
-				",\n\trecipients=" + recipients;
+				",\n\trecipients=" + recipients);
 		if (!MiscUtil.valueNullOrEmpty(dkimSigningDomain)) {
 			s += ",\n\tapplyDKIMSignature=" + true +
 					",\n\t\tdkimSelector=" + dkimSelector +
@@ -612,12 +601,4 @@ public OriginalSmimeDetails getOriginalSmimeDetails() {
 	public Date getSentDate() {
 		return sentDate;
 	}
-
-	/**
-	 * @see EmailPopulatingBuilder#getOriginalSentDate()
-	 */
-	@Nullable
-	public Date getOriginalSentDate() {
-		return originalSentDate;
-	}
 }

modules/core-module/src/main/java/org/simplejavamail/api/email/EmailPopulatingBuilder.java

@@ -38,7 +38,7 @@ public interface EmailPopulatingBuilder {
 	/**
 	 * Sets optional ID to a fixed value, which is otherwise generated by the underlying JavaMail framework when sending the email.
 	 * <p>
-	 * <strong>Note 1:</strong> Note that ID can only ever be filled by end-users for sending an email. This library will never fill this field when converting a MimeMessage.
+	 * <strong>Note 1:</strong> ID is user-controlled. Only when converting an email, Simple Java Mail might fill the sent-date.
 	 * <br>
 	 * <strong>Note 2:</strong> The id-format should be conform <a href="https://tools.ietf.org/html/rfc5322#section-3.6.4">rfc5322#section-3.6.4</a>
 	 *
@@ -1179,7 +1179,7 @@ EmailPopulatingBuilder signWithDomainKey(@NotNull InputStream dkimPrivateKeyInpu
 	 * When the an email is sent it is converted to a MimeMessage at which time the sent-date is filled with the current date. With this method
 	 * this can be fixed to a date of choice.
 	 * <p>
-	 * Note that the sent date is never filled by Simple Java Mail, for example when converting from an Outlook or MimeMessage to Email.
+	 * <strong>Note:</strong> the sent date is user-controlled. Only when converting an email, Simple Java Mail might fill the sent-date.
 	 *
 	 * @param sentDate The date to use as sent date.
 	 */
@@ -1489,10 +1489,4 @@ EmailPopulatingBuilder signWithDomainKey(@NotNull InputStream dkimPrivateKeyInpu
 	 */
 	@Nullable
 	Date getSentDate();
-
-	/**
-	 * Contains the original sent-date when converting an existing message to Email. Not used when creating new mails.
-	 */
-	@Nullable
-	Date getOriginalSentDate();
 }

modules/core-module/src/main/java/org/simplejavamail/api/email/EqualsHelper.java

@@ -9,17 +9,22 @@
 /**
  * Util class to get rid of some boilerplate code in the core classes. The equals code was needed to analyze junit test errors.
  * <p>
- * Initial equals code generated by IntelliJ, expanded to manually compare objects that don't override {@link Object#equals(Object)} (Recipient and DataSource
- * implementations).
+ * Initial equals code generated by IntelliJ, expanded to manually compare objects that don't override {@link Object#equals(Object)} (Recipient and DataSource implementations).
  */
 @SuppressWarnings("SimplifiableIfStatement")
-final class EqualsHelper {
+public final class EqualsHelper {
 
 	@SuppressWarnings("WeakerAccess")
 	public static boolean equalsEmail(final Email email1, final Email email2) {
 		if (email1.getFromRecipient() != null ? !isEqualRecipient(email1.getFromRecipient(), email2.getFromRecipient()) : email2.getFromRecipient() != null) {
 			return false;
 		}
+		if (email1.getId() != null ? !email1.getId().equals(email2.getId()) : email2.getId() != null) {
+			return false;
+		}
+		if (email1.getSentDate() != null ? !email1.getSentDate().equals(email2.getSentDate()) : email2.getSentDate() != null) {
+			return false;
+		}
 		if (email1.getReplyToRecipient() != null ? !isEqualRecipient(email1.getReplyToRecipient(), email2.getReplyToRecipient()) :
 				email2.getReplyToRecipient() != null) {
 			return false;

modules/simple-java-mail/src/main/java/org/simplejavamail/converter/EmailConverter.java

@@ -582,7 +582,7 @@ private static EmailPopulatingBuilder buildEmailFromMimeMessage(@NotNull final E
 		checkNonEmptyArgument(builder, "emailBuilder");
 		checkNonEmptyArgument(parsed, "parsedMimeMessageComponents");
 		if (parsed.getSentDate() != null) {
-			((InternalEmailPopulatingBuilder) builder).withOriginalSentDate(parsed.getSentDate());
+			builder.fixingSentDate(parsed.getSentDate());
 		}
 		if (parsed.getFromAddress() != null) {
 			builder.from(parsed.getFromAddress().getPersonal(), parsed.getFromAddress().getAddress());

modules/simple-java-mail/src/main/java/org/simplejavamail/email/internal/EmailPopulatingBuilderImpl.java

@@ -244,12 +244,6 @@ public class EmailPopulatingBuilderImpl implements InternalEmailPopulatingBuilde
 	@Nullable
 	private Date sentDate;
 
-	/**
-	 * @see EmailPopulatingBuilder#getOriginalSentDate()
-	 */
-	@Nullable
-	private Date originalSentDate;
-
 	/**
 	 * @see EmailStartingBuilder#startingBlank()
 	 */
@@ -1736,16 +1730,6 @@ public EmailPopulatingBuilder fixingSentDate(@NotNull final Date sentDate) {
 		return this;
 	}
 
-	/**
-	 * @see EmailPopulatingBuilder#getOriginalSentDate()
-	 */
-	@Override
-	@NotNull
-	public InternalEmailPopulatingBuilder withOriginalSentDate(@NotNull final Date originalSentDate) {
-		this.originalSentDate = originalSentDate;
-		return this;
-	}
-
 	/**
 	 * @see EmailPopulatingBuilder#notMergingSingleSMIMESignedAttachment()
 	 */
@@ -2175,13 +2159,4 @@ public X509Certificate getX509CertificateForSmimeEncryption() {
 	public Date getSentDate() {
 		return sentDate;
 	}
-
-	/**
-	 * @see EmailPopulatingBuilder#getOriginalSentDate()
-	 */
-	@Override
-	@Nullable
-	public Date getOriginalSentDate() {
-		return originalSentDate;
-	}
 }

modules/simple-java-mail/src/main/java/org/simplejavamail/email/internal/EmailStartingBuilderImpl.java

@@ -208,9 +208,6 @@ public EmailPopulatingBuilder copying(@NotNull final Email email) {
 		builder.withEmbeddedImages(email.getEmbeddedImages());
 		builder.withAttachments(email.getAttachments());
 		((InternalEmailPopulatingBuilder) builder).withHeaders(email.getHeaders(), true);
-		if (email.getOriginalSentDate() != null) {
-			((InternalEmailPopulatingBuilder) builder).withOriginalSentDate(email.getOriginalSentDate());
-		}
 		if (email.getSentDate() != null) {
 			builder.fixingSentDate(email.getSentDate());
 		}

modules/simple-java-mail/src/main/java/org/simplejavamail/email/internal/InternalEmailPopulatingBuilder.java

@@ -8,7 +8,6 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import javax.mail.internet.MimeMessage;
-import java.util.Date;
 import java.util.List;
 import java.util.Map;
 
@@ -22,5 +21,4 @@ public interface InternalEmailPopulatingBuilder  extends EmailPopulatingBuilder
 	@NotNull InternalEmailPopulatingBuilder withDecryptedAttachments(List<AttachmentResource> decryptedAttachments);
 	@NotNull InternalEmailPopulatingBuilder withSmimeSignedEmail(@NotNull Email smimeSignedEmail);
 	@NotNull InternalEmailPopulatingBuilder withOriginalSmimeDetails(@NotNull OriginalSmimeDetails originalSmimeDetails);
-	@NotNull InternalEmailPopulatingBuilder withOriginalSentDate(@NotNull Date originalSentDate);
 }

modules/simple-java-mail/src/test/java/org/simplejavamail/internal/smimesupport/TestSmimeAttachments.java

@@ -72,6 +72,7 @@ public void testSMIMEMessageFromOutlookMsgWithDefaultMergeBehavior() {
 		EmailPopulatingBuilder fromEmlBuilder = EmailConverter.emlToEmailBuilder(new File(RESOURCE_FOLDER + "/SMIME (signed and clear text).eml"));
 		Email emailExpectedFromEml = fromEmlBuilder
 				.clearId() // set by Outlook when sending, so is missing in the saved .msg from before sending
+				.clearSentDate() // same
 				.clearHeaders() // same
 				.clearReplyTo() // same
 				.clearBounceTo() // same
@@ -156,6 +157,7 @@ public void testSMIMEMessageFromOutlookMsgWithNonMergingBehavior() {
 		EmailPopulatingBuilder fromEmlBuilder = EmailConverter.emlToEmailBuilder(new File(RESOURCE_FOLDER + "/SMIME (signed and clear text).eml"));
 		Email emailExpectedFromEml = fromEmlBuilder
 				.clearId() // set by Outlook when sending, so is missing in the saved .msg from before sending
+				.clearSentDate() // same
 				.clearHeaders() // same
 				.clearReplyTo() // same
 				.clearBounceTo() // same

modules/simple-java-mail/src/test/java/org/simplejavamail/mailer/MailerLiveTest.java

@@ -253,9 +253,19 @@ private Email assertSendingEmail(final EmailPopulatingBuilder originalEmailPopul
 		if (!fixedSentDate) {
 			GregorianCalendar receiveWindowStart = new GregorianCalendar();
 			receiveWindowStart.add(Calendar.SECOND, -5);
-			assertThat(receivedEmail.getOriginalSentDate()).isBetween(receiveWindowStart.getTime(), new Date());
+			assertThat(receivedEmail.getSentDate()).isBetween(receiveWindowStart.getTime(), new Date());
 		} else {
-			assertThat(receivedEmail.getOriginalSentDate()).isEqualTo(CUSTOM_SENT_DATE);
+			assertThat(receivedEmail.getSentDate()).isEqualTo(CUSTOM_SENT_DATE);
+		}
+
+		// ID will always be generated when sending: if set to a specific value, just assume the generated one
+		if (originalEmailPopulatingBuilder.getId() == null) {
+			originalEmailPopulatingBuilder.fixingMessageId(receivedEmail.getId());
+		}
+
+		// sent-date will always be generated when sending: if not set to a specific value, just assume the generated one
+		if (originalEmailPopulatingBuilder.getSentDate() == null) {
+			originalEmailPopulatingBuilder.fixingSentDate(assumeNonNull(receivedEmail.getSentDate()));
 		}
 
 		// hack: it seems Wiser automatically defaults replyTo address to the From address if left empty

modules/simple-java-mail/src/test/java/org/simplejavamail/mailer/MailerTest.java

@@ -23,10 +23,12 @@
 import java.io.ByteArrayInputStream;
 import java.io.File;
 import java.io.IOException;
+import java.util.GregorianCalendar;
 import java.util.Properties;
 import java.util.UUID;
 
 import static demo.ResourceFolderHelper.determineResourceFolder;
+import static java.util.Calendar.APRIL;
 import static javax.xml.bind.DatatypeConverter.parseBase64Binary;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.ArgumentMatchers.any;
@@ -314,12 +316,13 @@ public void testParser()
 		// let's try producing and then consuming a MimeMessage ->
 		// (bounce recipient is not part of the Mimemessage but the Envelope and is not received back on the MimeMessage
 		emailPopulatingBuilderNormal.clearBounceTo();
+		emailPopulatingBuilderNormal.fixingSentDate(new GregorianCalendar(2011, APRIL, 1, 3, 51).getTime()); // always generated when producing mime message
 		final Email emailNormal = emailPopulatingBuilderNormal.buildEmail();
 		final MimeMessage mimeMessage = EmailConverter.emailToMimeMessage(emailNormal);
 		final Email emailFromMimeMessage = EmailConverter.mimeMessageToEmail(mimeMessage);
 
 		TestDataHelper.fixDresscodeAttachment(emailFromMimeMessage);
-		
+
 		assertThat(emailFromMimeMessage).isEqualTo(emailNormal);
 	}