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 4f7cc50b Javadoc
4f7cc50b is described below
commit 4f7cc50bfb9213e10e7ec21de556cf32f78ae1e4
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:08:36 2026 -0400
Javadoc
---
src/main/java/org/apache/commons/mail/Email.java | 2 +-
src/main/java/org/apache/commons/mail/EmailUtils.java | 4 ++--
src/main/java/org/apache/commons/mail/activation/PathDataSource.java | 4 ++--
src/main/java/org/apache/commons/mail/util/MimeMessageParser.java | 2 +-
src/test/java/org/apache/commons/mail/AbstractEmailTest.java | 2 +-
5 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/src/main/java/org/apache/commons/mail/Email.java
b/src/main/java/org/apache/commons/mail/Email.java
index 28ef2c6f..84a53ff0 100644
--- a/src/main/java/org/apache/commons/mail/Email.java
+++ b/src/main/java/org/apache/commons/mail/Email.java
@@ -953,7 +953,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/src/main/java/org/apache/commons/mail/EmailUtils.java
b/src/main/java/org/apache/commons/mail/EmailUtils.java
index fb394419..dcf6e055 100644
--- a/src/main/java/org/apache/commons/mail/EmailUtils.java
+++ b/src/main/java/org/apache/commons/mail/EmailUtils.java
@@ -136,7 +136,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
- * @return a URL encoded string
+ * @return A URL encoded string
* @see <a href="https://tools.ietf.org/html/rfc2392";>RFC 2392</a>
*/
static String encodeUrl(final String input) {
@@ -285,7 +285,7 @@ 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
*/
static String replaceEndOfLineCharactersWithSpaces(final String input) {
return input == null ? null : input.replace('\n', ' ').replace('\r', '
');
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 be2f84c5..1f9d86c4 100644
--- a/src/main/java/org/apache/commons/mail/activation/PathDataSource.java
+++ b/src/main/java/org/apache/commons/mail/activation/PathDataSource.java
@@ -93,7 +93,7 @@ public final class PathDataSource implements DataSource {
* Gets an InputStream representing the data and will throw an IOException
if it can not 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 {
@@ -115,7 +115,7 @@ public final class PathDataSource implements DataSource {
* Gets an OutputStream representing the data and will throw an
IOException if it can not 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/src/main/java/org/apache/commons/mail/util/MimeMessageParser.java
b/src/main/java/org/apache/commons/mail/util/MimeMessageParser.java
index 41489493..c00c9848 100644
--- a/src/main/java/org/apache/commons/mail/util/MimeMessageParser.java
+++ b/src/main/java/org/apache/commons/mail/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/src/test/java/org/apache/commons/mail/AbstractEmailTest.java
b/src/test/java/org/apache/commons/mail/AbstractEmailTest.java
index 631f137d..1a9e3437 100644
--- a/src/test/java/org/apache/commons/mail/AbstractEmailTest.java
+++ b/src/test/java/org/apache/commons/mail/AbstractEmailTest.java
@@ -105,7 +105,7 @@ public abstract class AbstractEmailTest {
* Several ISPs do resolve invalid URLs like {@code
http://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 {
