Author: agilliland
Date: Thu May 3 11:27:13 2007
New Revision: 534952
URL: http://svn.apache.org/viewvc?view=rev&rev=534952
Log:
code reformatting and tidy up.
Modified:
roller/trunk/src/org/apache/roller/util/MailUtil.java
Modified: roller/trunk/src/org/apache/roller/util/MailUtil.java
URL:
http://svn.apache.org/viewvc/roller/trunk/src/org/apache/roller/util/MailUtil.java?view=diff&rev=534952&r1=534951&r2=534952
==============================================================================
--- roller/trunk/src/org/apache/roller/util/MailUtil.java (original)
+++ roller/trunk/src/org/apache/roller/util/MailUtil.java Thu May 3 11:27:13
2007
@@ -1,25 +1,25 @@
/*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. The ASF licenses this file to You
-* under the Apache License, Version 2.0 (the "License"); you may not
-* use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License. For additional information regarding
-* copyright in this work, please see the NOTICE file in the top level
-* directory of this distribution.
-*/
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. The ASF licenses this file to You
+ * under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License. For additional information regarding
+ * copyright in this work, please see the NOTICE file in the top level
+ * directory of this distribution.
+ */
+
package org.apache.roller.util;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
-
import javax.mail.Message;
import javax.mail.MessagingException;
import javax.mail.SendFailedException;
@@ -30,17 +30,20 @@
import javax.mail.internet.MimeMessage;
import org.apache.commons.lang.StringUtils;
-public class MailUtil extends Object {
-
- private static Log mLogger =
- LogFactory.getFactory().getInstance(MailUtil.class);
+/**
+ * A utility class for helping with sending emails.
+ */
+public class MailUtil {
+
+ private static Log log = LogFactory.getLog(MailUtil.class);
+
// agangolli: Incorporated suggested changes from Ken Blackler.
-
+
/**
* This method is used to send a Message with a pre-defined
* mime-type.
- *
+ *
* @param from e-mail address of sender
* @param to e-mail address(es) of recipients
* @param subject subject of e-mail
@@ -49,100 +52,91 @@
* @throws MessagingException the exception to indicate failure
*/
public static void sendMessage
- (
- Session session,
- String from,
- String[] to,
- String[] cc,
- String[] bcc,
- String subject,
- String content,
- String mimeType
- )
- throws MessagingException
- {
+ (
+ Session session,
+ String from,
+ String[] to,
+ String[] cc,
+ String[] bcc,
+ String subject,
+ String content,
+ String mimeType
+ )
+ throws MessagingException {
Message message = new MimeMessage(session);
-
+
// n.b. any default from address is expected to be determined by
caller.
if (! StringUtils.isEmpty(from)) {
- InternetAddress sentFrom = new InternetAddress(from);
- message.setFrom(sentFrom);
- if (mLogger.isDebugEnabled()) mLogger.debug("e-mail
from: " + sentFrom);
+ InternetAddress sentFrom = new InternetAddress(from);
+ message.setFrom(sentFrom);
+ if (log.isDebugEnabled()) log.debug("e-mail from: " + sentFrom);
+ }
+
+ if (to!=null) {
+ InternetAddress[] sendTo = new InternetAddress[to.length];
+
+ for (int i = 0; i < to.length; i++) {
+ sendTo[i] = new InternetAddress(to[i]);
+ if (log.isDebugEnabled()) log.debug("sending e-mail to: " +
to[i]);
+ }
+ message.setRecipients(Message.RecipientType.TO, sendTo);
+ }
+
+ if (cc != null) {
+ InternetAddress[] copyTo = new InternetAddress[cc.length];
+
+ for (int i = 0; i < cc.length; i++) {
+ copyTo[i] = new InternetAddress(cc[i]);
+ if (log.isDebugEnabled()) log.debug("copying e-mail to: " +
cc[i]);
+ }
+ message.setRecipients(Message.RecipientType.CC, copyTo);
+ }
+
+ if (bcc != null) {
+ InternetAddress[] copyTo = new InternetAddress[bcc.length];
+
+ for (int i = 0; i < bcc.length; i++) {
+ copyTo[i] = new InternetAddress(bcc[i]);
+ if (log.isDebugEnabled()) log.debug("blind copying e-mail to:
" + bcc[i]);
+ }
+ message.setRecipients(Message.RecipientType.BCC, copyTo);
}
-
- if (to!=null)
- {
- InternetAddress[] sendTo = new
InternetAddress[to.length];
-
- for (int i = 0; i < to.length; i++)
- {
- sendTo[i] = new InternetAddress(to[i]);
- if (mLogger.isDebugEnabled())
mLogger.debug("sending e-mail to: " + to[i]);
- }
- message.setRecipients(Message.RecipientType.TO, sendTo);
- }
-
- if (cc != null)
- {
- InternetAddress[] copyTo = new
InternetAddress[cc.length];
-
- for (int i = 0; i < cc.length; i++)
- {
- copyTo[i] = new InternetAddress(cc[i]);
- if (mLogger.isDebugEnabled())
mLogger.debug("copying e-mail to: " + cc[i]);
- }
- message.setRecipients(Message.RecipientType.CC, copyTo);
- }
-
- if (bcc != null)
- {
- InternetAddress[] copyTo = new
InternetAddress[bcc.length];
-
- for (int i = 0; i < bcc.length; i++)
- {
- copyTo[i] = new InternetAddress(bcc[i]);
- if (mLogger.isDebugEnabled())
mLogger.debug("blind copying e-mail to: " + bcc[i]);
- }
- message.setRecipients(Message.RecipientType.BCC,
copyTo);
- }
message.setSubject((subject == null) ? "(no subject)" : subject);
message.setContent(content, mimeType);
- message.setSentDate(new java.util.Date());
-
- // First collect all the addresses together.
+ message.setSentDate(new java.util.Date());
+
+ // First collect all the addresses together.
Address[] remainingAddresses = message.getAllRecipients();
int nAddresses = remainingAddresses.length;
boolean bFailedToSome = false;
SendFailedException sendex = new SendFailedException("Unable to send
message to some recipients");
- // Try to send while there remain some potentially good
addresses
- do
+ // Try to send while there remain some potentially good addresses
+ do
{
- // Avoid a loop if we are stuck
- nAddresses = remainingAddresses.length;
-
- try
- {
- // Send to the list of remaining addresses,
ignoring the addresses attached to the message
- Transport.send(message,remainingAddresses);
- }
- catch(SendFailedException ex)
- {
- bFailedToSome=true;
- sendex.setNextException(ex);
-
- // Extract the remaining potentially good
addresses
- remainingAddresses=ex.getValidUnsentAddresses();
- }
+ // Avoid a loop if we are stuck
+ nAddresses = remainingAddresses.length;
+
+ try {
+ // Send to the list of remaining addresses, ignoring the
addresses attached to the message
+ Transport.send(message,remainingAddresses);
+ } catch(SendFailedException ex) {
+ bFailedToSome=true;
+ sendex.setNextException(ex);
+
+ // Extract the remaining potentially good addresses
+ remainingAddresses=ex.getValidUnsentAddresses();
+ }
} while (remainingAddresses!=null && remainingAddresses.length>0 &&
remainingAddresses.length!=nAddresses);
if (bFailedToSome) throw sendex;
}
-
+
+
/**
* This method is used to send a Text Message.
- *
+ *
* @param from e-mail address of sender
* @param to e-mail addresses of recipients
* @param subject subject of e-mail
@@ -150,53 +144,53 @@
* @throws MessagingException the exception to indicate failure
*/
public static void sendTextMessage
- (
- Session session,
- String from,
- String[] to,
- String[] cc,
- String[] bcc,
- String subject,
- String content
- )
- throws MessagingException
- {
+ (
+ Session session,
+ String from,
+ String[] to,
+ String[] cc,
+ String[] bcc,
+ String subject,
+ String content
+ )
+ throws MessagingException {
sendMessage(session, from, to, cc, bcc, subject, content, "text/plain;
charset=utf-8");
}
- /**
- * This method overrides the sendTextMessage to specify
- * one receiver and mulitple cc recipients.
- *
- * @param from e-mail address of sender
- * @param to e-mail addresses of recipients
- * @param subject subject of e-mail
- * @param content the body of the e-mail
- * @throws MessagingException the exception to indicate failure
- */
- public static void sendTextMessage
- (
- Session session,
- String from,
- String to,
- String[] cc,
- String[] bcc,
- String subject,
- String content
- )
- throws MessagingException
- {
+
+ /**
+ * This method overrides the sendTextMessage to specify
+ * one receiver and mulitple cc recipients.
+ *
+ * @param from e-mail address of sender
+ * @param to e-mail addresses of recipients
+ * @param subject subject of e-mail
+ * @param content the body of the e-mail
+ * @throws MessagingException the exception to indicate failure
+ */
+ public static void sendTextMessage
+ (
+ Session session,
+ String from,
+ String to,
+ String[] cc,
+ String[] bcc,
+ String subject,
+ String content
+ )
+ throws MessagingException {
String[] recipient = null;
- if (to!=null) recipient = new String[] {to};
-
- sendMessage(session, from, recipient, cc, bcc, subject,
content, "text/plain; charset=utf-8");
- }
-
+ if (to!=null) recipient = new String[] {to};
+
+ sendMessage(session, from, recipient, cc, bcc, subject, content,
"text/plain; charset=utf-8");
+ }
+
+
/**
- * This method overrides the sendTextMessage to specify
- * only one receiver and cc recipients, rather than
- * an array of recipients.
- *
+ * This method overrides the sendTextMessage to specify
+ * only one receiver and cc recipients, rather than
+ * an array of recipients.
+ *
* @param from e-mail address of sender
* @param to e-mail address of recipient
* @param cc e-mail address of cc recipient
@@ -205,31 +199,31 @@
* @throws MessagingException the exception to indicate failure
*/
public static void sendTextMessage
- (
- Session session,
- String from,
- String to,
- String cc,
- String bcc,
- String subject,
- String content
- )
- throws MessagingException
- {
+ (
+ Session session,
+ String from,
+ String to,
+ String cc,
+ String bcc,
+ String subject,
+ String content
+ )
+ throws MessagingException {
String[] recipient = null;
String[] copy = null;
String[] bcopy = null;
-
- if (to!=null) recipient = new String[] {to};
- if (cc!=null) copy = new String[] {cc};
- if (bcc!=null) bcopy = new String[] {bcc};
-
+
+ if (to!=null) recipient = new String[] {to};
+ if (cc!=null) copy = new String[] {cc};
+ if (bcc!=null) bcopy = new String[] {bcc};
+
sendMessage(session, from, recipient, copy, bcopy, subject, content,
"text/plain; charset=utf-8");
}
+
/**
* This method is used to send a HTML Message
- *
+ *
* @param from e-mail address of sender
* @param to e-mail address(es) of recipients
* @param subject subject of e-mail
@@ -237,80 +231,79 @@
* @throws MessagingException the exception to indicate failure
*/
public static void sendHTMLMessage
- (
- Session session,
- String from,
- String[] to,
- String[] cc,
- String[] bcc,
- String subject,
- String content
- )
- throws MessagingException
- {
+ (
+ Session session,
+ String from,
+ String[] to,
+ String[] cc,
+ String[] bcc,
+ String subject,
+ String content
+ )
+ throws MessagingException {
sendMessage(session, from, to, cc, bcc, subject, content, "text/html;
charset=utf-8");
}
+
/**
* This method overrides the sendHTMLMessage to specify
* only one sender, rather than an array of senders.
- *
+ *
* @param from e-mail address of sender
* @param to e-mail address of recipients
* @param subject subject of e-mail
* @param content the body of the e-mail
* @throws MessagingException the exception to indicate failure
*/
- public static void sendHTMLMessage
- (
- Session session,
- String from,
- String to,
- String cc,
- String bcc,
- String subject,
- String content
- )
- throws MessagingException
- {
+ public static void sendHTMLMessage
+ (
+ Session session,
+ String from,
+ String to,
+ String cc,
+ String bcc,
+ String subject,
+ String content
+ )
+ throws MessagingException {
String[] recipient = null;
String[] copy = null;
String[] bcopy = null;
-
- if (to!=null) recipient = new String[] {to};
- if (cc!=null) copy = new String[] {cc};
- if (bcc!=null) bcopy = new String[] {bcc};
-
+
+ if (to!=null) recipient = new String[] {to};
+ if (cc!=null) copy = new String[] {cc};
+ if (bcc!=null) bcopy = new String[] {bcc};
+
sendMessage(session, from, recipient, copy, bcopy, subject, content,
"text/html; charset=utf-8");
}
- /**
- * This method overrides the sendHTMLMessage to specify
- * one receiver and mulitple cc recipients.
- *
- * @param from e-mail address of sender
- * @param to e-mail address of recipient
- * @param cc e-mail addresses of recipients
- * @param subject subject of e-mail
- * @param content the body of the e-mail
- * @throws MessagingException the exception to indicate failure
- */
- public static void sendHTMLMessage
- (
- Session session,
- String from,
- String to,
- String[] cc,
- String[] bcc,
- String subject,
- String content
- )
- throws MessagingException
- {
+
+ /**
+ * This method overrides the sendHTMLMessage to specify
+ * one receiver and mulitple cc recipients.
+ *
+ * @param from e-mail address of sender
+ * @param to e-mail address of recipient
+ * @param cc e-mail addresses of recipients
+ * @param subject subject of e-mail
+ * @param content the body of the e-mail
+ * @throws MessagingException the exception to indicate failure
+ */
+ public static void sendHTMLMessage
+ (
+ Session session,
+ String from,
+ String to,
+ String[] cc,
+ String[] bcc,
+ String subject,
+ String content
+ )
+ throws MessagingException {
String[] recipient = null;
- if (to!=null) recipient = new String[] {to};
-
- sendMessage(session, from, recipient, cc, bcc, subject,
content, "text/html; charset=utf-8");
- }
+ if (to!=null) recipient = new String[] {to};
+
+ sendMessage(session, from, recipient, cc, bcc, subject, content,
"text/html; charset=utf-8");
+ }
+
}
-
