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 30dde26a Javadoc
30dde26a is described below
commit 30dde26a7b06a210c1043c954dfdb3b75b6c9a8c
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:08:34 2026 -0400
Javadoc
---
.../src/main/java/org/apache/commons/mail2/core/EmailUtils.java | 6 +++---
.../src/main/java/org/apache/commons/mail2/jakarta/Email.java | 2 +-
.../org/apache/commons/mail2/jakarta/activation/PathDataSource.java | 4 ++--
.../org/apache/commons/mail2/jakarta/util/MimeMessageParser.java | 2 +-
.../java/org/apache/commons/mail2/jakarta/AbstractEmailTest.java | 2 +-
.../src/main/java/org/apache/commons/mail2/javax/Email.java | 2 +-
.../org/apache/commons/mail2/javax/activation/PathDataSource.java | 4 ++--
.../java/org/apache/commons/mail2/javax/util/MimeMessageParser.java | 2 +-
.../test/java/org/apache/commons/mail2/javax/AbstractEmailTest.java | 2 +-
9 files changed, 13 insertions(+), 13 deletions(-)
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 81b2e1b2..1aa5ac27 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
@@ -133,7 +133,7 @@ public final class EmailUtils {
* Encodes an input string according to RFC 2392. Unsafe characters are
escaped.
*
* @param input the input string to be URL encoded
- * @return a URL encoded string
+ * @return A URL encoded string
* @see <a href="https://tools.ietf.org/html/rfc2392";>RFC 2392</a>
*/
public static String encodeUrl(final String input) {
@@ -300,7 +300,7 @@ public final class EmailUtils {
* Replaces end-of-line characters with spaces.
*
* @param input the input string to be scanned.
- * @return a clean string
+ * @return A clean string
*/
public static String replaceEndOfLineCharactersWithSpaces(final String
input) {
return input == null ? null : input.replace('\n', ' ').replace('\r', '
');
@@ -310,7 +310,7 @@ public final class EmailUtils {
* Converts the given string to lower case.
*
* @param value the input string.
- * @return a lower case string.
+ * @return A lower case string.
*/
public static String toLower(final String value) {
return value.toLowerCase(Locale.ROOT);
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 b84e3789..fc6da9b7 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
@@ -768,7 +768,7 @@ public abstract class Email {
/**
* Gets all headers on an Email.
*
- * @return a Map of all headers.
+ * @return A Map of all headers.
* @since 1.5
*/
public Map<String, String> getHeaders() {
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 4838f5e7..af846a9c 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
@@ -103,7 +103,7 @@ public final class PathDataSource implements DataSource {
* Gets an InputStream representing the data and will throw an IOException
if it cannot do so. This method will return a new instance of InputStream
* with each invocation.
*
- * @return an InputStream
+ * @return An InputStream
*/
@Override
public InputStream getInputStream() throws IOException {
@@ -125,7 +125,7 @@ public final class PathDataSource implements DataSource {
* Gets an OutputStream representing the data and will throw an
IOException if it cannot do so. This method will return a new instance of
OutputStream
* with each invocation.
*
- * @return an OutputStream
+ * @return An OutputStream
*/
@Override
public OutputStream getOutputStream() throws IOException {
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 b97f3929..982ce94a 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
@@ -388,7 +388,7 @@ public class MimeMessageParser {
* Strips the content id of any whitespace and angle brackets.
*
* @param contentId the string to strip
- * @return a stripped version of the content id
+ * @return A stripped version of the content id
*/
private String stripContentId(final String contentId) {
return contentId == null ? null :
contentId.trim().replaceAll("[\\<\\>]", "");
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 def99c4b..4b7c9604 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
@@ -104,7 +104,7 @@ public abstract class AbstractEmailTest {
* Several ISPs do resolve invalid URLs like {@code
https://example.invalid} to some error page causing tests to fail otherwise.
* </p>
*
- * @return an invalid URL
+ * @return An invalid URL
*/
@SuppressWarnings("resource") // openStream() returns null.
protected URL createInvalidURL() throws Exception {
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 864519dc..72745589 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
@@ -767,7 +767,7 @@ public abstract class Email {
/**
* Gets all headers on an Email.
*
- * @return a Map of all headers.
+ * @return A Map of all headers.
* @since 1.5
*/
public Map<String, String> getHeaders() {
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 5b630efb..14e6e4ef 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
@@ -103,7 +103,7 @@ public final class PathDataSource implements DataSource {
* Gets an InputStream representing the data and will throw an IOException
if it cannot do so. This method will return a new instance of InputStream
* with each invocation.
*
- * @return an InputStream
+ * @return An InputStream
*/
@Override
public InputStream getInputStream() throws IOException {
@@ -125,7 +125,7 @@ public final class PathDataSource implements DataSource {
* Gets an OutputStream representing the data and will throw an
IOException if it cannot do so. This method will return a new instance of
OutputStream
* with each invocation.
*
- * @return an OutputStream
+ * @return An OutputStream
*/
@Override
public OutputStream getOutputStream() throws IOException {
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 a8462ea6..c15b8480 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
@@ -388,7 +388,7 @@ public class MimeMessageParser {
* Strips the content id of any whitespace and angle brackets.
*
* @param contentId the string to strip
- * @return a stripped version of the content id
+ * @return A stripped version of the content id
*/
private String stripContentId(final String contentId) {
return contentId == null ? null :
contentId.trim().replaceAll("[\\<\\>]", "");
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 6e438b6c..ce397a27 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
@@ -104,7 +104,7 @@ public abstract class AbstractEmailTest {
* Several ISPs do resolve invalid URLs like {@code
https://example.invalid} to some error page causing tests to fail otherwise.
* </p>
*
- * @return an invalid URL
+ * @return An invalid URL
*/
@SuppressWarnings("resource") // openStream() returns null.
protected URL createInvalidURL() throws Exception {
