This is an automated email from the ASF dual-hosted git repository.
ggregory 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 64277af Javadoc
64277af is described below
commit 64277afd4836bccd94356f3117daf74dc16cd4b3
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Dec 14 11:48:51 2023 -0500
Javadoc
---
src/main/java/org/apache/commons/mail/Email.java | 6 +++---
src/main/java/org/apache/commons/mail/EmailConstants.java | 14 +++++++-------
src/main/java/org/apache/commons/mail/HtmlEmail.java | 4 ++--
src/main/java/org/apache/commons/mail/ImageHtmlEmail.java | 8 ++++----
.../commons/mail/resolver/DataSourceBaseResolver.java | 2 +-
.../java/org/apache/commons/mail/AbstractEmailTest.java | 4 ++--
src/test/java/org/apache/commons/mail/EmailTest.java | 2 +-
.../java/org/apache/commons/mail/MultiPartEmailTest.java | 4 ++--
8 files changed, 22 insertions(+), 22 deletions(-)
diff --git a/src/main/java/org/apache/commons/mail/Email.java
b/src/main/java/org/apache/commons/mail/Email.java
index 3d3aba3..84de879 100644
--- a/src/main/java/org/apache/commons/mail/Email.java
+++ b/src/main/java/org/apache/commons/mail/Email.java
@@ -273,10 +273,10 @@ public abstract class Email {
@Deprecated
protected boolean ssl;
- /** socket I/O timeout value in milliseconds. */
+ /** Socket I/O timeout value in milliseconds. */
protected int socketTimeout = EmailConstants.SOCKET_TIMEOUT_MS;
- /** socket connection timeout value in milliseconds. */
+ /** Socket connection timeout value in milliseconds. */
protected int socketConnectionTimeout = EmailConstants.SOCKET_TIMEOUT_MS;
/**
@@ -291,7 +291,7 @@ public abstract class Email {
*/
private boolean startTlsRequired;
- /** does the current transport use SSL/TLS encryption upon connection? */
+ /** Does the current transport use SSL/TLS encryption upon connection? */
private boolean sslOnConnect;
/**
diff --git a/src/main/java/org/apache/commons/mail/EmailConstants.java
b/src/main/java/org/apache/commons/mail/EmailConstants.java
index 065c0ed..50729b1 100644
--- a/src/main/java/org/apache/commons/mail/EmailConstants.java
+++ b/src/main/java/org/apache/commons/mail/EmailConstants.java
@@ -63,16 +63,16 @@ public final class EmailConstants {
// Charset constants
- /** charset constant for koi8-r */
+ /** Charset constant for koi8-r */
public static final String KOI8_R = "koi8-r";
- /** charset constant for iso-8859-1 */
+ /** Charset constant for iso-8859-1 */
public static final String ISO_8859_1 = "iso-8859-1";
- /** charset constant for us-ascii */
+ /** Charset constant for us-ascii */
public static final String US_ASCII = "us-ascii";
- /** charset constant for utf-8 */
+ /** Charset constant for utf-8 */
public static final String UTF_8 = "utf-8";
/** The debug mode to be used. */
@@ -102,13 +102,13 @@ public final class EmailConstants {
/** The value to use SMTP as transport protocol */
public static final String SMTP = "smtp";
- /** defines the text/html content type */
+ /** Defines the text/html content type */
public static final String TEXT_HTML = "text/html";
- /** defines the html subtype */
+ /** Defines the html subtype */
public static final String TEXT_SUBTYPE_HTML = "html";
- /** defines the text/plain content type */
+ /** Defines the text/plain content type */
public static final String TEXT_PLAIN = "text/plain";
/////////////////////////////////////////////////////////////////////////
diff --git a/src/main/java/org/apache/commons/mail/HtmlEmail.java
b/src/main/java/org/apache/commons/mail/HtmlEmail.java
index d3c6fb1..9c21b45 100644
--- a/src/main/java/org/apache/commons/mail/HtmlEmail.java
+++ b/src/main/java/org/apache/commons/mail/HtmlEmail.java
@@ -167,10 +167,10 @@ public class HtmlEmail extends MultiPartEmail {
/** Definition of the length of generated CID's. */
public static final int CID_LENGTH = 10;
- /** prefix for default HTML mail. */
+ /** Prefix for default HTML mail. */
private static final String HTML_MESSAGE_START = "<html><body><pre>";
- /** suffix for default HTML mail. */
+ /** Suffix for default HTML mail. */
private static final String HTML_MESSAGE_END = "</pre></body></html>";
/**
diff --git a/src/main/java/org/apache/commons/mail/ImageHtmlEmail.java
b/src/main/java/org/apache/commons/mail/ImageHtmlEmail.java
index 1bad2ca..bda9734 100644
--- a/src/main/java/org/apache/commons/mail/ImageHtmlEmail.java
+++ b/src/main/java/org/apache/commons/mail/ImageHtmlEmail.java
@@ -48,19 +48,19 @@ public class ImageHtmlEmail extends HtmlEmail {
/** Regexp for extracting {@code <img>} tags */
public static final String REGEX_IMG_SRC =
"(<[Ii][Mm][Gg]\\s*[^>]*?\\s+[Ss][Rr][Cc]\\s*=\\s*[\"'])([^\"']+?)([\"'])";
- /** regexp for extracting {@code <script>} tags */
+ /** Regexp for extracting {@code <script>} tags */
public static final String REGEX_SCRIPT_SRC =
"(<[Ss][Cc][Rr][Ii][Pp][Tt]\\s*.*?\\s+[Ss][Rr][Cc]\\s*=\\s*[\"'])([^\"']+?)([\"'])";
// this pattern looks for the HTML image tag which indicates embedded
images,
// the grouping is necessary to allow to replace the element with the CID
- /** pattern for extracting <img> tags */
+ /** Pattern for extracting <img> tags */
private static final Pattern IMG_PATTERN = Pattern.compile(REGEX_IMG_SRC);
- /** pattern for extracting <script> tags */
+ /** Pattern for extracting <script> tags */
private static final Pattern SCRIPT_PATTERN =
Pattern.compile(REGEX_SCRIPT_SRC);
- /** resolve the images and script resources to a DataSource */
+ /** Resolve the images and script resources to a DataSource */
private DataSourceResolver dataSourceResolver;
/**
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 ae11d0f..5b124c8 100644
--- a/src/main/java/org/apache/commons/mail/resolver/DataSourceBaseResolver.java
+++ b/src/main/java/org/apache/commons/mail/resolver/DataSourceBaseResolver.java
@@ -25,7 +25,7 @@ import org.apache.commons.mail.DataSourceResolver;
*/
public abstract class DataSourceBaseResolver implements DataSourceResolver {
- /** shall we ignore resources not found or complain with an exception */
+ /** Shall we ignore resources not found or complain with an exception */
private final boolean lenient;
/**
diff --git a/src/test/java/org/apache/commons/mail/AbstractEmailTest.java
b/src/test/java/org/apache/commons/mail/AbstractEmailTest.java
index 350c464..a120d04 100644
--- a/src/test/java/org/apache/commons/mail/AbstractEmailTest.java
+++ b/src/test/java/org/apache/commons/mail/AbstractEmailTest.java
@@ -59,10 +59,10 @@ public abstract class AbstractEmailTest {
/** Line separator in email messages */
private static final String LINE_SEPARATOR = "\r\n";
- /** default port */
+ /** Default port */
private static int mailServerPort = 2500;
- /** counter for creating a file name */
+ /** Counter for creating a file name */
private static int fileNameCounter;
/** The fake Wiser email server */
diff --git a/src/test/java/org/apache/commons/mail/EmailTest.java
b/src/test/java/org/apache/commons/mail/EmailTest.java
index 0489161..b8fa1d1 100644
--- a/src/test/java/org/apache/commons/mail/EmailTest.java
+++ b/src/test/java/org/apache/commons/mail/EmailTest.java
@@ -58,7 +58,7 @@ public class EmailTest extends AbstractEmailTest {
private static final String[] VALID_EMAILS = { "m...@home.com",
"joe....@apache.org", "someone_h...@work-address.com.au" };
- /** mock for testing */
+ /** Mock for testing */
private MockEmailConcrete email;
@BeforeEach
diff --git a/src/test/java/org/apache/commons/mail/MultiPartEmailTest.java
b/src/test/java/org/apache/commons/mail/MultiPartEmailTest.java
index 909ffab..4a0b675 100644
--- a/src/test/java/org/apache/commons/mail/MultiPartEmailTest.java
+++ b/src/test/java/org/apache/commons/mail/MultiPartEmailTest.java
@@ -184,7 +184,7 @@ public class MultiPartEmailTest extends AbstractEmailTest {
assertTrue(true);
}
- /** test get/set sub type */
+ /** Test get/set sub type */
@Test
public void testGetSetSubType() {
for (final String validChar : testCharsValid) {
@@ -193,7 +193,7 @@ public class MultiPartEmailTest extends AbstractEmailTest {
}
}
- /** init called twice should fail */
+ /** Init called twice should fail */
@Test
public void testInit() {
// call the init function twice to trigger the IllegalStateException
