renamed email.selector to email.dkimSelector for clarity

Author: bbottema

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

@@ -269,11 +269,11 @@ public static MimeMessage signMessageWithDKIM(final MimeMessage message, final E
 			final DkimSigner dkimSigner;
 			if (email.getDkimPrivateKeyFile() != null) {
 				// InputStream is managed by Dkim library
-				dkimSigner = new DkimSigner(email.getSigningDomain(), email.getSelector(),
+				dkimSigner = new DkimSigner(email.getDkimSigningDomain(), email.getDkimSelector(),
 						email.getDkimPrivateKeyFile());
 			} else {
 				// InputStream is managed by SimpleJavaMail user
-				dkimSigner = new DkimSigner(email.getSigningDomain(), email.getSelector(),
+				dkimSigner = new DkimSigner(email.getDkimSigningDomain(), email.getDkimSelector(),
 						email.getDkimPrivateKeyInputStream());
 			}
 			dkimSigner.setIdentity(email.getFromRecipient().getAddress());

src/main/java/org/simplejavamail/email/Email.java

@@ -99,8 +99,8 @@ public class Email {
 	private boolean applyDKIMSignature = false;
 	private InputStream dkimPrivateKeyInputStream;
 	private File dkimPrivateKeyFile; // supported seperately, so we don't have to do resource management ourselves for the InputStream
-	private String signingDomain;
-	private String selector;
+	private String dkimSigningDomain;
+	private String dkimSelector;
 
 	/**
 	 * Constructor, creates all internal lists. Populates default from, reply-to, to, cc and bcc if provided in the config file.
@@ -148,16 +148,16 @@ public Email(final boolean readFromDefaults) {
 			}
 		}
 	}
-
+	
 	/**
 	 * As {@link #signWithDomainKey(InputStream, String, String)}, but with a File reference that is later read as {@code InputStream}.
 	 */
 	@SuppressWarnings("WeakerAccess")
-	public void signWithDomainKey(@Nonnull final File dkimPrivateKeyFile, @Nonnull final String signingDomain, @Nonnull final String selector) {
+	public void signWithDomainKey(@Nonnull final File dkimPrivateKeyFile, @Nonnull final String signingDomain, @Nonnull final String dkimSelector) {
 		this.applyDKIMSignature = true;
 		this.dkimPrivateKeyFile = checkNonEmptyArgument(dkimPrivateKeyFile, "dkimPrivateKeyFile");
-		this.signingDomain = checkNonEmptyArgument(signingDomain, "signingDomain");
-		this.selector = checkNonEmptyArgument(selector, "selector");
+		this.dkimSigningDomain = checkNonEmptyArgument(signingDomain, "dkimSigningDomain");
+		this.dkimSelector = checkNonEmptyArgument(dkimSelector, "dkimSelector");
 	}
 
 	/**
@@ -173,14 +173,14 @@ public void signWithDomainKey(@Nonnull final File dkimPrivateKeyFile, @Nonnull f
 	 *
 	 * @param dkimPrivateKeyInputStream De key content used to sign for the sending party.
 	 * @param signingDomain             The domain being authorized to send.
-	 * @param selector                  Additional domain specifier.
+	 * @param dkimSelector                  Additional domain specifier.
 	 */
 	@SuppressWarnings("WeakerAccess")
-	public void signWithDomainKey(@Nonnull final InputStream dkimPrivateKeyInputStream, @Nonnull final String signingDomain, @Nonnull final String selector) {
+	public void signWithDomainKey(@Nonnull final InputStream dkimPrivateKeyInputStream, @Nonnull final String signingDomain, @Nonnull final String dkimSelector) {
 		this.applyDKIMSignature = true;
 		this.dkimPrivateKeyInputStream = checkNonEmptyArgument(dkimPrivateKeyInputStream, "dkimPrivateKeyInputStream");
-		this.signingDomain = checkNonEmptyArgument(signingDomain, "signingDomain");
-		this.selector = checkNonEmptyArgument(selector, "selector");
+		this.dkimSigningDomain = checkNonEmptyArgument(signingDomain, "dkimSigningDomain");
+		this.dkimSelector = checkNonEmptyArgument(dkimSelector, "dkimSelector");
 	}
 
 	/**
@@ -454,12 +454,12 @@ public File getDkimPrivateKeyFile() {
 		return dkimPrivateKeyFile;
 	}
 
-	public String getSigningDomain() {
-		return signingDomain;
+	public String getDkimSigningDomain() {
+		return dkimSigningDomain;
 	}
 
-	public String getSelector() {
-		return selector;
+	public String getDkimSelector() {
+		return dkimSelector;
 	}
 
 	@Override
@@ -507,11 +507,11 @@ public String toString() {
 		text = builder.getText();
 		textHTML = builder.getTextHTML();
 		subject = builder.getSubject();
-
+		
 		if (builder.getDkimPrivateKeyFile() != null) {
-			signWithDomainKey(builder.getDkimPrivateKeyFile(), builder.getSigningDomain(), builder.getSelector());
+			signWithDomainKey(builder.getDkimPrivateKeyFile(), builder.getSigningDomain(), builder.getDkimSelector());
 		} else if (builder.getDkimPrivateKeyInputStream() != null) {
-			signWithDomainKey(builder.getDkimPrivateKeyInputStream(), builder.getSigningDomain(), builder.getSelector());
+			signWithDomainKey(builder.getDkimPrivateKeyInputStream(), builder.getSigningDomain(), builder.getDkimSelector());
 		}
 	}
 }

src/main/java/org/simplejavamail/email/EmailBuilder.java

@@ -107,9 +107,9 @@ public class EmailBuilder {
 	private String signingDomain;
 
 	/**
-	 * The selector to be used in combination with the domain.
+	 * The dkimSelector to be used in combination with the domain.
 	 */
-	private String selector;
+	private String dkimSelector;
 
 	public EmailBuilder() {
 		recipients = new ArrayList<>();
@@ -495,42 +495,42 @@ public EmailBuilder addAttachment(@Nullable final String name, @Nonnull final Da
 	/**
 	 * Sets all info needed for DKIM, using a byte array for private key data.
 	 */
-	public EmailBuilder signWithDomainKey(@Nonnull final byte[] dkimPrivateKey, @Nonnull final String signingDomain, @Nonnull final String selector) {
+	public EmailBuilder signWithDomainKey(@Nonnull final byte[] dkimPrivateKey, @Nonnull final String signingDomain, @Nonnull final String dkimSelector) {
 		this.dkimPrivateKeyInputStream = new ByteArrayInputStream(checkNonEmptyArgument(dkimPrivateKey, "dkimPrivateKey"));
 		this.signingDomain = checkNonEmptyArgument(signingDomain, "signingDomain");
-		this.selector = checkNonEmptyArgument(selector, "selector");
+		this.dkimSelector = checkNonEmptyArgument(dkimSelector, "dkimSelector");
 		return this;
 	}
 
 	/**
 	 * Sets all info needed for DKIM, using a byte array for private key data.
 	 */
-	public EmailBuilder signWithDomainKey(@Nonnull final String dkimPrivateKey, @Nonnull final String signingDomain, @Nonnull final String selector) {
+	public EmailBuilder signWithDomainKey(@Nonnull final String dkimPrivateKey, @Nonnull final String signingDomain, @Nonnull final String dkimSelector) {
 		checkNonEmptyArgument(dkimPrivateKey, "dkimPrivateKey");
 		this.dkimPrivateKeyInputStream = new ByteArrayInputStream(dkimPrivateKey.getBytes(UTF_8));
 		this.signingDomain = checkNonEmptyArgument(signingDomain, "signingDomain");
-		this.selector = checkNonEmptyArgument(selector, "selector");
+		this.dkimSelector = checkNonEmptyArgument(dkimSelector, "dkimSelector");
 		return this;
 	}
 
 	/**
 	 * Sets all info needed for DKIM, using a file reference for private key data.
 	 */
-	public EmailBuilder signWithDomainKey(@Nonnull final File dkimPrivateKeyFile, @Nonnull final String signingDomain, @Nonnull final String selector) {
+	public EmailBuilder signWithDomainKey(@Nonnull final File dkimPrivateKeyFile, @Nonnull final String signingDomain, @Nonnull final String dkimSelector) {
 		this.dkimPrivateKeyFile = checkNonEmptyArgument(dkimPrivateKeyFile, "dkimPrivateKeyFile");
 		this.signingDomain = checkNonEmptyArgument(signingDomain, "signingDomain");
-		this.selector = checkNonEmptyArgument(selector, "selector");
+		this.dkimSelector = checkNonEmptyArgument(dkimSelector, "dkimSelector");
 		return this;
 	}
 
 	/**
 	 * Sets all info needed for DKIM, using an input stream for private key data.
 	 */
 	public EmailBuilder signWithDomainKey(@Nonnull final InputStream dkimPrivateKeyInputStream, @Nonnull final String signingDomain,
-			@Nonnull final String selector) {
+			@Nonnull final String dkimSelector) {
 		this.dkimPrivateKeyInputStream = checkNonEmptyArgument(dkimPrivateKeyInputStream, "dkimPrivateKeyInputStream");
 		this.signingDomain = checkNonEmptyArgument(signingDomain, "signingDomain");
-		this.selector = checkNonEmptyArgument(selector, "selector");
+		this.dkimSelector = checkNonEmptyArgument(dkimSelector, "dkimSelector");
 		return this;
 	}
 
@@ -590,7 +590,7 @@ public String getSigningDomain() {
 		return signingDomain;
 	}
 
-	public String getSelector() {
-		return selector;
+	public String getDkimSelector() {
+		return dkimSelector;
 	}
 }