You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2019/05/30 19:18:57 UTC
[commons-email] branch master updated: Javadoc: Use "file name"
instead of "filename".
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 baf77b7 Javadoc: Use "file name" instead of "filename".
baf77b7 is described below
commit baf77b79c31556e96f405be191af7a164ccd68fa
Author: Gary Gregory <gg...@rocketsoftware.com>
AuthorDate: Thu May 30 15:18:52 2019 -0400
Javadoc: Use "file name" instead of "filename".
---
src/main/java/org/apache/commons/mail/EmailAttachment.java | 2 +-
src/main/java/org/apache/commons/mail/HtmlEmail.java | 10 +++++-----
.../java/org/apache/commons/mail/SendWithAttachmentsTest.java | 2 +-
3 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/src/main/java/org/apache/commons/mail/EmailAttachment.java b/src/main/java/org/apache/commons/mail/EmailAttachment.java
index f1b7897..cbe5733 100644
--- a/src/main/java/org/apache/commons/mail/EmailAttachment.java
+++ b/src/main/java/org/apache/commons/mail/EmailAttachment.java
@@ -125,7 +125,7 @@ public class EmailAttachment
/**
* Set the path to the attachment. The path can be absolute or relative
- * and should include the filename.
+ * and should include the file name.
* <p>
* Example: /home/user/images/image.jpg<br>
* Example: images/image.jpg
diff --git a/src/main/java/org/apache/commons/mail/HtmlEmail.java b/src/main/java/org/apache/commons/mail/HtmlEmail.java
index f80ba76..1714aa8 100644
--- a/src/main/java/org/apache/commons/mail/HtmlEmail.java
+++ b/src/main/java/org/apache/commons/mail/HtmlEmail.java
@@ -73,7 +73,7 @@ import javax.mail.internet.MimeMultipart;
* </pre>
*
* <p>Embedded entities are tracked by their name, which for <code>File</code>s is
- * the filename itself and for <code>URL</code>s is the canonical path. It is
+ * the file name itself and for <code>URL</code>s is the canonical path. It is
* an error to bind the same name to more than one entity, and this class will
* attempt to validate that for <code>File</code>s and <code>URL</code>s. When
* embedding a <code>DataSource</code>, the code uses the <code>equals()</code>
@@ -199,7 +199,7 @@ public class HtmlEmail extends MultiPartEmail
* then be embedded in the message.
*
* @param urlString String representation of the URL.
- * @param name The name that will be set in the filename header field.
+ * @param name The name that will be set in the file name header field.
* @return A String with the Content-ID of the URL.
* @throws EmailException when URL supplied is invalid or if {@code name} is null
* or empty; also see {@link javax.mail.internet.MimeBodyPart} for definitions
@@ -244,7 +244,7 @@ public class HtmlEmail extends MultiPartEmail
* may be part of a virtual host cluster.
*
* @param url The URL of the file.
- * @param name The name that will be set in the filename header
+ * @param name The name that will be set in the file name header
* field.
* @return A String with the Content-ID of the file.
* @throws EmailException when URL supplied is invalid or if {@code name} is null
@@ -416,7 +416,7 @@ public class HtmlEmail extends MultiPartEmail
* randomly generated Content-ID. Returns the generated Content-ID string.
*
* @param dataSource the <code>DataSource</code> to embed
- * @param name the name that will be set in the filename header field
+ * @param name the name that will be set in the file name header field
* @return the generated Content-ID for this <code>DataSource</code>
* @throws EmailException if the embedding fails or if <code>name</code> is
* null or empty
@@ -450,7 +450,7 @@ public class HtmlEmail extends MultiPartEmail
* specified Content-ID. Returns the specified Content-ID string.
*
* @param dataSource the <code>DataSource</code> to embed
- * @param name the name that will be set in the filename header field
+ * @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</code>
* @return the URL encoded Content-ID for this <code>DataSource</code>
* @throws EmailException if the embedding fails or if <code>name</code> is
diff --git a/src/test/java/org/apache/commons/mail/SendWithAttachmentsTest.java b/src/test/java/org/apache/commons/mail/SendWithAttachmentsTest.java
index 06c7848..a224998 100644
--- a/src/test/java/org/apache/commons/mail/SendWithAttachmentsTest.java
+++ b/src/test/java/org/apache/commons/mail/SendWithAttachmentsTest.java
@@ -128,7 +128,7 @@ public class SendWithAttachmentsTest extends AbstractEmailTest
this.email.addTo(this.strTestMailTo);
/** File to be used to test file attachments (Must be valid) */
- /** Use umlaut characters to test if the filename is properly encoded */
+ /** Use umlaut characters to test if the file name is properly encoded */
// use short name to avoid folding. Otherwise need to unfold when checking result.
attachment.setName("a>ä, o>ö, u>ü, au>äu");
attachment.setDescription("Test Attachment Desc");