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 d57ac7b Normalize setter Javadoc
d57ac7b is described below
commit d57ac7b5846e702a72f34f1dfe7fadb3136eed19
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Oct 31 07:06:08 2023 -0400
Normalize setter Javadoc
---
src/main/java/org/apache/commons/mail/Email.java | 38 +++++++++++-----------
.../org/apache/commons/mail/EmailAttachment.java | 10 +++---
.../java/org/apache/commons/mail/HtmlEmail.java | 6 ++--
.../org/apache/commons/mail/ImageHtmlEmail.java | 2 +-
.../org/apache/commons/mail/MultiPartEmail.java | 4 +--
.../java/org/apache/commons/mail/SimpleEmail.java | 2 +-
6 files changed, 31 insertions(+), 31 deletions(-)
diff --git a/src/main/java/org/apache/commons/mail/Email.java
b/src/main/java/org/apache/commons/mail/Email.java
index 75f27ce..3164ebd 100644
--- a/src/main/java/org/apache/commons/mail/Email.java
+++ b/src/main/java/org/apache/commons/mail/Email.java
@@ -373,7 +373,7 @@ public abstract class Email
}
/**
- * Set the charset of the message. Please note that you should set the
charset before
+ * Sets the charset of the message. Please note that you should set the
charset before
* adding the message content.
*
* @param newCharset A String.
@@ -389,7 +389,7 @@ public abstract class Email
}
/**
- * Set the emailBody to a MimeMultiPart
+ * Sets the emailBody to a MimeMultiPart
*
* @param aMimeMultipart aMimeMultipart
* @since 1.0
@@ -400,7 +400,7 @@ public abstract class Email
}
/**
- * Set the content and contentType.
+ * Sets the content and contentType.
*
* @param aObject aObject
* @param aContentType aContentType
@@ -466,7 +466,7 @@ public abstract class Email
}
/**
- * Set the hostname of the outgoing mail server.
+ * Sets the hostname of the outgoing mail server.
*
* @param aHostName aHostName
* @throws IllegalStateException if the mail session is already initialized
@@ -479,7 +479,7 @@ public abstract class Email
}
/**
- * Set or disable the STARTTLS encryption. Please see EMAIL-105
+ * Sets or disable the STARTTLS encryption. Please see EMAIL-105
* for the reasons of deprecation.
*
* @deprecated since 1.3, use setStartTLSEnabled() instead
@@ -493,7 +493,7 @@ public abstract class Email
}
/**
- * Set or disable the STARTTLS encryption.
+ * Sets or disable the STARTTLS encryption.
*
* @param startTlsEnabled true if STARTTLS requested, false otherwise
* @return An Email.
@@ -509,7 +509,7 @@ public abstract class Email
}
/**
- * Set or disable the required STARTTLS encryption.
+ * Sets or disable the required STARTTLS encryption.
* <p>
* Defaults to {@link #smtpPort}; can be overridden by using {@link
#setSmtpPort(int)}
*
@@ -526,7 +526,7 @@ public abstract class Email
}
/**
- * Set the non-SSL port number of the outgoing mail server.
+ * Sets the non-SSL port number of the outgoing mail server.
*
* @param aPortNumber aPortNumber
* @throws IllegalArgumentException if the port number is < 1
@@ -704,7 +704,7 @@ public abstract class Email
}
/**
- * Set the FROM field of the email to use the specified address. The email
+ * Sets the FROM field of the email to use the specified address. The email
* address will also be used as the personal name.
* The name will be encoded by the charset of {@link
#setCharset(java.lang.String) setCharset()}.
* If it is not set, it will be encoded using
@@ -723,7 +723,7 @@ public abstract class Email
}
/**
- * Set the FROM field of the email to use the specified address and the
+ * Sets the FROM field of the email to use the specified address and the
* specified personal name.
* The name will be encoded by the charset of {@link
#setCharset(java.lang.String) setCharset()}.
* If it is not set, it will be encoded using
@@ -743,7 +743,7 @@ public abstract class Email
}
/**
- * Set the FROM field of the email to use the specified address, personal
+ * Sets the FROM field of the email to use the specified address, personal
* name, and charset encoding for the name.
*
* @param email A String.
@@ -850,7 +850,7 @@ public abstract class Email
}
/**
- * Set a list of "TO" addresses. All elements in the specified
+ * Sets a list of "TO" addresses. All elements in the specified
* {@code Collection} are expected to be of type
* {@code java.mail.internet.InternetAddress}.
*
@@ -959,7 +959,7 @@ public abstract class Email
}
/**
- * Set a list of "CC" addresses. All elements in the specified
+ * Sets a list of "CC" addresses. All elements in the specified
* {@code Collection} are expected to be of type
* {@code java.mail.internet.InternetAddress}.
*
@@ -1068,7 +1068,7 @@ public abstract class Email
}
/**
- * Set a list of "BCC" addresses. All elements in the specified
+ * Sets a list of "BCC" addresses. All elements in the specified
* {@code Collection} are expected to be of type
* {@code java.mail.internet.InternetAddress}.
*
@@ -1147,7 +1147,7 @@ public abstract class Email
}
/**
- * Set a list of reply to addresses. All elements in the specified
+ * Sets a list of reply to addresses. All elements in the specified
* {@code Collection} are expected to be of type
* {@code java.mail.internet.InternetAddress}.
*
@@ -1259,7 +1259,7 @@ public abstract class Email
}
/**
- * Set the "bounce address" - the address to which undeliverable messages
+ * Sets the "bounce address" - the address to which undeliverable messages
* will be returned. If this value is never set, then the message will be
* sent to the address specified with the System property "mail.smtp.from",
* or if that value is not set, then to the "from" address.
@@ -1636,7 +1636,7 @@ public abstract class Email
}
/**
- * Set details regarding "pop3 before SMTP" authentication.
+ * Sets details regarding "pop3 before SMTP" authentication.
*
* @param newPopBeforeSmtp Whether or not to log into pop3 server before
sending mail.
* @param newPopHost The pop3 host to use.
@@ -1854,7 +1854,7 @@ public abstract class Email
}
/**
- * Set the socket connection timeout value in milliseconds.
+ * Sets the socket connection timeout value in milliseconds.
* Default is a 60 second timeout.
*
* @param socketConnectionTimeout the connection timeout
@@ -1879,7 +1879,7 @@ public abstract class Email
}
/**
- * Set the socket I/O timeout value in milliseconds.
+ * Sets the socket I/O timeout value in milliseconds.
* Default is 60 second timeout.
*
* @param socketTimeout the socket I/O timeout
diff --git a/src/main/java/org/apache/commons/mail/EmailAttachment.java
b/src/main/java/org/apache/commons/mail/EmailAttachment.java
index 6d67c35..83c4149 100644
--- a/src/main/java/org/apache/commons/mail/EmailAttachment.java
+++ b/src/main/java/org/apache/commons/mail/EmailAttachment.java
@@ -102,7 +102,7 @@ public class EmailAttachment
}
/**
- * Set the description.
+ * Sets the description.
*
* @param desc A String.
* @since 1.0
@@ -113,7 +113,7 @@ public class EmailAttachment
}
/**
- * Set the name.
+ * Sets the name.
*
* @param aName A String.
* @since 1.0
@@ -124,7 +124,7 @@ public class EmailAttachment
}
/**
- * Set the path to the attachment. The path can be absolute or relative
+ * Sets the path to the attachment. The path can be absolute or relative
* and should include the file name.
* <p>
* Example: /home/user/images/image.jpg<br>
@@ -139,7 +139,7 @@ public class EmailAttachment
}
/**
- * Set the URL.
+ * Sets the URL.
*
* @param aUrl A URL.
* @since 1.0
@@ -150,7 +150,7 @@ public class EmailAttachment
}
/**
- * Set the disposition.
+ * Sets the disposition.
*
* @param aDisposition A String.
* @since 1.0
diff --git a/src/main/java/org/apache/commons/mail/HtmlEmail.java
b/src/main/java/org/apache/commons/mail/HtmlEmail.java
index 1cfa10b..512d3c1 100644
--- a/src/main/java/org/apache/commons/mail/HtmlEmail.java
+++ b/src/main/java/org/apache/commons/mail/HtmlEmail.java
@@ -114,7 +114,7 @@ public class HtmlEmail extends MultiPartEmail
protected Map<String, InlineImage> inlineEmbeds = new HashMap<>();
/**
- * Set the text content.
+ * Sets the text content.
*
* @param aText A String.
* @return An HtmlEmail.
@@ -134,7 +134,7 @@ public class HtmlEmail extends MultiPartEmail
}
/**
- * Set the HTML content.
+ * Sets the HTML content.
*
* @param aHtml A String.
* @return An HtmlEmail.
@@ -154,7 +154,7 @@ public class HtmlEmail extends MultiPartEmail
}
/**
- * Set the message.
+ * Sets the message.
*
* <p>This method overrides {@link MultiPartEmail#setMsg(String)} in
* order to send an HTML message instead of a plain text message in
diff --git a/src/main/java/org/apache/commons/mail/ImageHtmlEmail.java
b/src/main/java/org/apache/commons/mail/ImageHtmlEmail.java
index 5603cc5..3c455c8 100644
--- a/src/main/java/org/apache/commons/mail/ImageHtmlEmail.java
+++ b/src/main/java/org/apache/commons/mail/ImageHtmlEmail.java
@@ -80,7 +80,7 @@ public class ImageHtmlEmail extends HtmlEmail
}
/**
- * Set the data source resolver.
+ * Sets the data source resolver.
*
* @param dataSourceResolver the resolver
*/
diff --git a/src/main/java/org/apache/commons/mail/MultiPartEmail.java
b/src/main/java/org/apache/commons/mail/MultiPartEmail.java
index 7b30448..ae0dcc4 100644
--- a/src/main/java/org/apache/commons/mail/MultiPartEmail.java
+++ b/src/main/java/org/apache/commons/mail/MultiPartEmail.java
@@ -63,7 +63,7 @@ public class MultiPartEmail extends Email
private boolean boolHasAttachments;
/**
- * Set the MIME subtype of the email.
+ * Sets the MIME subtype of the email.
*
* @param aSubType MIME subtype of the email
* @since 1.0
@@ -175,7 +175,7 @@ public class MultiPartEmail extends Email
}
/**
- * Set the message of the email.
+ * Sets the message of the email.
*
* @param msg A String.
* @return An Email.
diff --git a/src/main/java/org/apache/commons/mail/SimpleEmail.java
b/src/main/java/org/apache/commons/mail/SimpleEmail.java
index ed4bd3f..a273920 100644
--- a/src/main/java/org/apache/commons/mail/SimpleEmail.java
+++ b/src/main/java/org/apache/commons/mail/SimpleEmail.java
@@ -25,7 +25,7 @@ package org.apache.commons.mail;
public class SimpleEmail extends Email
{
/**
- * Set the content of the mail.
+ * Sets the content of the mail.
*
* @param msg A String.
* @return An Email.
