svn commit: r689911 - /james/jsieve/trunk/src/main/java/org/apache/jsieve/mail/MailAdapter.java

[rdonkin]

Author: rdonkin
Date: Thu Aug 28 10:44:50 2008
New Revision: 689911

URL: http://svn.apache.org/viewvc?rev=689911&view=rev
Log:
Added code snippet for parseAddresses implementation

Modified:
    james/jsieve/trunk/src/main/java/org/apache/jsieve/mail/MailAdapter.java

Modified: 
james/jsieve/trunk/src/main/java/org/apache/jsieve/mail/MailAdapter.java
URL: 
http://svn.apache.org/viewvc/james/jsieve/trunk/src/main/java/org/apache/jsieve/mail/MailAdapter.java?rev=689911&r1=689910&r2=689911&view=diff
==============================================================================
--- james/jsieve/trunk/src/main/java/org/apache/jsieve/mail/MailAdapter.java 
(original)
+++ james/jsieve/trunk/src/main/java/org/apache/jsieve/mail/MailAdapter.java 
Thu Aug 28 10:44:50 2008
@@ -39,6 +39,36 @@
  * minimum level of functionality to provide support for Command and Test
  * extensions that exploit the capabilities of a particular application.
  * </p>
+ * 
+ * <h4>Implementing parseAddresses</h4>
+ * <p>
+ * <a href='http://james.apache.org/mime4j'>Apache Mime4J</a> is a parser
+ * for <abbr title='Multipurpose Internet Mail Extensions'>
+ * <a href='http://www.faqs.org/rfcs/rfc2045.html'>MIME</a></abbr>. 
+ * It can easily be used to parse an address string into addresses. 
+ * For example:
+ * </p>
+ * <code><pre>
+ *     import org.apache.james.mime4j.field.address.AddressList;
+ *     import org.apache.james.mime4j.field.address.Mailbox;
+ *     import org.apache.james.mime4j.field.address.MailboxList;
+ *     import org.apache.james.mime4j.field.address.parser.ParseException;
+ *     ...
+ *     public Address[] parseAddresses(String arg) throws SieveMailException, 
InternetAddressException {
+ *         try {
+ *             final MailboxList list = AddressList.parse(arg).flatten();
+ *             final int size = list.size();
+ *             final Address[] results = new Address[size];
+ *             for (int i=0;i&lt;size;i++) {
+ *                 final Mailbox mailbox = list.get(i);
+ *                 results[i] = new AddressImpl(mailbox.getLocalPart(), 
mailbox.getDomain());
+ *             }
+ *             return null;
+ *         } catch (ParseException e) {
+ *             throw new InternetAddressException(e);
+ *         }
+ *     }
+ * </pre></code>
  */
 public interface MailAdapter {
     /**



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]