#156: Added support for file references for adding body content (plaintext, HTML, including prepend and append)

Author: bbottema

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

@@ -9,6 +9,7 @@
 class EmailException extends MailException {
 
 	static final String NAME_MISSING_FOR_EMBEDDED_IMAGE = "No name given for embedded image nor passed inside the data source";
+	static final String ERROR_READING_FROM_FILE = "Error reading from file: %s";
 
 	EmailException(@SuppressWarnings("SameParameterValue") final String message) {
 		super(message);

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

@@ -14,6 +14,7 @@
 import javax.mail.util.ByteArrayDataSource;
 import java.io.ByteArrayInputStream;
 import java.io.File;
+import java.io.IOException;
 import java.io.InputStream;
 import java.util.ArrayList;
 import java.util.Collection;
@@ -23,6 +24,7 @@
 import java.util.Map;
 import java.util.Set;
 
+import static java.lang.String.format;
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static java.util.Arrays.asList;
 import static java.util.Collections.singletonList;
@@ -415,6 +417,21 @@ EmailPopulatingBuilder withForward(@Nullable final MimeMessage emailMessageToFor
 		return this;
 	}
 
+	/**
+	 * Delegates to {@link #withPlainText(String)}.
+	 *
+	 * @param textFile Plain text to set as email body (overwrites any previous plain text body). If no HTML body is included as well, plain text
+	 *                would be used instead by the email client.
+	 */
+	@Cli.OptionNameOverride("withPlainTextFromFile")
+	public EmailPopulatingBuilder withPlainText(@Nonnull final File textFile) {
+		try {
+			return withPlainText(MiscUtil.readFileContent(textFile));
+		} catch (IOException e) {
+			throw new EmailException(format(EmailException.ERROR_READING_FROM_FILE, textFile), e);
+		}
+	}
+	
 	/**
 	 * Sets the optional email message body in plain text.
 	 * <p>
@@ -424,6 +441,7 @@ EmailPopulatingBuilder withForward(@Nullable final MimeMessage emailMessageToFor
 	 * @param text Plain text to set as email body (overwrites any previous plain text body). If no HTML body is included as well, plain text
 	 *                would be used instead by the email client.
 	 *
+	 * @see #withPlainText(File)
 	 * @see #prependText(String)
 	 * @see #appendText(String)
 	 */
@@ -432,30 +450,77 @@ public EmailPopulatingBuilder withPlainText(@Nullable final String text) {
 		return this;
 	}
 
+	/**
+	 * Delegates to {@link #prependText(String)}.
+	 *
+	 * @param textFile The plain text to prepend to whatever plain text is already there.
+	 */
+	@Cli.OptionNameOverride("prependTextFromFile")
+	public EmailPopulatingBuilder prependText(@Nonnull final File textFile) {
+		try {
+			return prependText(MiscUtil.readFileContent(textFile));
+		} catch (IOException e) {
+			throw new EmailException(format(EmailException.ERROR_READING_FROM_FILE, textFile), e);
+		}
+	}
+	
 	/**
 	 * Prepends text to the current plain text body (or starts it if plain text body is missing).
 	 *
 	 * @param text The plain text to prepend to whatever plain text is already there.
 	 *
+	 * @see #prependText(File)
+	 * @see #appendText(String)
 	 * @see #withPlainText(String)
 	 */
 	public EmailPopulatingBuilder prependText(@Nonnull final String text) {
 		this.text = text + defaultTo(this.text, "");
 		return this;
 	}
 
+	/**
+	 * Delegates to {@link #appendText(String)}.
+	 *
+	 * @param textFile The plain text to append to whatever plain text is already there.
+	 */
+	@Cli.OptionNameOverride("appendTextFromFile")
+	public EmailPopulatingBuilder appendText(@Nonnull final File textFile) {
+		try {
+			return appendText(MiscUtil.readFileContent(textFile));
+		} catch (IOException e) {
+			throw new EmailException(format(EmailException.ERROR_READING_FROM_FILE, textFile), e);
+		}
+	}
+	
 	/**
 	 * Appends text to the current plain text body (or starts it if plain text body is missing).
 	 *
 	 * @param text The plain text to append to whatever plain text is already there.
 	 *
+	 * @see #appendText(File)
+	 * @see #prependText(String)
 	 * @see #withPlainText(String)
 	 */
 	public EmailPopulatingBuilder appendText(@Nonnull final String text) {
 		this.text = defaultTo(this.text, "") + text;
 		return this;
 	}
 
+	/**
+	 * Delegates to {@link #withHTMLText(String)}.
+	 *
+	 * @param textHTMLFile HTML text to set as email body (overwrites any previous HTML text body). If no HTML body is included, plain text
+	 *                would be used instead by the email client if provided.
+	 */
+	@Cli.OptionNameOverride("withHTMLTextFromFile")
+	public EmailPopulatingBuilder withHTMLText(@Nonnull final File textHTMLFile) {
+		try {
+			return withHTMLText(MiscUtil.readFileContent(textHTMLFile));
+		} catch (IOException e) {
+			throw new EmailException(format(EmailException.ERROR_READING_FROM_FILE, textHTMLFile), e);
+		}
+	}
+	
 	/**
 	 * Sets the optional email message body in HTML text.
 	 * <p>
@@ -465,6 +530,7 @@ public EmailPopulatingBuilder appendText(@Nonnull final String text) {
 	 * @param textHTML HTML text to set as email body (overwrites any previous HTML text body). If no HTML body is included, plain text
 	 *                would be used instead by the email client if provided.
 	 *
+	 * @see #withHTMLText(File)
 	 * @see #prependTextHTML(String)
 	 * @see #appendTextHTML(String)
 	 */
@@ -473,23 +539,55 @@ public EmailPopulatingBuilder withHTMLText(@Nullable final String textHTML) {
 		return this;
 	}
 
+	/**
+	 * Delegates to {@link #prependTextHTML(String)}.
+	 *
+	 * @param textHTMLFile The HTML text to prepend to whatever is already there in the body.
+	 */
+	@Cli.OptionNameOverride("prependTextHTMLFromFile")
+	public EmailPopulatingBuilder prependTextHTML(@Nonnull final File textHTMLFile) {
+		try {
+			return prependTextHTML(MiscUtil.readFileContent(textHTMLFile));
+		} catch (IOException e) {
+			throw new EmailException(format(EmailException.ERROR_READING_FROM_FILE, textHTMLFile), e);
+		}
+	}
+	
 	/**
 	 * Prepends HTML text to the current HTML text body (or starts it if HTML text body is missing).
 	 *
 	 * @param textHTML The HTML text to prepend to whatever is already there in the body.
 	 *
+	 * @see #prependTextHTML(File)
+	 * @see #appendTextHTML(String)
 	 * @see #withHTMLText(String)
 	 */
 	public EmailPopulatingBuilder prependTextHTML(@Nonnull final String textHTML) {
 		this.textHTML = textHTML + defaultTo(this.textHTML, "");
 		return this;
 	}
 
+	/**
+	 * Delegates to {@link #appendTextHTML(String)}.
+	 *
+	 * @param textHTMLFile The HTML text to append to whatever is already there in the body.
+	 */
+	@Cli.OptionNameOverride("appendTextHTMLFromFile")
+	public EmailPopulatingBuilder appendTextHTML(@Nonnull final File textHTMLFile) {
+		try {
+			return appendTextHTML(MiscUtil.readFileContent(textHTMLFile));
+		} catch (IOException e) {
+			throw new EmailException(format(EmailException.ERROR_READING_FROM_FILE, textHTMLFile), e);
+		}
+	}
+	
 	/**
 	 * Appends HTML text to the current HTML text body (or starts it if HTML text body is missing).
 	 *
 	 * @param textHTML The HTML text to append to whatever is already there in the body.
 	 *
+	 * @see #appendTextHTML(File)
+	 * @see #prependTextHTML(String)
 	 * @see #withHTMLText(String)
 	 */
 	public EmailPopulatingBuilder appendTextHTML(@Nonnull final String textHTML) {

src/main/java/org/simplejavamail/internal/clisupport/BuilderApiToPicocliCommandsMapper.java

@@ -14,6 +14,7 @@
 import org.simplejavamail.internal.clisupport.therapijavadoc.TherapiJavadocHelper;
 import org.simplejavamail.internal.clisupport.therapijavadoc.TherapiJavadocHelper.DocumentedMethodParam;
 import org.simplejavamail.internal.clisupport.valueinterpreters.EmlFilePathToMimeMessageFunction;
+import org.simplejavamail.internal.clisupport.valueinterpreters.FilePathIdentityFunction;
 import org.simplejavamail.internal.clisupport.valueinterpreters.MsgFilePathToMimeMessageFunction;
 import org.simplejavamail.internal.clisupport.valueinterpreters.StringToTransportStrategyFunction;
 import org.simplejavamail.internal.util.StringUtil;
@@ -25,6 +26,7 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import javax.mail.internet.MimeMessage;
+import java.io.File;
 import java.io.InputStream;
 import java.lang.annotation.Annotation;
 import java.lang.reflect.Method;
@@ -71,9 +73,11 @@ public final class BuilderApiToPicocliCommandsMapper {
 		put(DataSource.class, "FILE");
 		put(byte[].class, "FILE");
 		put(InputStream.class, "FILE");
+		put(File.class, "FILE");
 	}};
 
 	static {
+		ValueConversionHelper.registerValueConverter(new FilePathIdentityFunction());
 		ValueConversionHelper.registerValueConverter(new EmlFilePathToMimeMessageFunction());
 		ValueConversionHelper.registerValueConverter(new MsgFilePathToMimeMessageFunction());
 		ValueConversionHelper.registerValueConverter(new StringToTransportStrategyFunction());

src/main/java/org/simplejavamail/internal/clisupport/valueinterpreters/FilePathIdentityFunction.java

@@ -0,0 +1,23 @@
+package org.simplejavamail.internal.clisupport.valueinterpreters;
+
+import javax.annotation.Nonnull;
+import java.io.File;
+
+public class FilePathIdentityFunction extends FileBasedFunction<File> {
+	
+	@Override
+	public Class<String> getFromType() {
+		return String.class;
+	}
+	
+	@Override
+	public Class<File> getTargetType() {
+		return File.class;
+	}
+	
+	@Nonnull
+	@Override
+	protected File convertFile(File textFile) {
+		return textFile;
+	}
+}

src/main/java/org/simplejavamail/internal/util/MiscUtil.java

@@ -10,12 +10,14 @@
 import javax.mail.internet.MimeUtility;
 import java.io.BufferedInputStream;
 import java.io.ByteArrayOutputStream;
+import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.UnsupportedEncodingException;
 import java.lang.annotation.Annotation;
 import java.lang.reflect.Method;
 import java.nio.charset.Charset;
+import java.nio.file.Files;
 import java.util.AbstractMap;
 import java.util.ArrayList;
 import java.util.Collection;
@@ -24,6 +26,8 @@
 import java.util.regex.Pattern;
 
 import static java.lang.Integer.toHexString;
+import static java.lang.String.format;
+import static java.nio.charset.StandardCharsets.UTF_8;
 import static java.util.Arrays.asList;
 import static java.util.regex.Pattern.compile;
 import static org.bbottema.javareflection.TypeUtils.containsAnnotation;
@@ -185,4 +189,11 @@ public static int countMandatoryParameters(Method m) {
 		}
 		return mandatoryParameterCount;
 	}
+	
+	public static String readFileContent(@Nonnull final File file) throws IOException {
+		if (!file.exists()) {
+			throw new IllegalArgumentException(format("File not found: %s", file));
+		}
+		return new String(Files.readAllBytes(file.toPath()), UTF_8);
+	}
 }

src/test/java/demo/CliDemoApp.java

@@ -19,6 +19,7 @@ public static void main(String[] args) {
 		demoTestConnection(serverConfig);
 		demoSend(serverConfig);
 		demoSendAsync(serverConfig);
+		demoSendUsingFileAsHTMLBody(serverConfig);
 	}
 
 	private static void demoTestConnection(ServerConfig serverConfig) {
@@ -51,4 +52,16 @@ private static void demoSendAsync(ServerConfig serverConfig) {
 				"--mailer:withTransportStrategy", "SMTP_TLS"
 		});
 	}
+	
+	private static void demoSendUsingFileAsHTMLBody(ServerConfig serverConfig) {
+		ModuleLoader.loadCliModule().runCLI(new String[]{
+				"send",
+				"--email:startingBlank",
+				"--email:withHTMLTextFromFile", SOURCE_FOLDER + "/test/resources/test-messages/html-body.html",
+				"--email:from", "Test sender", YOUR_GMAIL_ADDRESS,
+				"--email:to", "Test Receiver", YOUR_GMAIL_ADDRESS,
+				"--mailer:withSMTPServer", "smtp.gmail.com", "587", serverConfig.getUsername(), serverConfig.getPassword(),
+				"--mailer:withTransportStrategy", "SMTP_TLS"
+		});
+	}
 }