This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-email.git
The following commit(s) were added to refs/heads/master by this push:
new 950ebb54 Javadoc
950ebb54 is described below
commit 950ebb54101a29ea651cce10922111d04486ec5c
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:45:43 2026 -0400
Javadoc
---
.../apache/commons/mail2/core/EmailException.java | 10 +++---
.../org/apache/commons/mail2/core/EmailUtils.java | 8 ++---
.../commons/mail2/jakarta/DataSourceResolver.java | 4 +--
.../org/apache/commons/mail2/jakarta/Email.java | 36 +++++++++++-----------
.../apache/commons/mail2/jakarta/HtmlEmail.java | 14 ++++-----
.../commons/mail2/jakarta/ImageHtmlEmail.java | 4 +--
.../commons/mail2/jakarta/MultiPartEmail.java | 4 +--
.../mail2/jakarta/activation/PathDataSource.java | 6 ++--
.../jakarta/resolver/DataSourceBaseResolver.java | 2 +-
.../resolver/DataSourceClassPathResolver.java | 2 +-
.../jakarta/resolver/DataSourceFileResolver.java | 2 +-
.../jakarta/resolver/DataSourcePathResolver.java | 2 +-
.../jakarta/resolver/DataSourceUrlResolver.java | 4 +--
.../mail2/jakarta/util/MimeMessageParser.java | 34 ++++++++++----------
.../mail2/jakarta/util/MimeMessageUtils.java | 10 +++---
.../commons/mail2/jakarta/AbstractEmailTest.java | 2 +-
.../commons/mail2/jakarta/EmailLiveTest.java | 2 +-
.../commons/mail2/javax/DataSourceResolver.java | 4 +--
.../java/org/apache/commons/mail2/javax/Email.java | 36 +++++++++++-----------
.../org/apache/commons/mail2/javax/HtmlEmail.java | 14 ++++-----
.../apache/commons/mail2/javax/ImageHtmlEmail.java | 4 +--
.../apache/commons/mail2/javax/MultiPartEmail.java | 4 +--
.../mail2/javax/activation/PathDataSource.java | 6 ++--
.../javax/resolver/DataSourceBaseResolver.java | 2 +-
.../resolver/DataSourceClassPathResolver.java | 2 +-
.../javax/resolver/DataSourceFileResolver.java | 2 +-
.../javax/resolver/DataSourcePathResolver.java | 2 +-
.../javax/resolver/DataSourceUrlResolver.java | 4 +--
.../mail2/javax/util/MimeMessageParser.java | 34 ++++++++++----------
.../commons/mail2/javax/util/MimeMessageUtils.java | 10 +++---
.../commons/mail2/javax/AbstractEmailTest.java | 2 +-
.../apache/commons/mail2/javax/EmailLiveTest.java | 2 +-
32 files changed, 137 insertions(+), 137 deletions(-)
diff --git
a/commons-email2-core/src/main/java/org/apache/commons/mail2/core/EmailException.java
b/commons-email2-core/src/main/java/org/apache/commons/mail2/core/EmailException.java
index 17cb29b1..8dfbc95c 100644
---
a/commons-email2-core/src/main/java/org/apache/commons/mail2/core/EmailException.java
+++
b/commons-email2-core/src/main/java/org/apache/commons/mail2/core/EmailException.java
@@ -42,7 +42,7 @@ public class EmailException extends Exception {
* @param test test condition.
* @param subject the subject to return if we don't throw.
* @param message the exception message.
- * @return the given subject.
+ * @return The given subject.
* @throws EmailException if the supplier evaluates to true.
*/
public static <T> T check(final Supplier<Boolean> test, final T subject,
final Supplier<String> message) throws EmailException {
@@ -58,7 +58,7 @@ public class EmailException extends Exception {
* @param <T> the type of elements in the collection.
* @param value the value to test.
* @param message the exception message.
- * @return the given subject.
+ * @return The given subject.
* @throws EmailException if the collection is empty.
*/
public static <T> Collection<T> checkNonEmpty(final Collection<T> value,
final Supplier<String> message) throws EmailException {
@@ -70,7 +70,7 @@ public class EmailException extends Exception {
*
* @param message the exception message.
* @param value the value to test.
- * @return the given subject.
+ * @return The given subject.
* @throws EmailException if the string is empty.
*/
public static String checkNonEmpty(final String value, final
Supplier<String> message) throws EmailException {
@@ -83,7 +83,7 @@ public class EmailException extends Exception {
* @param <T> the array type.
* @param message the exception message.
* @param value the value to test.
- * @return the given subject.
+ * @return The given subject.
* @throws EmailException if the array is empty.
*/
public static <T> T[] checkNonEmpty(final T[] value, final
Supplier<String> message) throws EmailException {
@@ -96,7 +96,7 @@ public class EmailException extends Exception {
* @param <T> the value type.
* @param message the exception message.
* @param value the value to test.
- * @return the given subject.
+ * @return The given subject.
* @throws EmailException if the value is null.
*/
public static <T> T checkNonNull(final T value, final Supplier<String>
message) throws EmailException {
diff --git
a/commons-email2-core/src/main/java/org/apache/commons/mail2/core/EmailUtils.java
b/commons-email2-core/src/main/java/org/apache/commons/mail2/core/EmailUtils.java
index a6210f79..81b2e1b2 100644
---
a/commons-email2-core/src/main/java/org/apache/commons/mail2/core/EmailUtils.java
+++
b/commons-email2-core/src/main/java/org/apache/commons/mail2/core/EmailUtils.java
@@ -95,7 +95,7 @@ public final class EmailUtils {
* Checks that the given file exists and is not a directory.
*
* @param file the file to check.
- * @return the given file if it exists and is not a directory.
+ * @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.
* @since 2.0.0-M2
*/
@@ -114,7 +114,7 @@ public final class EmailUtils {
* Checks that the given file exists and is not a directory.
*
* @param file the file to check.
- * @return the given file if it exists and is not a directory.
+ * @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.
* @since 2.0.0-M2
*/
@@ -236,7 +236,7 @@ public final class EmailUtils {
* @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.
- * @return the random string
+ * @return The random string
* @throws IllegalArgumentException if {@code count} < 0.
*/
private static String random(int count, int start, int end, final boolean
letters, final boolean numbers, final char[] chars, final Random random) {
@@ -290,7 +290,7 @@ public final class EmailUtils {
* </p>
*
* @param count the length of random string to create
- * @return the random string
+ * @return The random string
*/
public static String randomAlphabetic(final int count) {
return random(count, 0, 0, true, false, null, RANDOM);
diff --git
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/DataSourceResolver.java
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/DataSourceResolver.java
index 41591f86..19c92ddc 100644
---
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/DataSourceResolver.java
+++
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/DataSourceResolver.java
@@ -31,7 +31,7 @@ public interface DataSourceResolver {
* Resolves the given resource location to a {@code DataSource}.
*
* @param resourceLocation the location of the resource
- * @return the {@code DataSource}
+ * @return The {@code DataSource}
* @throws IOException the resource was not found
*/
DataSource resolve(String resourceLocation) throws IOException;
@@ -41,7 +41,7 @@ public interface DataSourceResolver {
*
* @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
+ * @return The data source containing the resource or null if the resource
was not found in lenient mode
* @throws IOException resolving the resource failed
*/
DataSource resolve(String resourceLocation, boolean isLenient) throws
IOException;
diff --git
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/Email.java
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/Email.java
index f4f67b57..b84e3789 100644
---
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/Email.java
+++
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/Email.java
@@ -602,7 +602,7 @@ public abstract class Email {
*
* @param name the name of the header
* @param value the value of the header
- * @return the folded header value
+ * @return The folded header value
* @throws IllegalArgumentException if either the name or value is null or
empty
*/
private String createFoldedHeaderValue(final String name, final String
value) {
@@ -661,7 +661,7 @@ public abstract class Email {
* Creates a customized MimeMessage which can be implemented by a derived
class, e.g. to set the message id.
*
* @param aSession mail session to be used
- * @return the newly created message
+ * @return The newly created message
*/
protected MimeMessage createMimeMessage(final Session aSession) {
return new MimeMessage(aSession);
@@ -670,7 +670,7 @@ public abstract class Email {
/**
* Gets the authenticator.
*
- * @return the authenticator.
+ * @return The authenticator.
* @since 1.6.0
*/
public Authenticator getAuthenticator() {
@@ -689,7 +689,7 @@ public abstract class Email {
/**
* Gets the "bounce address" of this email.
*
- * @return the bounce address as string
+ * @return The bounce address as string
* @since 1.4
*/
public String getBounceAddress() {
@@ -708,7 +708,7 @@ public abstract class Email {
/**
* Gets the Charset.
*
- * @return the Charset.
+ * @return The Charset.
* @since 1.6.0
*/
public String getCharsetName() {
@@ -718,7 +718,7 @@ public abstract class Email {
/**
* Gets the content.
*
- * @return the content.
+ * @return The content.
* @since 1.6.0
*/
public Object getContent() {
@@ -728,7 +728,7 @@ public abstract class Email {
/**
* Gets the content type.
*
- * @return the content type.
+ * @return The content type.
* @since 1.6.0
*/
public String getContentType() {
@@ -738,7 +738,7 @@ public abstract class Email {
/**
* Gets the email body.
*
- * @return the email body.
+ * @return The email body.
* @since 1.6.0
*/
public MimeMultipart getEmailBody() {
@@ -856,7 +856,7 @@ public abstract class Email {
/**
* Gets the message.
*
- * @return the message.
+ * @return The message.
* @since 1.6.0
*/
public MimeMessage getMessage() {
@@ -866,7 +866,7 @@ public abstract class Email {
/**
* Gets the internal MimeMessage. Please note that the MimeMessage is
built by the buildMimeMessage() method.
*
- * @return the MimeMessage
+ * @return The MimeMessage
*/
public MimeMessage getMimeMessage() {
return message;
@@ -875,7 +875,7 @@ public abstract class Email {
/**
* Gets the POP3 host.
*
- * @return the POP3 host.
+ * @return The POP3 host.
* @since 1.6.0
*/
public String getPopHost() {
@@ -885,7 +885,7 @@ public abstract class Email {
/**
* Gets the POP3 password.
*
- * @return the POP3 password.
+ * @return The POP3 password.
* @since 1.6.0
*/
public String getPopPassword() {
@@ -895,7 +895,7 @@ public abstract class Email {
/**
* Gets the POP3 user name.
*
- * @return the POP3 user name.
+ * @return The POP3 user name.
* @since 1.6.0
*/
public String getPopUserName() {
@@ -942,7 +942,7 @@ public abstract class Email {
/**
* Gets the socket connection timeout value in milliseconds.
*
- * @return the timeout in milliseconds.
+ * @return The timeout in milliseconds.
* @since 1.2
*/
public int getSocketConnectionTimeout() {
@@ -952,7 +952,7 @@ public abstract class Email {
/**
* Gets the socket I/O timeout value in milliseconds.
*
- * @return the socket I/O timeout
+ * @return The socket I/O timeout
* @since 1.2
*/
public int getSocketTimeout() {
@@ -962,7 +962,7 @@ public abstract class Email {
/**
* Gets the current SSL port used by the SMTP transport.
*
- * @return the current SSL port used by the SMTP transport
+ * @return The current SSL port used by the SMTP transport
*/
public String getSslSmtpPort() {
if (session != null) {
@@ -1065,7 +1065,7 @@ public abstract class Email {
/**
* Sends the email. Internally we build a MimeMessage which is afterwards
sent to the SMTP server.
*
- * @return the message id of the underlying MimeMessage
+ * @return The message id of the underlying MimeMessage
* @throws IllegalStateException if the MimeMessage was already built,
that is, {@link #buildMimeMessage()} was already called
* @throws EmailException the sending failed
*/
@@ -1077,7 +1077,7 @@ public abstract class Email {
/**
* Sends the previously created MimeMessage to the SMTP server.
*
- * @return the message id of the underlying MimeMessage
+ * @return The message id of the underlying MimeMessage
* @throws IllegalArgumentException if the MimeMessage has not been created
* @throws EmailException the sending failed
*/
diff --git
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/HtmlEmail.java
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/HtmlEmail.java
index 5737a2f5..ba1a375c 100644
---
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/HtmlEmail.java
+++
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/HtmlEmail.java
@@ -125,7 +125,7 @@ public class HtmlEmail extends MultiPartEmail {
/**
* Returns the unique content ID of this InlineImage.
*
- * @return the unique content ID of this InlineImage
+ * @return The unique content ID of this InlineImage
*/
private String getCid() {
return cid;
@@ -134,7 +134,7 @@ public class HtmlEmail extends MultiPartEmail {
/**
* Returns the {@code DataSource} that represents the encoded content.
*
- * @return the {@code DataSource} representing the encoded content
+ * @return The {@code DataSource} representing the encoded content
*/
private DataSource getDataSource() {
return dataSource;
@@ -143,7 +143,7 @@ public class HtmlEmail extends MultiPartEmail {
/**
* Returns the {@code MimeBodyPart} that contains the encoded
InlineImage data.
*
- * @return the {@code MimeBodyPart} containing the encoded InlineImage
data
+ * @return The {@code MimeBodyPart} containing the encoded InlineImage
data
*/
private MimeBodyPart getMimeBodyPart() {
return mimeBodyPart;
@@ -296,7 +296,7 @@ public class HtmlEmail extends MultiPartEmail {
*
* @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}
+ * @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)
* @since 1.1
@@ -325,7 +325,7 @@ public class HtmlEmail extends MultiPartEmail {
* @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}
+ * @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
*/
@@ -500,7 +500,7 @@ public class HtmlEmail extends MultiPartEmail {
/**
* Gets the HTML content.
*
- * @return the HTML content.
+ * @return The HTML content.
* @since 1.6.0
*/
public String getHtml() {
@@ -510,7 +510,7 @@ public class HtmlEmail extends MultiPartEmail {
/**
* Gets the message text.
*
- * @return the message text.
+ * @return The message text.
* @since 1.6.0
*/
public String getText() {
diff --git
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/ImageHtmlEmail.java
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/ImageHtmlEmail.java
index 615c0a47..12871427 100644
---
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/ImageHtmlEmail.java
+++
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/ImageHtmlEmail.java
@@ -95,7 +95,7 @@ public class ImageHtmlEmail extends HtmlEmail {
/**
* Gets the data source resolver.
*
- * @return the resolver
+ * @return The resolver
*/
public DataSourceResolver getDataSourceResolver() {
return dataSourceResolver;
@@ -106,7 +106,7 @@ public class ImageHtmlEmail extends HtmlEmail {
*
* @param htmlMessage the HTML message to analyze
* @param pattern the regular expression to find resources
- * @return the HTML message containing "cid" references
+ * @return The HTML message containing "cid" references
* @throws EmailException creating the email failed
* @throws IOException resolving the resources failed
*/
diff --git
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/MultiPartEmail.java
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/MultiPartEmail.java
index cf26ad58..88797f93 100644
---
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/MultiPartEmail.java
+++
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/MultiPartEmail.java
@@ -323,7 +323,7 @@ public class MultiPartEmail extends Email {
/**
* Creates a body part object. Can be overridden if you don't want to
create a BodyPart.
*
- * @return the created body part
+ * @return The created body part
*/
protected BodyPart createBodyPart() {
return new MimeBodyPart();
@@ -332,7 +332,7 @@ public class MultiPartEmail extends Email {
/**
* Creates a mime multipart object.
*
- * @return the created mime part
+ * @return The created mime part
*/
protected MimeMultipart createMimeMultipart() {
return new MimeMultipart();
diff --git
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/activation/PathDataSource.java
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/activation/PathDataSource.java
index 68fa4911..4838f5e7 100644
---
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/activation/PathDataSource.java
+++
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/activation/PathDataSource.java
@@ -91,7 +91,7 @@ public final class PathDataSource implements DataSource {
* By default, the {@link FileTypeMap} used will be a {@link
MimetypesFileTypeMap}.
* </p>
*
- * @return the MIME Type
+ * @return The MIME Type
* @see FileTypeMap#getDefaultFileTypeMap
*/
@Override
@@ -113,7 +113,7 @@ public final class PathDataSource implements DataSource {
/**
* Gets the <em>name</em> of this object. The FileDataSource will return
the file name of the object.
*
- * @return the name of the object or null.
+ * @return The name of the object or null.
* @see jakarta.activation.DataSource
*/
@Override
@@ -135,7 +135,7 @@ public final class PathDataSource implements DataSource {
/**
* Gets the File object that corresponds to this PathDataSource.
*
- * @return the File object for the file represented by this object.
+ * @return The File object for the file represented by this object.
*/
public Path getPath() {
return path;
diff --git
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourceBaseResolver.java
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourceBaseResolver.java
index 2cfacbb0..35b27263 100644
---
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourceBaseResolver.java
+++
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourceBaseResolver.java
@@ -77,7 +77,7 @@ public abstract class DataSourceBaseResolver implements
DataSourceResolver {
/**
* Tests whether to ignore resources not found or throw an exception.
*
- * @return the lenient flag.
+ * @return The lenient flag.
*/
public boolean isLenient() {
return lenient;
diff --git
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourceClassPathResolver.java
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourceClassPathResolver.java
index 85656537..9b111e96 100644
---
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourceClassPathResolver.java
+++
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourceClassPathResolver.java
@@ -64,7 +64,7 @@ public class DataSourceClassPathResolver extends
DataSourceBaseResolver {
/**
* Gets the class path base.
*
- * @return the classPathBase
+ * @return The classPathBase
*/
public String getClassPathBase() {
return classPathBase;
diff --git
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourceFileResolver.java
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourceFileResolver.java
index 724e4c6f..cbac73b9 100644
---
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourceFileResolver.java
+++
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourceFileResolver.java
@@ -62,7 +62,7 @@ public class DataSourceFileResolver extends
DataSourceBaseResolver {
/**
* Gets the base directory used for resolving relative resource locations.
*
- * @return the baseUrl
+ * @return The baseUrl
*/
public File getBaseDir() {
return baseDir;
diff --git
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourcePathResolver.java
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourcePathResolver.java
index add58545..b72a54bf 100644
---
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourcePathResolver.java
+++
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourcePathResolver.java
@@ -76,7 +76,7 @@ public final class DataSourcePathResolver extends
DataSourceBaseResolver {
/**
* Gets the base directory used for resolving relative resource locations.
*
- * @return the baseUrl
+ * @return The baseUrl
*/
public Path getBaseDir() {
return baseDir;
diff --git
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourceUrlResolver.java
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourceUrlResolver.java
index 7bceaab0..fd20f054 100644
---
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourceUrlResolver.java
+++
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/resolver/DataSourceUrlResolver.java
@@ -60,7 +60,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
- * @return the corresponding URL
+ * @return The corresponding URL
* @throws java.net.MalformedURLException creating the URL failed
*/
protected URL createUrl(final String resourceLocation) throws
MalformedURLException {
@@ -83,7 +83,7 @@ public class DataSourceUrlResolver extends
DataSourceBaseResolver {
/**
* Gets the base URL used for resolving relative resource locations.
*
- * @return the baseUrl
+ * @return The baseUrl
*/
public URL getBaseUrl() {
return baseUrl;
diff --git
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/util/MimeMessageParser.java
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/util/MimeMessageParser.java
index f0db05e6..b97f3929 100644
---
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/util/MimeMessageParser.java
+++
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/util/MimeMessageParser.java
@@ -88,7 +88,7 @@ public class MimeMessageParser {
*
* @param parent the parent multi-part
* @param part the current part to be processed
- * @return the DataSource
+ * @return The DataSource
* @throws MessagingException creating the DataSource failed
* @throws IOException error getting InputStream or unsupported
encoding
*/
@@ -107,7 +107,7 @@ public class MimeMessageParser {
* </p>
*
* @param cid the content-id of the attachment
- * @return the corresponding datasource or null if nothing was found
+ * @return The corresponding datasource or null if nothing was found
* @since 1.3.4
*/
public DataSource findAttachmentByCid(final String cid) {
@@ -118,7 +118,7 @@ public class MimeMessageParser {
* Find an attachment using its name.
*
* @param name the name of the attachment
- * @return the corresponding datasource or null if nothing was found
+ * @return The corresponding datasource or null if nothing was found
*/
public DataSource findAttachmentByName(final String name) {
for (final DataSource dataSource : getAttachmentList()) {
@@ -132,7 +132,7 @@ public class MimeMessageParser {
/**
* Gets the attachment list.
*
- * @return the attachment list.
+ * @return The attachment list.
*/
public List<DataSource> getAttachmentList() {
return attachmentList;
@@ -142,7 +142,7 @@ public class MimeMessageParser {
* Gets the MIME type.
*
* @param fullMimeType the mime type from the mail API
- * @return the real mime type
+ * @return The real mime type
*/
private String getBaseMimeType(final String fullMimeType) {
final int pos = fullMimeType.indexOf(';');
@@ -152,7 +152,7 @@ public class MimeMessageParser {
/**
* Gets the BCC Address list.
*
- * @return the 'BCC' recipients of the message
+ * @return The 'BCC' recipients of the message
* @throws MessagingException determining the recipients failed
*/
public List<Address> getBcc() throws MessagingException {
@@ -162,7 +162,7 @@ public class MimeMessageParser {
/**
* Gets the CC Address list.
*
- * @return the 'CC' recipients of the message
+ * @return The 'CC' recipients of the message
* @throws MessagingException determining the recipients failed
*/
public List<Address> getCc() throws MessagingException {
@@ -175,7 +175,7 @@ public class MimeMessageParser {
* The content-ids are stripped of any angle brackets, i.e. "part1"
instead of "<part1>".
* </p>
*
- * @return the collection of content ids.
+ * @return The collection of content ids.
* @since 1.3.4
*/
public Collection<String> getContentIds() {
@@ -187,7 +187,7 @@ public class MimeMessageParser {
*
* @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
+ * @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
*/
@@ -207,7 +207,7 @@ public class MimeMessageParser {
/**
* Gets the FROM field.
*
- * @return the FROM field of the message
+ * @return The FROM field of the message
* @throws MessagingException parsing the mime message failed
*/
public String getFrom() throws MessagingException {
@@ -221,7 +221,7 @@ public class MimeMessageParser {
/**
* Gets the htmlContent if any.
*
- * @return the htmlContent if any
+ * @return The htmlContent if any
*/
public String getHtmlContent() {
return htmlContent;
@@ -230,7 +230,7 @@ public class MimeMessageParser {
/**
* Gets the MimeMessage.
*
- * @return the mimeMessage.
+ * @return The mimeMessage.
*/
public MimeMessage getMimeMessage() {
return mimeMessage;
@@ -239,7 +239,7 @@ public class MimeMessageParser {
/**
* Gets the plain content if any.
*
- * @return the plainContent if any
+ * @return The plainContent if any
*/
public String getPlainContent() {
return plainContent;
@@ -248,7 +248,7 @@ public class MimeMessageParser {
/**
* Gets the 'replyTo' address of the email.
*
- * @return the 'replyTo' address of the email
+ * @return The 'replyTo' address of the email
* @throws MessagingException parsing the mime message failed
*/
public String getReplyTo() throws MessagingException {
@@ -262,7 +262,7 @@ public class MimeMessageParser {
/**
* Gets the MIME message subject.
*
- * @return the MIME message subject.
+ * @return The MIME message subject.
* @throws MessagingException parsing the mime message failed.
*/
public String getSubject() throws MessagingException {
@@ -272,7 +272,7 @@ public class MimeMessageParser {
/**
* Gets the MIME message 'to' list.
*
- * @return the 'to' recipients of the message.
+ * @return The 'to' recipients of the message.
* @throws MessagingException determining the recipients failed
*/
public List<Address> getTo() throws MessagingException {
@@ -335,7 +335,7 @@ public class MimeMessageParser {
/**
* Tests whether this is multipart.
*
- * @return the isMultiPart.
+ * @return The isMultiPart.
*/
public boolean isMultipart() {
return isMultiPart;
diff --git
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/util/MimeMessageUtils.java
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/util/MimeMessageUtils.java
index 59a31047..8699a24e 100644
---
a/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/util/MimeMessageUtils.java
+++
b/commons-email2-jakarta/src/main/java/org/apache/commons/mail2/jakarta/util/MimeMessageUtils.java
@@ -43,7 +43,7 @@ public final class MimeMessageUtils {
*
* @param session the mail session.
* @param source the input data.
- * @return the MimeMessage.
+ * @return The MimeMessage.
* @throws MessagingException creating the MimeMessage failed.
* @throws IOException creating the MimeMessage failed.
*/
@@ -58,7 +58,7 @@ public final class MimeMessageUtils {
*
* @param session the mail session.
* @param source the input data.
- * @return the MimeMessage.
+ * @return The MimeMessage.
* @throws MessagingException creating the MimeMessage failed.
* @throws IOException creating the MimeMessage failed.
*/
@@ -71,7 +71,7 @@ public final class MimeMessageUtils {
*
* @param session the mail session.
* @param source the input data.
- * @return the MimeMessage.
+ * @return The MimeMessage.
* @throws MessagingException creating the MimeMessage failed.
*/
public static MimeMessage createMimeMessage(final Session session, final
InputStream source) throws MessagingException {
@@ -84,7 +84,7 @@ public final class MimeMessageUtils {
* @param session the mail session.
* @param source the input data.
* @param options options specifying how the file is opened.
- * @return the MimeMessage.
+ * @return The MimeMessage.
* @throws MessagingException creating the MimeMessage failed.
* @throws IOException creating the MimeMessage failed.
*/
@@ -99,7 +99,7 @@ public final class MimeMessageUtils {
*
* @param session the mail session.
* @param source the input data.
- * @return the MimeMessage.
+ * @return The MimeMessage.
* @throws MessagingException creating the MimeMessage failed.
* @throws IOException creating the MimeMessage failed.
*/
diff --git
a/commons-email2-jakarta/src/test/java/org/apache/commons/mail2/jakarta/AbstractEmailTest.java
b/commons-email2-jakarta/src/test/java/org/apache/commons/mail2/jakarta/AbstractEmailTest.java
index 90c2f7d0..def99c4b 100644
---
a/commons-email2-jakarta/src/test/java/org/apache/commons/mail2/jakarta/AbstractEmailTest.java
+++
b/commons-email2-jakarta/src/test/java/org/apache/commons/mail2/jakarta/AbstractEmailTest.java
@@ -145,7 +145,7 @@ public abstract class AbstractEmailTest {
/**
* Gets the mail server port.
*
- * @return the port the server is running on.
+ * @return The port the server is running on.
*/
protected int getMailServerPort() {
return mailServerPort;
diff --git
a/commons-email2-jakarta/src/test/java/org/apache/commons/mail2/jakarta/EmailLiveTest.java
b/commons-email2-jakarta/src/test/java/org/apache/commons/mail2/jakarta/EmailLiveTest.java
index 2d2ad785..88b5092f 100644
---
a/commons-email2-jakarta/src/test/java/org/apache/commons/mail2/jakarta/EmailLiveTest.java
+++
b/commons-email2-jakarta/src/test/java/org/apache/commons/mail2/jakarta/EmailLiveTest.java
@@ -52,7 +52,7 @@ class EmailLiveTest extends AbstractEmailTest {
* Factory method to create a pre-configured email instance.
*
* @param clazz the requested implementation class
- * @return the new instance
+ * @return The new instance
* @throws Exception creating the Email instance failed
*/
private Email create(final Class<? extends Email> clazz) throws Exception {
diff --git
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/DataSourceResolver.java
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/DataSourceResolver.java
index 8e37d960..3d5f1f0b 100644
---
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/DataSourceResolver.java
+++
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/DataSourceResolver.java
@@ -31,7 +31,7 @@ public interface DataSourceResolver {
* Resolves the given resource location to a {@code DataSource}.
*
* @param resourceLocation the location of the resource
- * @return the {@code DataSource}
+ * @return The {@code DataSource}
* @throws IOException the resource was not found
*/
DataSource resolve(String resourceLocation) throws IOException;
@@ -41,7 +41,7 @@ public interface DataSourceResolver {
*
* @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
+ * @return The data source containing the resource or null if the resource
was not found in lenient mode
* @throws IOException resolving the resource failed
*/
DataSource resolve(String resourceLocation, boolean isLenient) throws
IOException;
diff --git
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/Email.java
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/Email.java
index 1bea918c..864519dc 100644
---
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/Email.java
+++
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/Email.java
@@ -601,7 +601,7 @@ public abstract class Email {
*
* @param name the name of the header
* @param value the value of the header
- * @return the folded header value
+ * @return The folded header value
* @throws IllegalArgumentException if either the name or value is null or
empty
*/
private String createFoldedHeaderValue(final String name, final String
value) {
@@ -660,7 +660,7 @@ public abstract class Email {
* Creates a customized MimeMessage which can be implemented by a derived
class, e.g. to set the message id.
*
* @param aSession mail session to be used
- * @return the newly created message
+ * @return The newly created message
*/
protected MimeMessage createMimeMessage(final Session aSession) {
return new MimeMessage(aSession);
@@ -669,7 +669,7 @@ public abstract class Email {
/**
* Gets the authenticator.
*
- * @return the authenticator.
+ * @return The authenticator.
* @since 1.6.0
*/
public Authenticator getAuthenticator() {
@@ -688,7 +688,7 @@ public abstract class Email {
/**
* Gets the "bounce address" of this email.
*
- * @return the bounce address as string
+ * @return The bounce address as string
* @since 1.4
*/
public String getBounceAddress() {
@@ -707,7 +707,7 @@ public abstract class Email {
/**
* Gets the Charset.
*
- * @return the Charset.
+ * @return The Charset.
* @since 1.6.0
*/
public String getCharsetName() {
@@ -717,7 +717,7 @@ public abstract class Email {
/**
* Gets the content.
*
- * @return the content.
+ * @return The content.
* @since 1.6.0
*/
public Object getContent() {
@@ -727,7 +727,7 @@ public abstract class Email {
/**
* Gets the content type.
*
- * @return the content type.
+ * @return The content type.
* @since 1.6.0
*/
public String getContentType() {
@@ -737,7 +737,7 @@ public abstract class Email {
/**
* Gets the email body.
*
- * @return the email body.
+ * @return The email body.
* @since 1.6.0
*/
public MimeMultipart getEmailBody() {
@@ -855,7 +855,7 @@ public abstract class Email {
/**
* Gets the message.
*
- * @return the message.
+ * @return The message.
* @since 1.6.0
*/
public MimeMessage getMessage() {
@@ -865,7 +865,7 @@ public abstract class Email {
/**
* Gets the internal MimeMessage. Please note that the MimeMessage is
built by the buildMimeMessage() method.
*
- * @return the MimeMessage
+ * @return The MimeMessage
*/
public MimeMessage getMimeMessage() {
return message;
@@ -874,7 +874,7 @@ public abstract class Email {
/**
* Gets the POP3 host.
*
- * @return the POP3 host.
+ * @return The POP3 host.
* @since 1.6.0
*/
public String getPopHost() {
@@ -884,7 +884,7 @@ public abstract class Email {
/**
* Gets the POP3 password.
*
- * @return the POP3 password.
+ * @return The POP3 password.
* @since 1.6.0
*/
public String getPopPassword() {
@@ -894,7 +894,7 @@ public abstract class Email {
/**
* Gets the POP3 user name.
*
- * @return the POP3 user name.
+ * @return The POP3 user name.
* @since 1.6.0
*/
public String getPopUserName() {
@@ -941,7 +941,7 @@ public abstract class Email {
/**
* Gets the socket connection timeout value in milliseconds.
*
- * @return the timeout in milliseconds.
+ * @return The timeout in milliseconds.
* @since 1.2
*/
public int getSocketConnectionTimeout() {
@@ -951,7 +951,7 @@ public abstract class Email {
/**
* Gets the socket I/O timeout value in milliseconds.
*
- * @return the socket I/O timeout
+ * @return The socket I/O timeout
* @since 1.2
*/
public int getSocketTimeout() {
@@ -961,7 +961,7 @@ public abstract class Email {
/**
* Gets the current SSL port used by the SMTP transport.
*
- * @return the current SSL port used by the SMTP transport
+ * @return The current SSL port used by the SMTP transport
*/
public String getSslSmtpPort() {
if (session != null) {
@@ -1064,7 +1064,7 @@ public abstract class Email {
/**
* Sends the email. Internally we build a MimeMessage which is afterwards
sent to the SMTP server.
*
- * @return the message id of the underlying MimeMessage
+ * @return The message id of the underlying MimeMessage
* @throws IllegalStateException if the MimeMessage was already built,
that is, {@link #buildMimeMessage()} was already called
* @throws EmailException the sending failed
*/
@@ -1076,7 +1076,7 @@ public abstract class Email {
/**
* Sends the previously created MimeMessage to the SMTP server.
*
- * @return the message id of the underlying MimeMessage
+ * @return The message id of the underlying MimeMessage
* @throws IllegalArgumentException if the MimeMessage has not been created
* @throws EmailException the sending failed
*/
diff --git
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/HtmlEmail.java
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/HtmlEmail.java
index fd7ba2da..5b034b71 100644
---
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/HtmlEmail.java
+++
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/HtmlEmail.java
@@ -125,7 +125,7 @@ public class HtmlEmail extends MultiPartEmail {
/**
* Returns the unique content ID of this InlineImage.
*
- * @return the unique content ID of this InlineImage
+ * @return The unique content ID of this InlineImage
*/
private String getCid() {
return cid;
@@ -134,7 +134,7 @@ public class HtmlEmail extends MultiPartEmail {
/**
* Returns the {@code DataSource} that represents the encoded content.
*
- * @return the {@code DataSource} representing the encoded content
+ * @return The {@code DataSource} representing the encoded content
*/
private DataSource getDataSource() {
return dataSource;
@@ -143,7 +143,7 @@ public class HtmlEmail extends MultiPartEmail {
/**
* Returns the {@code MimeBodyPart} that contains the encoded
InlineImage data.
*
- * @return the {@code MimeBodyPart} containing the encoded InlineImage
data
+ * @return The {@code MimeBodyPart} containing the encoded InlineImage
data
*/
private MimeBodyPart getMimeBodyPart() {
return mimeBodyPart;
@@ -296,7 +296,7 @@ public class HtmlEmail extends MultiPartEmail {
*
* @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}
+ * @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)
* @since 1.1
@@ -325,7 +325,7 @@ public class HtmlEmail extends MultiPartEmail {
* @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}
+ * @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
*/
@@ -500,7 +500,7 @@ public class HtmlEmail extends MultiPartEmail {
/**
* Gets the HTML content.
*
- * @return the HTML content.
+ * @return The HTML content.
* @since 1.6.0
*/
public String getHtml() {
@@ -510,7 +510,7 @@ public class HtmlEmail extends MultiPartEmail {
/**
* Gets the message text.
*
- * @return the message text.
+ * @return The message text.
* @since 1.6.0
*/
public String getText() {
diff --git
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/ImageHtmlEmail.java
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/ImageHtmlEmail.java
index c3ba6af5..43d9bca6 100644
---
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/ImageHtmlEmail.java
+++
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/ImageHtmlEmail.java
@@ -95,7 +95,7 @@ public class ImageHtmlEmail extends HtmlEmail {
/**
* Gets the data source resolver.
*
- * @return the resolver
+ * @return The resolver
*/
public DataSourceResolver getDataSourceResolver() {
return dataSourceResolver;
@@ -106,7 +106,7 @@ public class ImageHtmlEmail extends HtmlEmail {
*
* @param htmlMessage the HTML message to analyze
* @param pattern the regular expression to find resources
- * @return the HTML message containing "cid" references
+ * @return The HTML message containing "cid" references
* @throws EmailException creating the email failed
* @throws IOException resolving the resources failed
*/
diff --git
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/MultiPartEmail.java
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/MultiPartEmail.java
index 236d60f7..4933035a 100644
---
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/MultiPartEmail.java
+++
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/MultiPartEmail.java
@@ -322,7 +322,7 @@ public class MultiPartEmail extends Email {
/**
* Creates a body part object. Can be overridden if you don't want to
create a BodyPart.
*
- * @return the created body part
+ * @return The created body part
*/
protected BodyPart createBodyPart() {
return new MimeBodyPart();
@@ -331,7 +331,7 @@ public class MultiPartEmail extends Email {
/**
* Creates a mime multipart object.
*
- * @return the created mime part
+ * @return The created mime part
*/
protected MimeMultipart createMimeMultipart() {
return new MimeMultipart();
diff --git
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/activation/PathDataSource.java
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/activation/PathDataSource.java
index 7213c1de..5b630efb 100644
---
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/activation/PathDataSource.java
+++
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/activation/PathDataSource.java
@@ -91,7 +91,7 @@ public final class PathDataSource implements DataSource {
* By default, the {@link FileTypeMap} used will be a {@link
MimetypesFileTypeMap}.
* </p>
*
- * @return the MIME Type
+ * @return The MIME Type
* @see FileTypeMap#getDefaultFileTypeMap
*/
@Override
@@ -113,7 +113,7 @@ public final class PathDataSource implements DataSource {
/**
* Gets the <em>name</em> of this object. The FileDataSource will return
the file name of the object.
*
- * @return the name of the object or null.
+ * @return The name of the object or null.
* @see javax.activation.DataSource
*/
@Override
@@ -135,7 +135,7 @@ public final class PathDataSource implements DataSource {
/**
* Gets the File object that corresponds to this PathDataSource.
*
- * @return the File object for the file represented by this object.
+ * @return The File object for the file represented by this object.
*/
public Path getPath() {
return path;
diff --git
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourceBaseResolver.java
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourceBaseResolver.java
index 5d5da8d3..5343e513 100644
---
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourceBaseResolver.java
+++
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourceBaseResolver.java
@@ -77,7 +77,7 @@ public abstract class DataSourceBaseResolver implements
DataSourceResolver {
/**
* Tests whether to ignore resources not found or throw an exception.
*
- * @return the lenient flag.
+ * @return The lenient flag.
*/
public boolean isLenient() {
return lenient;
diff --git
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourceClassPathResolver.java
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourceClassPathResolver.java
index 91a290e9..b08a90bb 100644
---
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourceClassPathResolver.java
+++
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourceClassPathResolver.java
@@ -64,7 +64,7 @@ public class DataSourceClassPathResolver extends
DataSourceBaseResolver {
/**
* Gets the class path base.
*
- * @return the classPathBase
+ * @return The classPathBase
*/
public String getClassPathBase() {
return classPathBase;
diff --git
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourceFileResolver.java
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourceFileResolver.java
index 7036c1e5..d4676f40 100644
---
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourceFileResolver.java
+++
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourceFileResolver.java
@@ -62,7 +62,7 @@ public class DataSourceFileResolver extends
DataSourceBaseResolver {
/**
* Gets the base directory used for resolving relative resource locations.
*
- * @return the baseUrl
+ * @return The baseUrl
*/
public File getBaseDir() {
return baseDir;
diff --git
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourcePathResolver.java
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourcePathResolver.java
index 493b9f8f..88ef53a0 100644
---
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourcePathResolver.java
+++
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourcePathResolver.java
@@ -76,7 +76,7 @@ public final class DataSourcePathResolver extends
DataSourceBaseResolver {
/**
* Gets the base directory used for resolving relative resource locations.
*
- * @return the baseUrl
+ * @return The baseUrl
*/
public Path getBaseDir() {
return baseDir;
diff --git
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourceUrlResolver.java
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourceUrlResolver.java
index 0e4b0941..a88e3011 100644
---
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourceUrlResolver.java
+++
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/resolver/DataSourceUrlResolver.java
@@ -60,7 +60,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
- * @return the corresponding URL
+ * @return The corresponding URL
* @throws java.net.MalformedURLException creating the URL failed
*/
protected URL createUrl(final String resourceLocation) throws
MalformedURLException {
@@ -83,7 +83,7 @@ public class DataSourceUrlResolver extends
DataSourceBaseResolver {
/**
* Gets the base URL used for resolving relative resource locations.
*
- * @return the baseUrl
+ * @return The baseUrl
*/
public URL getBaseUrl() {
return baseUrl;
diff --git
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/util/MimeMessageParser.java
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/util/MimeMessageParser.java
index 0554b645..a8462ea6 100644
---
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/util/MimeMessageParser.java
+++
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/util/MimeMessageParser.java
@@ -88,7 +88,7 @@ public class MimeMessageParser {
*
* @param parent the parent multi-part
* @param part the current part to be processed
- * @return the DataSource
+ * @return The DataSource
* @throws MessagingException creating the DataSource failed
* @throws IOException error getting InputStream or unsupported
encoding
*/
@@ -107,7 +107,7 @@ public class MimeMessageParser {
* </p>
*
* @param cid the content-id of the attachment
- * @return the corresponding datasource or null if nothing was found
+ * @return The corresponding datasource or null if nothing was found
* @since 1.3.4
*/
public DataSource findAttachmentByCid(final String cid) {
@@ -118,7 +118,7 @@ public class MimeMessageParser {
* Find an attachment using its name.
*
* @param name the name of the attachment
- * @return the corresponding datasource or null if nothing was found
+ * @return The corresponding datasource or null if nothing was found
*/
public DataSource findAttachmentByName(final String name) {
for (final DataSource dataSource : getAttachmentList()) {
@@ -132,7 +132,7 @@ public class MimeMessageParser {
/**
* Gets the attachment list.
*
- * @return the attachment list.
+ * @return The attachment list.
*/
public List<DataSource> getAttachmentList() {
return attachmentList;
@@ -142,7 +142,7 @@ public class MimeMessageParser {
* Gets the MIME type.
*
* @param fullMimeType the mime type from the mail API
- * @return the real mime type
+ * @return The real mime type
*/
private String getBaseMimeType(final String fullMimeType) {
final int pos = fullMimeType.indexOf(';');
@@ -152,7 +152,7 @@ public class MimeMessageParser {
/**
* Gets the BCC Address list.
*
- * @return the 'BCC' recipients of the message
+ * @return The 'BCC' recipients of the message
* @throws MessagingException determining the recipients failed
*/
public List<Address> getBcc() throws MessagingException {
@@ -162,7 +162,7 @@ public class MimeMessageParser {
/**
* Gets the CC Address list.
*
- * @return the 'CC' recipients of the message
+ * @return The 'CC' recipients of the message
* @throws MessagingException determining the recipients failed
*/
public List<Address> getCc() throws MessagingException {
@@ -175,7 +175,7 @@ public class MimeMessageParser {
* The content-ids are stripped of any angle brackets, i.e. "part1"
instead of "<part1>".
* </p>
*
- * @return the collection of content ids.
+ * @return The collection of content ids.
* @since 1.3.4
*/
public Collection<String> getContentIds() {
@@ -187,7 +187,7 @@ public class MimeMessageParser {
*
* @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
+ * @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
*/
@@ -207,7 +207,7 @@ public class MimeMessageParser {
/**
* Gets the FROM field.
*
- * @return the FROM field of the message
+ * @return The FROM field of the message
* @throws MessagingException parsing the mime message failed
*/
public String getFrom() throws MessagingException {
@@ -221,7 +221,7 @@ public class MimeMessageParser {
/**
* Gets the htmlContent if any.
*
- * @return the htmlContent if any
+ * @return The htmlContent if any
*/
public String getHtmlContent() {
return htmlContent;
@@ -230,7 +230,7 @@ public class MimeMessageParser {
/**
* Gets the MimeMessage.
*
- * @return the mimeMessage.
+ * @return The mimeMessage.
*/
public MimeMessage getMimeMessage() {
return mimeMessage;
@@ -239,7 +239,7 @@ public class MimeMessageParser {
/**
* Gets the plain content if any.
*
- * @return the plainContent if any
+ * @return The plainContent if any
*/
public String getPlainContent() {
return plainContent;
@@ -248,7 +248,7 @@ public class MimeMessageParser {
/**
* Gets the 'replyTo' address of the email.
*
- * @return the 'replyTo' address of the email
+ * @return The 'replyTo' address of the email
* @throws MessagingException parsing the mime message failed
*/
public String getReplyTo() throws MessagingException {
@@ -262,7 +262,7 @@ public class MimeMessageParser {
/**
* Gets the MIME message subject.
*
- * @return the MIME message subject.
+ * @return The MIME message subject.
* @throws MessagingException parsing the mime message failed.
*/
public String getSubject() throws MessagingException {
@@ -272,7 +272,7 @@ public class MimeMessageParser {
/**
* Gets the MIME message 'to' list.
*
- * @return the 'to' recipients of the message.
+ * @return The 'to' recipients of the message.
* @throws MessagingException determining the recipients failed
*/
public List<Address> getTo() throws MessagingException {
@@ -335,7 +335,7 @@ public class MimeMessageParser {
/**
* Tests whether this is multipart.
*
- * @return the isMultiPart.
+ * @return The isMultiPart.
*/
public boolean isMultipart() {
return isMultiPart;
diff --git
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/util/MimeMessageUtils.java
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/util/MimeMessageUtils.java
index 06875c0a..2a2e5a84 100644
---
a/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/util/MimeMessageUtils.java
+++
b/commons-email2-javax/src/main/java/org/apache/commons/mail2/javax/util/MimeMessageUtils.java
@@ -43,7 +43,7 @@ public final class MimeMessageUtils {
*
* @param session the mail session.
* @param source the input data.
- * @return the MimeMessage.
+ * @return The MimeMessage.
* @throws MessagingException creating the MimeMessage failed.
* @throws IOException creating the MimeMessage failed.
*/
@@ -58,7 +58,7 @@ public final class MimeMessageUtils {
*
* @param session the mail session.
* @param source the input data.
- * @return the MimeMessage.
+ * @return The MimeMessage.
* @throws MessagingException creating the MimeMessage failed.
* @throws IOException creating the MimeMessage failed.
*/
@@ -71,7 +71,7 @@ public final class MimeMessageUtils {
*
* @param session the mail session.
* @param source the input data.
- * @return the MimeMessage.
+ * @return The MimeMessage.
* @throws MessagingException creating the MimeMessage failed.
*/
public static MimeMessage createMimeMessage(final Session session, final
InputStream source) throws MessagingException {
@@ -84,7 +84,7 @@ public final class MimeMessageUtils {
* @param session the mail session.
* @param source the input data.
* @param options options specifying how the file is opened.
- * @return the MimeMessage.
+ * @return The MimeMessage.
* @throws MessagingException creating the MimeMessage failed.
* @throws IOException creating the MimeMessage failed.
*/
@@ -99,7 +99,7 @@ public final class MimeMessageUtils {
*
* @param session the mail session.
* @param source the input data.
- * @return the MimeMessage.
+ * @return The MimeMessage.
* @throws MessagingException creating the MimeMessage failed.
* @throws IOException creating the MimeMessage failed.
*/
diff --git
a/commons-email2-javax/src/test/java/org/apache/commons/mail2/javax/AbstractEmailTest.java
b/commons-email2-javax/src/test/java/org/apache/commons/mail2/javax/AbstractEmailTest.java
index 5b1a43fa..6e438b6c 100644
---
a/commons-email2-javax/src/test/java/org/apache/commons/mail2/javax/AbstractEmailTest.java
+++
b/commons-email2-javax/src/test/java/org/apache/commons/mail2/javax/AbstractEmailTest.java
@@ -146,7 +146,7 @@ public abstract class AbstractEmailTest {
/**
* Gets the mail server port.
*
- * @return the port the server is running on.
+ * @return The port the server is running on.
*/
protected int getMailServerPort() {
return mailServerPort;
diff --git
a/commons-email2-javax/src/test/java/org/apache/commons/mail2/javax/EmailLiveTest.java
b/commons-email2-javax/src/test/java/org/apache/commons/mail2/javax/EmailLiveTest.java
index 917f04b2..55e7f59a 100644
---
a/commons-email2-javax/src/test/java/org/apache/commons/mail2/javax/EmailLiveTest.java
+++
b/commons-email2-javax/src/test/java/org/apache/commons/mail2/javax/EmailLiveTest.java
@@ -52,7 +52,7 @@ class EmailLiveTest extends AbstractEmailTest {
* Factory method to create a pre-configured email instance.
*
* @param clazz the requested implementation class
- * @return the new instance
+ * @return The new instance
* @throws Exception creating the Email instance failed
*/
private Email create(final Class<? extends Email> clazz) throws Exception {
