Author: tn
Date: Thu Dec 13 20:25:53 2012
New Revision: 1421492
URL: http://svn.apache.org/viewvc?rev=1421492&view=rev
Log:
Perform changes wrt EmailConstants as agreed on ml.
Modified:
commons/proper/email/trunk/conf/checkstyle.xml
commons/proper/email/trunk/src/main/java/org/apache/commons/mail/Email.java
commons/proper/email/trunk/src/main/java/org/apache/commons/mail/EmailConstants.java
commons/proper/email/trunk/src/main/java/org/apache/commons/mail/HtmlEmail.java
commons/proper/email/trunk/src/main/java/org/apache/commons/mail/SimpleEmail.java
Modified: commons/proper/email/trunk/conf/checkstyle.xml
URL:
http://svn.apache.org/viewvc/commons/proper/email/trunk/conf/checkstyle.xml?rev=1421492&r1=1421491&r2=1421492&view=diff
==============================================================================
--- commons/proper/email/trunk/conf/checkstyle.xml (original)
+++ commons/proper/email/trunk/conf/checkstyle.xml Thu Dec 13 20:25:53 2012
@@ -161,7 +161,7 @@
<!-- See http://checkstyle.sf.net/config_design.html -->
<module name="FinalClass"/>
<module name="HideUtilityClassConstructor"/>
- <!-- <module name="InterfaceIsType"/> -->
+ <module name="InterfaceIsType"/>
<module name="VisibilityModifier">
<property name="protectedAllowed" value="true"/>
</module>
Modified:
commons/proper/email/trunk/src/main/java/org/apache/commons/mail/Email.java
URL:
http://svn.apache.org/viewvc/commons/proper/email/trunk/src/main/java/org/apache/commons/mail/Email.java?rev=1421492&r1=1421491&r2=1421492&view=diff
==============================================================================
--- commons/proper/email/trunk/src/main/java/org/apache/commons/mail/Email.java
(original)
+++ commons/proper/email/trunk/src/main/java/org/apache/commons/mail/Email.java
Thu Dec 13 20:25:53 2012
@@ -60,8 +60,124 @@ import javax.naming.NamingException;
* @author <a href="mailto:[email protected]";>Corey Scott</a>
* @version $Id$
*/
-public abstract class Email implements EmailConstants
+public abstract class Email
{
+ /** @deprecated since 1.3, use {@link EmailConstants#SENDER_EMAIL} instead
*/
+ @Deprecated
+ public static final String SENDER_EMAIL = EmailConstants.SENDER_EMAIL;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#SENDER_NAME} instead
*/
+ @Deprecated
+ public static final String SENDER_NAME = EmailConstants.SENDER_NAME;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#RECEIVER_EMAIL}
instead */
+ @Deprecated
+ public static final String RECEIVER_EMAIL = EmailConstants.RECEIVER_EMAIL;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#RECEIVER_NAME}
instead */
+ @Deprecated
+ public static final String RECEIVER_NAME = EmailConstants.RECEIVER_NAME;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#EMAIL_SUBJECT}
instead */
+ @Deprecated
+ public static final String EMAIL_SUBJECT = EmailConstants.EMAIL_SUBJECT;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#EMAIL_BODY} instead */
+ @Deprecated
+ public static final String EMAIL_BODY = EmailConstants.EMAIL_BODY;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#CONTENT_TYPE} instead
*/
+ @Deprecated
+ public static final String CONTENT_TYPE = EmailConstants.CONTENT_TYPE;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#ATTACHMENTS} instead
*/
+ @Deprecated
+ public static final String ATTACHMENTS = EmailConstants.ATTACHMENTS;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#FILE_SERVER} instead
*/
+ @Deprecated
+ public static final String FILE_SERVER = EmailConstants.FILE_SERVER;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#KOI8_R} instead */
+ @Deprecated
+ public static final String KOI8_R = EmailConstants.KOI8_R;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#ISO_8859_1} instead */
+ @Deprecated
+ public static final String ISO_8859_1 = EmailConstants.ISO_8859_1;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#US_ASCII} instead */
+ @Deprecated
+ public static final String US_ASCII = EmailConstants.US_ASCII;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#MAIL_DEBUG} instead */
+ @Deprecated
+ public static final String MAIL_DEBUG = EmailConstants.MAIL_DEBUG;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#MAIL_HOST} instead */
+ @Deprecated
+ public static final String MAIL_HOST = EmailConstants.MAIL_HOST;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#MAIL_PORT} instead */
+ @Deprecated
+ public static final String MAIL_PORT = EmailConstants.MAIL_PORT;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#MAIL_SMTP_FROM}
instead */
+ @Deprecated
+ public static final String MAIL_SMTP_FROM = EmailConstants.MAIL_SMTP_FROM;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#MAIL_SMTP_AUTH}
instead */
+ @Deprecated
+ public static final String MAIL_SMTP_AUTH = EmailConstants.MAIL_SMTP_AUTH;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#MAIL_SMTP_USER}
instead */
+ @Deprecated
+ public static final String MAIL_SMTP_USER = EmailConstants.MAIL_SMTP_USER;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#MAIL_SMTP_PASSWORD}
instead */
+ @Deprecated
+ public static final String MAIL_SMTP_PASSWORD =
EmailConstants.MAIL_SMTP_PASSWORD;
+
+ /** @deprecated since 1.3, use {@link
EmailConstants#MAIL_TRANSPORT_PROTOCOL} instead */
+ @Deprecated
+ public static final String MAIL_TRANSPORT_PROTOCOL =
EmailConstants.MAIL_TRANSPORT_PROTOCOL;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#SMTP} instead */
+ @Deprecated
+ public static final String SMTP = EmailConstants.SMTP;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#TEXT_HTML} instead */
+ @Deprecated
+ public static final String TEXT_HTML = EmailConstants.TEXT_HTML;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#TEXT_PLAIN} instead */
+ @Deprecated
+ public static final String TEXT_PLAIN = EmailConstants.TEXT_PLAIN;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#MAIL_TRANSPORT_TLS}
instead */
+ @Deprecated
+ public static final String MAIL_TRANSPORT_TLS =
EmailConstants.MAIL_TRANSPORT_TLS;
+
+ /** @deprecated since 1.3, use {@link
EmailConstants#MAIL_SMTP_SOCKET_FACTORY_FALLBACK} instead */
+ @Deprecated
+ public static final String MAIL_SMTP_SOCKET_FACTORY_FALLBACK =
EmailConstants.MAIL_SMTP_SOCKET_FACTORY_FALLBACK;
+
+ /** @deprecated since 1.3, use {@link
EmailConstants#MAIL_SMTP_SOCKET_FACTORY_CLASS} instead */
+ @Deprecated
+ public static final String MAIL_SMTP_SOCKET_FACTORY_CLASS =
EmailConstants.MAIL_SMTP_SOCKET_FACTORY_CLASS;
+
+ /** @deprecated since 1.3, use {@link
EmailConstants#MAIL_SMTP_SOCKET_FACTORY_PORT} instead */
+ @Deprecated
+ public static final String MAIL_SMTP_SOCKET_FACTORY_PORT =
EmailConstants.MAIL_SMTP_SOCKET_FACTORY_PORT;
+
+ /** @deprecated since 1.3, use {@link
EmailConstants#MAIL_SMTP_CONNECTIONTIMEOUT} instead */
+ @Deprecated
+ public static final String MAIL_SMTP_CONNECTIONTIMEOUT =
EmailConstants.MAIL_SMTP_CONNECTIONTIMEOUT;
+
+ /** @deprecated since 1.3, use {@link EmailConstants#MAIL_SMTP_TIMEOUT}
instead */
+ @Deprecated
+ public static final String MAIL_SMTP_TIMEOUT =
EmailConstants.MAIL_SMTP_TIMEOUT;
+
/** The email message to send. */
protected MimeMessage message;
@@ -171,10 +287,10 @@ public abstract class Email implements E
protected boolean ssl;
/** socket I/O timeout value in milliseconds. */
- protected int socketTimeout = SOCKET_TIMEOUT_MS;
+ protected int socketTimeout = EmailConstants.SOCKET_TIMEOUT_MS;
/** socket connection timeout value in milliseconds. */
- protected int socketConnectionTimeout = SOCKET_TIMEOUT_MS;
+ protected int socketConnectionTimeout = EmailConstants.SOCKET_TIMEOUT_MS;
/**
* If true, enables the use of the STARTTLS command (if supported by
@@ -524,8 +640,10 @@ public abstract class Email implements E
properties.setProperty(MAIL_HOST, this.hostName);
properties.setProperty(MAIL_DEBUG, String.valueOf(this.debug));
- properties.setProperty(MAIL_TRANSPORT_STARTTLS_ENABLE,
isStartTLSEnabled() ? "true" : "false");
- properties.setProperty(MAIL_TRANSPORT_STARTTLS_REQUIRED,
isStartTLSRequired() ? "true" : "false");
+
properties.setProperty(EmailConstants.MAIL_TRANSPORT_STARTTLS_ENABLE,
+ isStartTLSEnabled() ? "true" : "false");
+
properties.setProperty(EmailConstants.MAIL_TRANSPORT_STARTTLS_REQUIRED,
+ isStartTLSRequired() ? "true" : "false");
if (this.authenticator != null)
{
@@ -542,7 +660,7 @@ public abstract class Email implements E
if ((isSSLOnConnect() || isStartTLSEnabled()) &&
isSSLCheckServerIdentity())
{
- properties.setProperty(MAIL_SMTP_SSL_CHECKSERVERIDENTITY,
"true");
+
properties.setProperty(EmailConstants.MAIL_SMTP_SSL_CHECKSERVERIDENTITY,
"true");
}
if (this.bounceAddress != null)
Modified:
commons/proper/email/trunk/src/main/java/org/apache/commons/mail/EmailConstants.java
URL:
http://svn.apache.org/viewvc/commons/proper/email/trunk/src/main/java/org/apache/commons/mail/EmailConstants.java?rev=1421492&r1=1421491&r2=1421492&view=diff
==============================================================================
---
commons/proper/email/trunk/src/main/java/org/apache/commons/mail/EmailConstants.java
(original)
+++
commons/proper/email/trunk/src/main/java/org/apache/commons/mail/EmailConstants.java
Thu Dec 13 20:25:53 2012
@@ -21,78 +21,94 @@ package org.apache.commons.mail;
*
* A description of the mail session parameter you find at
* <a
href="http://java.sun.com/products/javamail/javadocs/com/sun/mail/smtp/package-summary.html";>
- *
http://java.sun.com/products/javamail/javadocs/com/sun/mail/smtp/package-summary.html
- * </a>.
+ *
http://java.sun.com/products/javamail/javadocs/com/sun/mail/smtp/package-summary.html</a>.
*
* @since 1.3
* @version $Id$
*/
-public interface EmailConstants
+public final class EmailConstants
{
- // Constants used by Email classes
+ /** @deprecated since 1.3, not in use since 1.0 */
+ @Deprecated
+ public static final String SENDER_EMAIL = "sender.email";
- /** @deprecated since 1.3 */
- String SENDER_EMAIL = "sender.email";
- /** @deprecated since 1.3 */
- String SENDER_NAME = "sender.name";
- /** @deprecated since 1.3 */
- String RECEIVER_EMAIL = "receiver.email";
- /** @deprecated since 1.3 */
- String RECEIVER_NAME = "receiver.name";
- /** @deprecated since 1.3 */
- String EMAIL_SUBJECT = "email.subject";
- /** @deprecated since 1.3 */
- String EMAIL_BODY = "email.body";
- /** @deprecated since 1.3 */
- String CONTENT_TYPE = "content.type";
- /** @deprecated since 1.3 */
- String ATTACHMENTS = "attachments";
- /** @deprecated since 1.3 */
- String FILE_SERVER = "file.server";
+ /** @deprecated since 1.3, not in use since 1.0 */
+ @Deprecated
+ public static final String SENDER_NAME = "sender.name";
+
+ /** @deprecated since 1.3, not in use since 1.0 */
+ @Deprecated
+ public static final String RECEIVER_EMAIL = "receiver.email";
+
+ /** @deprecated since 1.3, not in use since 1.0 */
+ public static final String RECEIVER_NAME = "receiver.name";
+
+ /** @deprecated since 1.3, not in use since 1.0 */
+ @Deprecated
+ public static final String EMAIL_SUBJECT = "email.subject";
+
+ /** @deprecated since 1.3, not in use since 1.0 */
+ @Deprecated
+ public static final String EMAIL_BODY = "email.body";
+
+ /** @deprecated since 1.3, not in use since 1.0 */
+ @Deprecated
+ public static final String CONTENT_TYPE = "content.type";
+
+ /** @deprecated since 1.3, not in use since 1.0 */
+ @Deprecated
+ public static final String ATTACHMENTS = "attachments";
+
+ /** @deprecated since 1.3, not in use since 1.0 */
+ @Deprecated
+ public static final String FILE_SERVER = "file.server";
// Charset constants
/** charset constant for koi8-r */
- String KOI8_R = "koi8-r";
+ public static final String KOI8_R = "koi8-r";
+
/** charset constant for iso-8859-1 */
- String ISO_8859_1 = "iso-8859-1";
+ public static final String ISO_8859_1 = "iso-8859-1";
+
/** charset constant for us-ascii */
- String US_ASCII = "us-ascii";
+ public static final String US_ASCII = "us-ascii";
+
/** charset constant for utf-8 */
- String UTF_8 = "utf-8";
+ public static final String UTF_8 = "utf-8";
/** The debug mode to be used. */
- String MAIL_DEBUG = "mail.debug";
+ public static final String MAIL_DEBUG = "mail.debug";
/** The host name of the mail server. */
- String MAIL_HOST = "mail.smtp.host";
+ public static final String MAIL_HOST = "mail.smtp.host";
/** The port number of the mail server. */
- String MAIL_PORT = "mail.smtp.port";
+ public static final String MAIL_PORT = "mail.smtp.port";
/** The email address to use for SMTP MAIL command. */
- String MAIL_SMTP_FROM = "mail.smtp.from";
+ public static final String MAIL_SMTP_FROM = "mail.smtp.from";
/** If set to true, tries to authenticate the user using the AUTH command.
*/
- String MAIL_SMTP_AUTH = "mail.smtp.auth";
+ public static final String MAIL_SMTP_AUTH = "mail.smtp.auth";
/** The SMTP user name. */
- String MAIL_SMTP_USER = "mail.smtp.user";
+ public static final String MAIL_SMTP_USER = "mail.smtp.user";
/** The SMTP password. */
- String MAIL_SMTP_PASSWORD = "mail.smtp.password";
+ public static final String MAIL_SMTP_PASSWORD = "mail.smtp.password";
/** Specifies the default transport protocol */
- String MAIL_TRANSPORT_PROTOCOL = "mail.transport.protocol";
+ public static final String MAIL_TRANSPORT_PROTOCOL =
"mail.transport.protocol";
/** the value to use SMTP as transport protocol */
- String SMTP = "smtp";
+ public static final String SMTP = "smtp";
/** defines the text/html content type */
- String TEXT_HTML = "text/html";
+ public static final String TEXT_HTML = "text/html";
/** defines the text/plain content type */
- String TEXT_PLAIN = "text/plain";
+ public static final String TEXT_PLAIN = "text/plain";
/////////////////////////////////////////////////////////////////////////
// since 1.1
@@ -100,31 +116,31 @@ public interface EmailConstants
/** @deprecated since 1.3 */
@Deprecated
- String MAIL_TRANSPORT_TLS = "mail.smtp.starttls.enable";
+ public static final String MAIL_TRANSPORT_TLS =
"mail.smtp.starttls.enable";
/**
* Indicates if the STARTTLS command shall be used to initiate a
TLS-secured connection.
* @since 1.1
*/
- String MAIL_TRANSPORT_STARTTLS_ENABLE = "mail.smtp.starttls.enable";
+ public static final String MAIL_TRANSPORT_STARTTLS_ENABLE =
"mail.smtp.starttls.enable";
/**
* Whether to use {@link java.net.Socket} as a fallback if the initial
connection fails or not.
* @since 1.1
*/
- String MAIL_SMTP_SOCKET_FACTORY_FALLBACK =
"mail.smtp.socketFactory.fallback";
+ public static final String MAIL_SMTP_SOCKET_FACTORY_FALLBACK =
"mail.smtp.socketFactory.fallback";
/**
* Specifies the {@link javax.net.SocketFactory} class to create smtp
sockets.
* @since 1.1
*/
- String MAIL_SMTP_SOCKET_FACTORY_CLASS = "mail.smtp.socketFactory.class";
+ public static final String MAIL_SMTP_SOCKET_FACTORY_CLASS =
"mail.smtp.socketFactory.class";
/**
* Specifies the port to connect to when using a socket factory.
* @since 1.1
*/
- String MAIL_SMTP_SOCKET_FACTORY_PORT = "mail.smtp.socketFactory.port";
+ public static final String MAIL_SMTP_SOCKET_FACTORY_PORT =
"mail.smtp.socketFactory.port";
/////////////////////////////////////////////////////////////////////////
// since 1.2
@@ -134,13 +150,13 @@ public interface EmailConstants
* Socket connection timeout value in milliseconds. Default is infinite
timeout.
* @since 1.2
*/
- String MAIL_SMTP_CONNECTIONTIMEOUT = "mail.smtp.connectiontimeout";
+ public static final String MAIL_SMTP_CONNECTIONTIMEOUT =
"mail.smtp.connectiontimeout";
/**
* Socket I/O timeout value in milliseconds. Default is infinite timeout.
* @since 1.2
*/
- String MAIL_SMTP_TIMEOUT = "mail.smtp.timeout";
+ public static final String MAIL_SMTP_TIMEOUT = "mail.smtp.timeout";
/////////////////////////////////////////////////////////////////////////
// since 1.3
@@ -150,36 +166,43 @@ public interface EmailConstants
* Default socket timeout.
* @since 1.3
*/
- int SOCKET_TIMEOUT_MS = 60000;
+ public static final int SOCKET_TIMEOUT_MS = 60000;
/**
* If true, requires the use of the STARTTLS command. If the server
doesn't support
* the STARTTLS command, the connection will fail.
* @since 1.3
*/
- String MAIL_TRANSPORT_STARTTLS_REQUIRED = "mail.smtp.starttls.required";
+ public static final String MAIL_TRANSPORT_STARTTLS_REQUIRED =
"mail.smtp.starttls.required";
/**
* If set to true, use SSL to connect and use the SSL port by default.
* @since 1.3
*/
- String MAIL_SMTP_SSL_ENABLE = "mail.smtp.ssl.enable";
+ public static final String MAIL_SMTP_SSL_ENABLE = "mail.smtp.ssl.enable";
/**
* If set to true, check the server identity as specified in RFC 2595.
* @since 1.3
*/
- String MAIL_SMTP_SSL_CHECKSERVERIDENTITY =
"mail.smtp.ssl.checkserveridentity";
+ public static final String MAIL_SMTP_SSL_CHECKSERVERIDENTITY =
"mail.smtp.ssl.checkserveridentity";
/**
* Specifies the {@link javax.net.ssl.SSLSocketFactory} class to use to
create SMTP SSL sockets.
* @since 1.3
*/
- String MAIL_SMTP_SSL_SOCKET_FACTORY_CLASS =
"mail.smtp.ssl.socketFactory.class";
+ public static final String MAIL_SMTP_SSL_SOCKET_FACTORY_CLASS =
"mail.smtp.ssl.socketFactory.class";
/**
* Specifies the port to connect to when using the SMTP SSL socket factory.
* @since 1.3
*/
- String MAIL_SMTP_SSL_SOCKET_FACTORY_PORT =
"mail.smtp.ssl.socketFactory.port";
+ public static final String MAIL_SMTP_SSL_SOCKET_FACTORY_PORT =
"mail.smtp.ssl.socketFactory.port";
+
+ /** Hide constructor. */
+ private EmailConstants()
+ {
+ // do nothing
+ }
+
}
Modified:
commons/proper/email/trunk/src/main/java/org/apache/commons/mail/HtmlEmail.java
URL:
http://svn.apache.org/viewvc/commons/proper/email/trunk/src/main/java/org/apache/commons/mail/HtmlEmail.java?rev=1421492&r1=1421491&r2=1421492&view=diff
==============================================================================
---
commons/proper/email/trunk/src/main/java/org/apache/commons/mail/HtmlEmail.java
(original)
+++
commons/proper/email/trunk/src/main/java/org/apache/commons/mail/HtmlEmail.java
Thu Dec 13 20:25:53 2012
@@ -584,11 +584,11 @@ public class HtmlEmail extends MultiPart
{
msgHtml.setContent(
this.html,
- Email.TEXT_HTML + "; charset=" + this.charset);
+ EmailConstants.TEXT_HTML + "; charset=" + this.charset);
}
else
{
- msgHtml.setContent(this.html, Email.TEXT_HTML);
+ msgHtml.setContent(this.html, EmailConstants.TEXT_HTML);
}
Iterator<InlineImage> iter = this.inlineEmbeds.values().iterator();
@@ -609,11 +609,11 @@ public class HtmlEmail extends MultiPart
{
msgText.setContent(
this.text,
- Email.TEXT_PLAIN + "; charset=" + this.charset);
+ EmailConstants.TEXT_PLAIN + "; charset=" + this.charset);
}
else
{
- msgText.setContent(this.text, Email.TEXT_PLAIN);
+ msgText.setContent(this.text, EmailConstants.TEXT_PLAIN);
}
}
}
Modified:
commons/proper/email/trunk/src/main/java/org/apache/commons/mail/SimpleEmail.java
URL:
http://svn.apache.org/viewvc/commons/proper/email/trunk/src/main/java/org/apache/commons/mail/SimpleEmail.java?rev=1421492&r1=1421491&r2=1421492&view=diff
==============================================================================
---
commons/proper/email/trunk/src/main/java/org/apache/commons/mail/SimpleEmail.java
(original)
+++
commons/proper/email/trunk/src/main/java/org/apache/commons/mail/SimpleEmail.java
Thu Dec 13 20:25:53 2012
@@ -48,7 +48,7 @@ public class SimpleEmail extends Email
throw new EmailException("Invalid message supplied");
}
- setContent(msg, TEXT_PLAIN);
+ setContent(msg, EmailConstants.TEXT_PLAIN);
return this;
}
}
