This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch 1.x
in repository https://gitbox.apache.org/repos/asf/commons-email.git
The following commit(s) were added to refs/heads/1.x by this push:
new f0492b84 Javadoc
f0492b84 is described below
commit f0492b849967013dcae7b2beae243d0c86f3cecc
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 11:22:09 2026 -0400
Javadoc
---
.../apache/commons/mail/DataSourceResolver.java | 4 ++--
src/main/java/org/apache/commons/mail/Email.java | 28 +++++++++++-----------
.../org/apache/commons/mail/EmailException.java | 12 +++++-----
.../java/org/apache/commons/mail/EmailUtils.java | 28 +++++++++++-----------
.../java/org/apache/commons/mail/HtmlEmail.java | 20 ++++++++--------
.../org/apache/commons/mail/ImageHtmlEmail.java | 6 ++---
.../org/apache/commons/mail/MultiPartEmail.java | 4 ++--
.../commons/mail/activation/PathDataSource.java | 6 ++---
.../mail/resolver/DataSourceBaseResolver.java | 6 ++---
.../mail/resolver/DataSourceClassPathResolver.java | 6 ++---
.../mail/resolver/DataSourceCompositeResolver.java | 4 ++--
.../mail/resolver/DataSourceFileResolver.java | 4 ++--
.../mail/resolver/DataSourcePathResolver.java | 4 ++--
.../mail/resolver/DataSourceUrlResolver.java | 6 ++---
.../commons/mail/util/MimeMessageParser.java | 26 ++++++++++----------
.../apache/commons/mail/util/MimeMessageUtils.java | 24 +++++++++----------
.../org/apache/commons/mail/AbstractEmailTest.java | 6 ++---
.../org/apache/commons/mail/EmailLiveTest.java | 2 +-
18 files changed, 98 insertions(+), 98 deletions(-)
diff --git a/src/main/java/org/apache/commons/mail/DataSourceResolver.java
b/src/main/java/org/apache/commons/mail/DataSourceResolver.java
index 73d0cf89..e8b119c1 100644
--- a/src/main/java/org/apache/commons/mail/DataSourceResolver.java
+++ b/src/main/java/org/apache/commons/mail/DataSourceResolver.java
@@ -30,7 +30,7 @@ public interface DataSourceResolver {
/**
* Resolves the given resource location to a {@code DataSource}.
*
- * @param resourceLocation the location of the resource
+ * @param resourceLocation The location of the resource
* @return The {@code DataSource}
* @throws IOException the resource was not found
*/
@@ -39,7 +39,7 @@ public interface DataSourceResolver {
/**
* Resolves the given resource location to a {@code DataSource}.
*
- * @param resourceLocation the location of the resource
+ * @param resourceLocation The location of the resource
* @param isLenient shall we ignore resources not found or complain
with an exception?
* @return The data source containing the resource or null if the resource
was not found in lenient mode
* @throws IOException resolving the resource failed
diff --git a/src/main/java/org/apache/commons/mail/Email.java
b/src/main/java/org/apache/commons/mail/Email.java
index 84a53ff0..edfad42e 100644
--- a/src/main/java/org/apache/commons/mail/Email.java
+++ b/src/main/java/org/apache/commons/mail/Email.java
@@ -790,8 +790,8 @@ public abstract class Email {
/**
* Creates a folded header value containing 76 character chunks.
*
- * @param name the name of the header
- * @param value the value of the header
+ * @param name The name of the header
+ * @param value The value of the header
* @return The folded header value
* @throws IllegalArgumentException if either the name or value is null or
empty
*/
@@ -1321,7 +1321,7 @@ public abstract class Email {
* This method should be used when your outgoing mail server requires
authentication. Your mail server must also support RFC2554.
* </p>
*
- * @param authenticator the {@code Authenticator} object.
+ * @param authenticator The {@code Authenticator} object.
* @see Authenticator
* @since 1.0
*/
@@ -1410,7 +1410,7 @@ public abstract class Email {
/**
* Sets the content.
*
- * @param content the content.
+ * @param content The content.
* @return this.
* @since 1.6.0
*/
@@ -1434,7 +1434,7 @@ public abstract class Email {
/**
* Sets the content type.
*
- * @param contentType the content type.
+ * @param contentType The content type.
* @return this.
* @since 1.6.0
*/
@@ -1500,7 +1500,7 @@ public abstract class Email {
/**
* Sets the From address.
*
- * @param fromAddress the From address.
+ * @param fromAddress The From address.
* @return this.
* @since 1.6.0
*/
@@ -1598,7 +1598,7 @@ public abstract class Email {
/**
* Sets the MIME message.
*
- * @param message the MIME message.
+ * @param message The MIME message.
*/
public void setMessage(final MimeMessage message) {
this.message = message;
@@ -1659,7 +1659,7 @@ public abstract class Email {
/**
* Sets the POP3 password.
*
- * @param popPassword the POP3 password.
+ * @param popPassword The POP3 password.
* @return this.
* @since 1.6.0
*/
@@ -1672,7 +1672,7 @@ public abstract class Email {
/**
* Sets the POP3 user name.
*
- * @param popUserName the POP3 user name.
+ * @param popUserName The POP3 user name.
* @return this.
* @since 1.6.0
*/
@@ -1750,7 +1750,7 @@ public abstract class Email {
/**
* Sets the socket connection timeout value in milliseconds. Default is a
60 second timeout.
*
- * @param socketConnectionTimeout the connection timeout
+ * @param socketConnectionTimeout The connection timeout
* @throws IllegalStateException if the mail session is already initialized
* @since 1.6.0
*/
@@ -1762,7 +1762,7 @@ public abstract class Email {
/**
* Sets the socket connection timeout value in milliseconds. Default is a
60 second timeout.
*
- * @param socketConnectionTimeout the connection timeout
+ * @param socketConnectionTimeout The connection timeout
* @throws IllegalStateException if the mail session is already initialized
* @since 1.2
* @deprecated Use {@link #setSocketConnectionTimeout(Duration)}.
@@ -1776,7 +1776,7 @@ public abstract class Email {
/**
* Sets the socket I/O timeout value in milliseconds. Default is 60 second
timeout.
*
- * @param socketTimeout the socket I/O timeout
+ * @param socketTimeout The socket I/O timeout
* @throws IllegalStateException if the mail session is already initialized
* @since 1.6.0
*/
@@ -1788,7 +1788,7 @@ public abstract class Email {
/**
* Sets the socket I/O timeout value in milliseconds. Default is 60 second
timeout.
*
- * @param socketTimeout the socket I/O timeout
+ * @param socketTimeout The socket I/O timeout
* @throws IllegalStateException if the mail session is already initialized
* @since 1.2
* @deprecated Use {@link #setSocketTimeout(Duration)}.
@@ -1846,7 +1846,7 @@ public abstract class Email {
/**
* Sets the SSL port to use for the SMTP transport. Defaults to the
standard port, 465.
*
- * @param sslSmtpPort the SSL port to use for the SMTP transport
+ * @param sslSmtpPort The SSL port to use for the SMTP transport
* @throws IllegalStateException if the mail session is already initialized
* @see #setSmtpPort(int)
*/
diff --git a/src/main/java/org/apache/commons/mail/EmailException.java
b/src/main/java/org/apache/commons/mail/EmailException.java
index 8fe814ff..16292f10 100644
--- a/src/main/java/org/apache/commons/mail/EmailException.java
+++ b/src/main/java/org/apache/commons/mail/EmailException.java
@@ -84,7 +84,7 @@ public class EmailException extends Exception {
/**
* Constructs a new {@code EmailException} with specified detail message.
*
- * @param msg the error message.
+ * @param msg The error message.
*/
public EmailException(final String msg) {
super(msg);
@@ -93,8 +93,8 @@ public class EmailException extends Exception {
/**
* Constructs a new {@code EmailException} with specified detail message
and nested {@code Throwable} root cause.
*
- * @param msg the error message.
- * @param rootCause the exception or error that caused this exception to
be thrown.
+ * @param msg The error message.
+ * @param rootCause The exception or error that caused this exception to
be thrown.
*/
public EmailException(final String msg, final Throwable rootCause) {
super(msg, rootCause);
@@ -103,7 +103,7 @@ public class EmailException extends Exception {
/**
* Constructs a new {@code EmailException} with specified nested {@code
Throwable} root cause.
*
- * @param rootCause the exception or error that caused this exception to
be thrown.
+ * @param rootCause The exception or error that caused this exception to
be thrown.
*/
public EmailException(final Throwable rootCause) {
super(rootCause);
@@ -120,7 +120,7 @@ public class EmailException extends Exception {
/**
* Prints the stack trace of this exception to the specified stream.
*
- * @param out the {@code PrintStream} to use for output
+ * @param out The {@code PrintStream} to use for output
*/
@Override
public void printStackTrace(final PrintStream out) {
@@ -135,7 +135,7 @@ public class EmailException extends Exception {
/**
* Prints the stack trace of this exception to the specified writer.
*
- * @param out the {@code PrintWriter} to use for output
+ * @param out The {@code PrintWriter} to use for output
*/
@Override
public void printStackTrace(final PrintWriter out) {
diff --git a/src/main/java/org/apache/commons/mail/EmailUtils.java
b/src/main/java/org/apache/commons/mail/EmailUtils.java
index dcf6e055..ad24faf8 100644
--- a/src/main/java/org/apache/commons/mail/EmailUtils.java
+++ b/src/main/java/org/apache/commons/mail/EmailUtils.java
@@ -99,7 +99,7 @@ final class EmailUtils {
/**
* Checks that the given file exists and is not a directory.
*
- * @param file the file to check.
+ * @param file The file to check.
* @return The given file if it exists and is not a directory.
* @throws IOException if the given file does not exist or is a directory.
*/
@@ -117,7 +117,7 @@ final class EmailUtils {
/**
* Checks that the given file exists and is not a directory.
*
- * @param file the file to check.
+ * @param file The file to check.
* @return The given file if it exists and is not a directory.
* @throws IOException if the given file does not exist or is a directory.
*/
@@ -135,7 +135,7 @@ final class EmailUtils {
/**
* Encodes an input string according to RFC 2392. Unsafe characters are
escaped.
*
- * @param input the input string to be URL encoded
+ * @param input The input string to be URL encoded
* @return A URL encoded string
* @see <a href="https://tools.ietf.org/html/rfc2392";>RFC 2392</a>
*/
@@ -177,7 +177,7 @@ final class EmailUtils {
* Copied from Commons Lang 2.1, svn 240418
* </p>
*
- * @param str the String to check, may be null
+ * @param str The String to check, may be null
* @return {@code true} if the String is empty or null
*/
static boolean isEmpty(final String str) {
@@ -190,7 +190,7 @@ final class EmailUtils {
* Copied from Commons Lang 2.1, svn 240418
* </p>
*
- * @param str the String to check, may be null
+ * @param str The String to check, may be null
* @return {@code true} if the String is not empty and not null
*/
static boolean isNotEmpty(final String str) {
@@ -214,13 +214,13 @@ final class EmailUtils {
* Copied from Commons Lang 2.1, svn 201930
* </p>
*
- * @param count the length of random string to create
- * @param start the position in set of chars to start at
- * @param end the position in set of chars to end before
+ * @param count The length of random string to create
+ * @param start The position in set of chars to start at
+ * @param end The position in set of chars to end before
* @param letters only allow letters?
* @param numbers only allow numbers?
- * @param chars the set of chars to choose randoms from. If {@code
null}, then it will use the set of all chars.
- * @param random a source of randomness.
+ * @param chars The set of chars to choose randoms from. If {@code
null}, then it will use the set of all chars.
+ * @param random A source of randomness.
* @return The random string
* @throws IllegalArgumentException if {@code count} < 0.
*/
@@ -274,7 +274,7 @@ final class EmailUtils {
* Copied from Commons Lang 2.1, svn 201930
* </p>
*
- * @param count the length of random string to create
+ * @param count The length of random string to create
* @return The random string
*/
static String randomAlphabetic(final int count) {
@@ -284,7 +284,7 @@ final class EmailUtils {
/**
* Replaces end-of-line characters with spaces.
*
- * @param input the input string to be scanned.
+ * @param input The input string to be scanned.
* @return A clean string
*/
static String replaceEndOfLineCharactersWithSpaces(final String input) {
@@ -298,8 +298,8 @@ final class EmailUtils {
/**
* Convenience method to write a MimeMessage into a file.
*
- * @param resultFile the file containing the MimeMessage
- * @param mimeMessage the MimeMessage to write
+ * @param resultFile The file containing the MimeMessage
+ * @param mimeMessage The MimeMessage to write
* @throws IOException writing the MimeMessage failed
* @throws MessagingException writing the MimeMessage failed
*/
diff --git a/src/main/java/org/apache/commons/mail/HtmlEmail.java
b/src/main/java/org/apache/commons/mail/HtmlEmail.java
index ec472026..136366bf 100644
--- a/src/main/java/org/apache/commons/mail/HtmlEmail.java
+++ b/src/main/java/org/apache/commons/mail/HtmlEmail.java
@@ -97,9 +97,9 @@ public class HtmlEmail extends MultiPartEmail {
/**
* Creates an InlineImage object to represent the specified content ID
and {@code MimeBodyPart}.
*
- * @param cid the generated content ID, not null.
- * @param dataSource the {@code DataSource} that represents the
content, not null.
- * @param mimeBodyPart the {@code MimeBodyPart} that contains the
encoded data, not null.
+ * @param cid The generated content ID, not null.
+ * @param dataSource The {@code DataSource} that represents the
content, not null.
+ * @param mimeBodyPart The {@code MimeBodyPart} that contains the
encoded data, not null.
*/
private InlineImage(final String cid, final DataSource dataSource,
final MimeBodyPart mimeBodyPart) {
this.cid = Objects.requireNonNull(cid, "cid");
@@ -306,8 +306,8 @@ public class HtmlEmail extends MultiPartEmail {
/**
* Embeds the specified {@code DataSource} in the HTML using a randomly
generated Content-ID. Returns the generated Content-ID string.
*
- * @param dataSource the {@code DataSource} to embed
- * @param name the name that will be set in the file name header
field
+ * @param dataSource The {@code DataSource} to embed
+ * @param name The name that will be set in the file name header
field
* @return The generated Content-ID for this {@code DataSource}
* @throws EmailException if the embedding fails or if {@code name} is
null or empty
* @see #embed(DataSource, String, String)
@@ -334,9 +334,9 @@ public class HtmlEmail extends MultiPartEmail {
/**
* Embeds the specified {@code DataSource} in the HTML using the specified
Content-ID. Returns the specified Content-ID string.
*
- * @param dataSource the {@code DataSource} to embed
- * @param name the name that will be set in the file name header
field
- * @param cid the Content-ID to use for this {@code DataSource}
+ * @param dataSource The {@code DataSource} to embed
+ * @param name The name that will be set in the file name header
field
+ * @param cid The Content-ID to use for this {@code DataSource}
* @return The URL encoded Content-ID for this {@code DataSource}
* @throws EmailException if the embedding fails or if {@code name} is
null or empty
* @since 1.1
@@ -386,7 +386,7 @@ public class HtmlEmail extends MultiPartEmail {
* changed.
*
* @param file The {@code File} to embed
- * @param cid the Content-ID to use for the embedded {@code File}
+ * @param cid The Content-ID to use for the embedded {@code File}
* @return A String with the Content-ID of the file.
* @throws EmailException when the supplied {@code File} cannot be used or
if the file has already been embedded; also see
* {@link javax.mail.internet.MimeBodyPart} for
definitions
@@ -551,7 +551,7 @@ public class HtmlEmail extends MultiPartEmail {
* message is formatted in HTML for the HTML part of the message; it is
left as is in the alternate text part.
* </p>
*
- * @param msg the message text to use
+ * @param msg The message text to use
* @return this {@code HtmlEmail}
* @throws EmailException if msg is null or empty; see
javax.mail.internet.MimeBodyPart for definitions
* @since 1.0
diff --git a/src/main/java/org/apache/commons/mail/ImageHtmlEmail.java
b/src/main/java/org/apache/commons/mail/ImageHtmlEmail.java
index e67e2b41..4232769d 100644
--- a/src/main/java/org/apache/commons/mail/ImageHtmlEmail.java
+++ b/src/main/java/org/apache/commons/mail/ImageHtmlEmail.java
@@ -101,8 +101,8 @@ public class ImageHtmlEmail extends HtmlEmail {
/**
* Replace the regexp matching resource locations with "cid:..."
references.
*
- * @param htmlMessage the HTML message to analyze
- * @param pattern the regular expression to find resources
+ * @param htmlMessage The HTML message to analyze
+ * @param pattern The regular expression to find resources
* @return The HTML message containing "cid" references
* @throws EmailException creating the email failed
* @throws IOException resolving the resources failed
@@ -170,7 +170,7 @@ public class ImageHtmlEmail extends HtmlEmail {
/**
* Sets the data source resolver.
*
- * @param dataSourceResolver the resolver
+ * @param dataSourceResolver The resolver
*/
public void setDataSourceResolver(final DataSourceResolver
dataSourceResolver) {
this.dataSourceResolver = dataSourceResolver;
diff --git a/src/main/java/org/apache/commons/mail/MultiPartEmail.java
b/src/main/java/org/apache/commons/mail/MultiPartEmail.java
index eb68525a..62dc7a4e 100644
--- a/src/main/java/org/apache/commons/mail/MultiPartEmail.java
+++ b/src/main/java/org/apache/commons/mail/MultiPartEmail.java
@@ -419,7 +419,7 @@ public class MultiPartEmail extends Email {
/**
* Sets whether there are attachments.
*
- * @param hasAttachments the attachments flag
+ * @param hasAttachments The attachments flag
* @since 1.0
*/
public void setBoolHasAttachments(final boolean hasAttachments) {
@@ -429,7 +429,7 @@ public class MultiPartEmail extends Email {
/**
* Sets the initialized status of this object.
*
- * @param initialized the initialized status flag
+ * @param initialized The initialized status flag
*/
protected void setInitialized(final boolean initialized) {
this.initialized = initialized;
diff --git
a/src/main/java/org/apache/commons/mail/activation/PathDataSource.java
b/src/main/java/org/apache/commons/mail/activation/PathDataSource.java
index 1f9d86c4..06580ebc 100644
--- a/src/main/java/org/apache/commons/mail/activation/PathDataSource.java
+++ b/src/main/java/org/apache/commons/mail/activation/PathDataSource.java
@@ -52,7 +52,7 @@ public final class PathDataSource implements DataSource {
* <p>
* The type map defaults to {@link FileTypeMap#getDefaultFileTypeMap()}.
*
- * @param path the path
+ * @param path The path
*/
public PathDataSource(final Path path) {
this(path, FileTypeMap.getDefaultFileTypeMap());
@@ -64,8 +64,8 @@ public final class PathDataSource implements DataSource {
* The file will not actually be opened until a method is called that
requires the path to be opened.
* </p>
*
- * @param path the path, non-null.
- * @param typeMap the type map, non-null.
+ * @param path The path, non-null.
+ * @param typeMap The type map, non-null.
* @param options options for opening file streams.
*/
public PathDataSource(final Path path, final FileTypeMap typeMap, final
OpenOption... options) {
diff --git
a/src/main/java/org/apache/commons/mail/resolver/DataSourceBaseResolver.java
b/src/main/java/org/apache/commons/mail/resolver/DataSourceBaseResolver.java
index 6033ddd8..bff59053 100644
--- a/src/main/java/org/apache/commons/mail/resolver/DataSourceBaseResolver.java
+++ b/src/main/java/org/apache/commons/mail/resolver/DataSourceBaseResolver.java
@@ -47,7 +47,7 @@ public abstract class DataSourceBaseResolver implements
DataSourceResolver {
/**
* Tests whether the argument is a content id.
*
- * @param resourceLocation the resource location to test.
+ * @param resourceLocation The resource location to test.
* @return true if it is a CID.
*/
protected boolean isCid(final String resourceLocation) {
@@ -57,7 +57,7 @@ public abstract class DataSourceBaseResolver implements
DataSourceResolver {
/**
* Tests whether this a file URL.
*
- * @param urlString the URL string.
+ * @param urlString The URL string.
* @return true if it is a file URL.
*/
protected boolean isFileUrl(final String urlString) {
@@ -67,7 +67,7 @@ public abstract class DataSourceBaseResolver implements
DataSourceResolver {
/**
* Tests whether this a HTTP or HTTPS URL.
*
- * @param urlString the URL string to test.
+ * @param urlString The URL string to test.
* @return true if it is a HTTP or HTTPS URL.
*/
protected boolean isHttpUrl(final String urlString) {
diff --git
a/src/main/java/org/apache/commons/mail/resolver/DataSourceClassPathResolver.java
b/src/main/java/org/apache/commons/mail/resolver/DataSourceClassPathResolver.java
index 64bc98e5..b12aceb0 100644
---
a/src/main/java/org/apache/commons/mail/resolver/DataSourceClassPathResolver.java
+++
b/src/main/java/org/apache/commons/mail/resolver/DataSourceClassPathResolver.java
@@ -44,7 +44,7 @@ public class DataSourceClassPathResolver extends
DataSourceBaseResolver {
/**
* Constructs a new instance.
*
- * @param classPathBase a base class path
+ * @param classPathBase A base class path
*/
public DataSourceClassPathResolver(final String classPathBase) {
this(classPathBase, false);
@@ -53,7 +53,7 @@ public class DataSourceClassPathResolver extends
DataSourceBaseResolver {
/**
* Constructs a new instance.
*
- * @param classPathBase a base class path
+ * @param classPathBase A base class path
* @param lenient shall we ignore resources not found or throw an
exception?
*/
public DataSourceClassPathResolver(final String classPathBase, final
boolean lenient) {
@@ -73,7 +73,7 @@ public class DataSourceClassPathResolver extends
DataSourceBaseResolver {
/**
* Returns the resource name for a given resource location.
*
- * @param resourceLocation the resource location
+ * @param resourceLocation The resource location
* @return {@link #getClassPathBase()} + {@code resourceLocation}
* @see #getClassPathBase()
*/
diff --git
a/src/main/java/org/apache/commons/mail/resolver/DataSourceCompositeResolver.java
b/src/main/java/org/apache/commons/mail/resolver/DataSourceCompositeResolver.java
index b0fb8840..c627b173 100644
---
a/src/main/java/org/apache/commons/mail/resolver/DataSourceCompositeResolver.java
+++
b/src/main/java/org/apache/commons/mail/resolver/DataSourceCompositeResolver.java
@@ -35,7 +35,7 @@ public class DataSourceCompositeResolver extends
DataSourceBaseResolver {
/**
* Constructs a new instance.
*
- * @param dataSourceResolvers a list of resolvers being used
+ * @param dataSourceResolvers A list of resolvers being used
*/
public DataSourceCompositeResolver(final DataSourceResolver[]
dataSourceResolvers) {
this.dataSourceResolvers = dataSourceResolvers.clone();
@@ -44,7 +44,7 @@ public class DataSourceCompositeResolver extends
DataSourceBaseResolver {
/**
* Constructs a new instance.
*
- * @param dataSourceResolvers a list of resolvers being used
+ * @param dataSourceResolvers A list of resolvers being used
* @param isLenient shall we ignore resources not found or throw
an exception?
*/
public DataSourceCompositeResolver(final DataSourceResolver[]
dataSourceResolvers, final boolean isLenient) {
diff --git
a/src/main/java/org/apache/commons/mail/resolver/DataSourceFileResolver.java
b/src/main/java/org/apache/commons/mail/resolver/DataSourceFileResolver.java
index 9cb9df7f..a1db591a 100644
--- a/src/main/java/org/apache/commons/mail/resolver/DataSourceFileResolver.java
+++ b/src/main/java/org/apache/commons/mail/resolver/DataSourceFileResolver.java
@@ -42,7 +42,7 @@ public class DataSourceFileResolver extends
DataSourceBaseResolver {
/**
* Constructs a new instance.
*
- * @param baseDir the base directory of the resource when resolving
relative paths
+ * @param baseDir The base directory of the resource when resolving
relative paths
*/
public DataSourceFileResolver(final File baseDir) {
this.baseDir = baseDir;
@@ -51,7 +51,7 @@ public class DataSourceFileResolver extends
DataSourceBaseResolver {
/**
* Constructs a new instance.
*
- * @param baseDir the base directory of the resource when resolving
relative paths
+ * @param baseDir The base directory of the resource when resolving
relative paths
* @param lenient shall we ignore resources not found or complain with an
exception
*/
public DataSourceFileResolver(final File baseDir, final boolean lenient) {
diff --git
a/src/main/java/org/apache/commons/mail/resolver/DataSourcePathResolver.java
b/src/main/java/org/apache/commons/mail/resolver/DataSourcePathResolver.java
index 312b8ca6..c2c1e10f 100644
--- a/src/main/java/org/apache/commons/mail/resolver/DataSourcePathResolver.java
+++ b/src/main/java/org/apache/commons/mail/resolver/DataSourcePathResolver.java
@@ -48,7 +48,7 @@ public final class DataSourcePathResolver extends
DataSourceBaseResolver {
/**
* Constructs a new instance.
*
- * @param baseDir the base directory of the resource when resolving
relative paths
+ * @param baseDir The base directory of the resource when resolving
relative paths
*/
public DataSourcePathResolver(final Path baseDir) {
this(baseDir, false);
@@ -57,7 +57,7 @@ public final class DataSourcePathResolver extends
DataSourceBaseResolver {
/**
* Constructs a new instance.
*
- * @param baseDir the base directory of the resource when resolving
relative paths
+ * @param baseDir The base directory of the resource when resolving
relative paths
* @param lenient shall we ignore resources not found or complain with an
exception
* @param options options for opening streams.
*/
diff --git
a/src/main/java/org/apache/commons/mail/resolver/DataSourceUrlResolver.java
b/src/main/java/org/apache/commons/mail/resolver/DataSourceUrlResolver.java
index f55bfcfe..8fce0ad5 100644
--- a/src/main/java/org/apache/commons/mail/resolver/DataSourceUrlResolver.java
+++ b/src/main/java/org/apache/commons/mail/resolver/DataSourceUrlResolver.java
@@ -37,7 +37,7 @@ public class DataSourceUrlResolver extends
DataSourceBaseResolver {
/**
* Constructs a new instance.
*
- * @param baseUrl the base URL used for resolving relative resource
locations
+ * @param baseUrl The base URL used for resolving relative resource
locations
*/
public DataSourceUrlResolver(final URL baseUrl) {
this.baseUrl = baseUrl;
@@ -46,7 +46,7 @@ public class DataSourceUrlResolver extends
DataSourceBaseResolver {
/**
* Constructs a new instance.
*
- * @param baseUrl the base URL used for resolving relative resource
locations
+ * @param baseUrl The base URL used for resolving relative resource
locations
* @param lenient shall we ignore resources not found or complain with an
exception
*/
public DataSourceUrlResolver(final URL baseUrl, final boolean lenient) {
@@ -57,7 +57,7 @@ public class DataSourceUrlResolver extends
DataSourceBaseResolver {
/**
* Create an URL based on a base URL and a resource location suitable for
loading the resource.
*
- * @param resourceLocation a resource location
+ * @param resourceLocation A resource location
* @return The corresponding URL
* @throws java.net.MalformedURLException creating the URL failed
*/
diff --git a/src/main/java/org/apache/commons/mail/util/MimeMessageParser.java
b/src/main/java/org/apache/commons/mail/util/MimeMessageParser.java
index c00c9848..0d21271d 100644
--- a/src/main/java/org/apache/commons/mail/util/MimeMessageParser.java
+++ b/src/main/java/org/apache/commons/mail/util/MimeMessageParser.java
@@ -70,7 +70,7 @@ public class MimeMessageParser {
/**
* Constructs an instance with the MimeMessage to be extracted.
*
- * @param mimeMessage the message to parse
+ * @param mimeMessage The message to parse
*/
public MimeMessageParser(final MimeMessage mimeMessage) {
this.attachmentList = new ArrayList<>();
@@ -86,8 +86,8 @@ public class MimeMessageParser {
/**
* Parses the MimePart to create a DataSource.
*
- * @param parent the parent multi-part
- * @param part the current part to be processed
+ * @param parent The parent multi-part
+ * @param part The current part to be processed
* @return The DataSource
* @throws MessagingException creating the DataSource failed
* @throws IOException error getting InputStream or unsupported
encoding
@@ -106,7 +106,7 @@ public class MimeMessageParser {
* The content-id must be stripped of any angle brackets, i.e. "part1"
instead of "<part1>".
* </p>
*
- * @param cid the content-id of the attachment
+ * @param cid The content-id of the attachment
* @return The corresponding datasource or null if nothing was found
* @since 1.3.4
*/
@@ -117,7 +117,7 @@ public class MimeMessageParser {
/**
* Find an attachment using its name.
*
- * @param name the name of the attachment
+ * @param name The name of the attachment
* @return The corresponding datasource or null if nothing was found
*/
public DataSource findAttachmentByName(final String name) {
@@ -141,7 +141,7 @@ public class MimeMessageParser {
/**
* Gets the MIME type.
*
- * @param fullMimeType the mime type from the mail API
+ * @param fullMimeType The mime type from the mail API
* @return The real mime type
*/
private String getBaseMimeType(final String fullMimeType) {
@@ -185,8 +185,8 @@ public class MimeMessageParser {
/**
* Determines the name of the data source if it is not already set.
*
- * @param part the mail part
- * @param dataSource the data source
+ * @param part The mail part
+ * @param dataSource The data source
* @return The name of the data source or {@code null} if no name can be
determined
* @throws MessagingException accessing the part failed
* @throws UnsupportedEncodingException decoding the text failed
@@ -317,8 +317,8 @@ public class MimeMessageParser {
/**
* Tests whether the MimePart contains an object of the given mime type.
*
- * @param part the current MimePart
- * @param mimeType the mime type to check
+ * @param part The current MimePart
+ * @param mimeType The mime type to check
* @return {@code true} if the MimePart matches the given mime type,
{@code false} otherwise
* @throws MessagingException parsing the MimeMessage failed
*/
@@ -356,8 +356,8 @@ public class MimeMessageParser {
/**
* Extracts the content of a MimeMessage recursively.
*
- * @param parent the parent multi-part
- * @param part the current MimePart
+ * @param parent The parent multi-part
+ * @param part The current MimePart
* @throws MessagingException parsing the MimeMessage failed
* @throws IOException parsing the MimeMessage failed
*/
@@ -387,7 +387,7 @@ public class MimeMessageParser {
/**
* Strips the content id of any whitespace and angle brackets.
*
- * @param contentId the string to strip
+ * @param contentId The string to strip
* @return A stripped version of the content id
*/
private String stripContentId(final String contentId) {
diff --git a/src/main/java/org/apache/commons/mail/util/MimeMessageUtils.java
b/src/main/java/org/apache/commons/mail/util/MimeMessageUtils.java
index 3d2762cd..1232e9db 100644
--- a/src/main/java/org/apache/commons/mail/util/MimeMessageUtils.java
+++ b/src/main/java/org/apache/commons/mail/util/MimeMessageUtils.java
@@ -42,8 +42,8 @@ public final class MimeMessageUtils {
/**
* Creates a MimeMessage.
*
- * @param session the mail session.
- * @param source the input data.
+ * @param session The mail session.
+ * @param source The input data.
* @return The MimeMessage.
* @throws MessagingException creating the MimeMessage failed.
* @throws IOException creating the MimeMessage failed.
@@ -57,8 +57,8 @@ public final class MimeMessageUtils {
/**
* Creates a MimeMessage.
*
- * @param session the mail session.
- * @param source the input data.
+ * @param session The mail session.
+ * @param source The input data.
* @return The MimeMessage.
* @throws MessagingException creating the MimeMessage failed.
* @throws IOException creating the MimeMessage failed.
@@ -72,8 +72,8 @@ public final class MimeMessageUtils {
/**
* Creates a MimeMessage.
*
- * @param session the mail session.
- * @param source the input data.
+ * @param session The mail session.
+ * @param source The input data.
* @return The MimeMessage.
* @throws MessagingException creating the MimeMessage failed.
*/
@@ -84,8 +84,8 @@ public final class MimeMessageUtils {
/**
* Creates a MimeMessage.
*
- * @param session the mail session.
- * @param source the input data.
+ * @param session The mail session.
+ * @param source The input data.
* @param options options specifying how the file is opened.
* @return The MimeMessage.
* @throws MessagingException creating the MimeMessage failed.
@@ -100,8 +100,8 @@ public final class MimeMessageUtils {
/**
* Creates a MimeMessage using the platform's default character encoding.
*
- * @param session the mail session.
- * @param source the input data.
+ * @param session The mail session.
+ * @param source The input data.
* @return The MimeMessage.
* @throws MessagingException creating the MimeMessage failed.
* @throws IOException creating the MimeMessage failed.
@@ -114,8 +114,8 @@ public final class MimeMessageUtils {
/**
* Writes a MimeMessage into a file.
*
- * @param mimeMessage the MimeMessage to write.
- * @param resultFile the file containing the MimeMessage.
+ * @param mimeMessage The MimeMessage to write.
+ * @param resultFile The file containing the MimeMessage.
* @throws MessagingException accessing MimeMessage failed.
* @throws IOException writing the MimeMessage failed.
*/
diff --git a/src/test/java/org/apache/commons/mail/AbstractEmailTest.java
b/src/test/java/org/apache/commons/mail/AbstractEmailTest.java
index 1a9e3437..cf9142b6 100644
--- a/src/test/java/org/apache/commons/mail/AbstractEmailTest.java
+++ b/src/test/java/org/apache/commons/mail/AbstractEmailTest.java
@@ -154,7 +154,7 @@ public abstract class AbstractEmailTest {
}
/**
- * @param intMsgNo the message to retrieve
+ * @param intMsgNo The message to retrieve
* @return message as string
*/
public String getMessageAsString(final int intMsgNo) {
@@ -373,7 +373,7 @@ public abstract class AbstractEmailTest {
*
* @param mailServer reference to the fake mail server
* @param strSubject expected subject
- * @param content the expected message content
+ * @param content The expected message content
* @param fromAdd expected from address
* @param toAdd list of expected to addresses
* @param ccAdd list of expected cc addresses
@@ -403,7 +403,7 @@ public abstract class AbstractEmailTest {
*
* @param mailServer reference to the fake mail server
* @param strSubject expected subject
- * @param strMessage the expected message as a string
+ * @param strMessage The expected message as a string
* @param fromAdd expected from address
* @param toAdd list of expected to addresses
* @param ccAdd list of expected cc addresses
diff --git a/src/test/java/org/apache/commons/mail/EmailLiveTest.java
b/src/test/java/org/apache/commons/mail/EmailLiveTest.java
index 305dfaa6..7b754730 100644
--- a/src/test/java/org/apache/commons/mail/EmailLiveTest.java
+++ b/src/test/java/org/apache/commons/mail/EmailLiveTest.java
@@ -49,7 +49,7 @@ public class EmailLiveTest extends AbstractEmailTest {
/**
* Factory method to create a pre-configured email instance.
*
- * @param clazz the requested implementation class
+ * @param clazz The requested implementation class
* @return The new instance
* @throws Exception creating the Email instance failed
*/
