JavaMail快速入门

摘要
  这篇文章介绍创建基于Java的email应用程序入门知识。假如你想创建你自己的email客户端应用程序来代替Microsoft Outlook,或者创建一个基于Web的email系统来跟Hotmail叫板,那么你可以从这里开始。从JavaMail的一个不同角度出发,该文给出了一个谈话email客户端应用程序。

  在JavaMail中,你可以找到API以及其实现部分,从而用它开发功能全面的email客户端应用程序。“email客户端应用程序”引用了Microsoft Outlook的思想;然而,你可以写你自己的Outlook来取而代之。但是,一个email客户端程序不一定要驻留在一个客户端机器上。事实上,它可以是一个在远程服务器上运行的一个servlet或者EJB,终端用户通过Web浏览器可以收发他们的email。在作者自己的宠物项目中,就使用了一个语音客户端来读取接收进来的消息。它是作者在“Talking Java!”中介绍的想法(在后面将有更多的介绍)的提炼。

  现在开始安装和配置Javamail软件。

  安装

  如果你使用的是Java2企业版(J2EE)1.3,那么它已经自带有JavaMail,因此不需要进行额外的安装。但是如果你使用的是Java2标准版(J2SE)1.1.7及以后的版本,那么如果想要你的应用程序具备收发email的能力,下载并安装以下两个应用程序:

  l、JavaMail

  2、JavaBeans Activation Framework

  安装很简单,只需解压下载的文件,并把所包含的jar文件添加到你机器的classpath下,以下是作者机器上的classpath:

;C:/Apps/Java/javamail-1.2/mail.jar;C:/Apps/Java

/javamail-1.2/mailapi.jar;C:/Apps/Java/javamail-1.2

/pop3.jar;C:/Apps/Java/javamail-1.2/smtp.jar;C:/Apps

/Java/jaf-1.0.1/activation.jar

  mailapi.jar文件包含核心API类,而pop3.jar和smtp.jar文件包含各自的email协议实现部分。(在这篇文章中我们不使用imap.jar文件)。可以认为实现部分跟JDBC(Java数据库连接)驱动程序相似,不过它是用于消息系统而不是用于数据库而已。至于mail.jar文件,它包含了上面的每一个jar文件,因此,你可以在你的classpath中只包含mail.jar和activation.jar文件。

  Activation.jar文件允许你通过二进制数据流的形式处理MIME类型的访问。在后面“不仅仅可以发送普通文本”这一部分会讲到DataHandler类,你可以在那找到相关信息。

  至于记录,本文的余下部分没有对API做全面的讲解;不过你可以学着去做一做。如果你想更多的了解API信息,你可以查看每个下载包中的PDF文件以及Javadoc。

  一旦你已经安装了这个软件,那么你需要知道你的email帐户情况以便运行下面的这个例子。你需要知道你的ISP的SMTP服务器名和POP服务器名,你的email帐户登录名以及你的邮箱密码。图1表示的是作者在Microsoft Outlook中使用的详细情况:
(图略)

通过SMTP发送email
  第一个例子告诉你怎样通过SMTP发送一个基本的email消息。在下面,你将找到SimpleSender类,它从命令行读取你的消息,然后调用一个单独的方法send(…)来发送它们:

package com.lotontech.mail;

import javax.mail.*;

import javax.mail.internet.*;

import java.util.*;

/**

* A simple email sender class.

*/

public class SimpleSender

{

 /**

  * Main method to send a message given on the command line.

 */

 public static void main(String args[])

 {

  try

  {

   String smtpServer=args[0];

   String to=args[1];

   String from=args[2];

   String subject=args[3];

   String body=args[4];

   send(smtpServer, to, from, subject, body);

  }

  catch (Exception ex)

  {

   System.out.println("Usage: java com.lotontech.mail.SimpleSender"

       +" smtpServer toAddress fromAddress subjectText bodyText");

  }

  System.exit(0);

 }

下一步,如下所示运行SimpleSender,用你自己的SMTP替换你email设置中的smtp.myISP.net:



  java com.lotontech.mail.SimpleSender smtp.myISP.net bill@lotontech.com ben@lotontech.com "Hello" "Just to say Hello."



  如果它能正常工作起来的话,在接收端你将看到如图2所示的内容




     图2 从SimpleSender读取的消息


  SimpleSender类主要由Send(…)方法完成。其代码如下:



/**

* "send" method to send the message.

*/

public static void send(String smtpServer, String to, String from

, String subject, String body)

 {

  try

  {

   Properties props = System.getProperties();

   // -- Attaching to default Session, or we could start a new one --

   props.put("mail.smtp.host", smtpServer);

   Session session = Session.getDefaultInstance(props, null);

   // -- Create a new message --

   Message msg = new MimeMessage(session);

   // -- Set the FROM and TO fields --

   msg.setFrom(new InternetAddress(from));

   msg.setRecipients(Message.RecipientType.TO,

   InternetAddress.parse(to, false));

   // -- We could include CC recipients too --

   // if (cc != null)

   // msg.setRecipients(Message.RecipientType.CC

   // ,InternetAddress.parse(cc, false));

   // -- Set the subject and body text --

   msg.setSubject(subject);

   msg.setText(body);

   // -- Set some other header information --

   msg.setHeader("X-Mailer", "LOTONtechEmail");

   msg.setSentDate(new Date());

   // -- Send the message --

   Transport.send(msg);

   System.out.println("Message sent OK.");

  }

  catch (Exception ex)

  {

   ex.printStackTrace();

  }

 }

 }


 


  首先,请注意,你得到一个emailsession(java.mail.Session),没有它你什么都做不了。在这个案例中,你调用了Sesion.getDefultInstance(…)来得到一个共享session,其它的桌面应用程序也可以使用它;你也可以通过Session.getInstance(…)方法建立一个新的session,它对于你的应用程序来说是唯一的。然后我们能够证明email客户端应用程序对每个用户来说,其使用方法都是一样的,比如它可以是一个用servlet实现的基于Web的email系统。



  建立一个session需要设置一些属性;如果你通过SMTP发送消息,那么至少需要设置mail.smtp.host属性。在API文档中你可以找到其它的属性。



  现在你有了一个session,创建了一个消息。在这个例子中,你就可以设置email地址信息、主题、正文了,所有这些都取自于命令行。你也可以设置一些头信息,包括日期等,并且你还可以指定复制(CC)的收件人。



  最后,你通过javax.mail.Transport类发送消息。如果你想知道我们的emailsession,请看后面的消息构造器。


不仅仅可以发送普通文本
  javax.mail.Message(继承javax.mail.Part接口)类中的setText(…)方法把消息内容赋给所提供的字符串,把MIME设置为text/plain。



  但是,你不仅仅可以发送普通文本,你还可以通过setDateHandler(…)方法发送其它类型的内容。在大多数情况下,你能通过采用“其它类型内容”来指定文件附件,比如Word文档,但是有趣的是,你检查这里的代码发现它发送一个Java序列化的对象:



ByteArrayOutputStream byteStream=new ByteArrayOutputStream();

ObjectOutputStream objectStream=new ObjectOutputStream(byteStream);

objectStream.writeObject(theObject);

msg.setDataHandler(new DataHandler( new ByteArrayDataSource( byteStream.toByteArray(), "lotontech/javaobject" )));


  在javax.mail.*包结构中你可能找不到DataHandler类,因为它属于JavaBeans Activation Framework (JAF)的javax.activation包。JAF提供处理数据内容类型的机制,这种机制主要是针对Internet内容而言,也即MIME类型。



  假如你已经试验过了以上的代码,通过email来发送一个Java对象,你可能碰到定位ByteArrayDataSource类的问题,因为要么是mail.jar要么是activation.jar未被包含在程序里面。可以到JavaMail demo目录下去查找一下。



  至于你一开始就感兴趣的附件,你可以在DataHandler的构造器中建立一个javax.activation.FileDataSource实例来实现。当然,你不可能单独发送一个文件;它可以作为一个文本消息的附件发送。可能你需要理解多部分消息的概念,现在,我在接收email的环境下为你介绍这个概念。


通过POP3接受email
  在前面,我介绍了由javax.mail.Message实现的javax.mail.Part接口。我现在将解释它的消息部分,它在这个例子中很重要。我们先看图3。




            图3 mail.Part接口的UML图


  图3表示在前面例子中建立的一个Message,它既可以是一个消息,也可以是一个消息部分,因为它实现了Part接口。对于任何部分,你都能得到它的内容(任何Java对象),并且在发送的是一个简单文本消息的情况下,内容对象可能是一个String。对于多部分消息,内容可能是类型Multipart,由此我们可以得到单独的正文部分,它本身就实现了Part接口



  实际上,当你看过SimpleReceiver类的代码之后,你会发现一切都变得很明朗。我们用三部分内容来介绍SimpleReceiver类:第一部分,类的定义以及从命令行获取连接细节信息的main()方法;第二部分,捕获和查看进来消息的receive()方法;第三部分,打印头信息和每个消息内容的printMessage()方法。



  下面是第一部分:



package com.lotontech.mail;

import javax.mail.*;

import javax.mail.internet.*;

import java.util.*;

import java.io.*;

/**

* A simple email receiver class.

*/

public class SimpleReceiver

{

 /**

 * Main method to receive messages from the mail server specified

 * as command line arguments.

 */

 public static void main(String args[])

 {

  try

  {

   String popServer=args[0];

   String popUser=args[1];

   String popPassword=args[2];

   receive(popServer, popUser, popPassword);

  }

  catch (Exception ex)

  {

   System.out.println("Usage: java com.lotontech.mail.SimpleReceiver"

       +" popServer popUser popPassword");

  }

  System.exit(0);

}


  现在我们使用命令行来运行它(记住用你的email设置替换命令行参数):



 java com.lotontech.mail.SimpleReceiver pop.myIsp.net myUserName myPassword

receive()方法从main()方法中调用,它依次打开你的POP3信箱检查消息,每次都调用printMessage()。代码如下:



/**


* "receive" method to fetch messages and process them.


*/


public static void receive(String popServer, String popUser


, String popPassword)


{


 Store store=null;


 Folder folder=null;


 try


 {


  // -- Get hold of the default session --


  Properties props = System.getProperties();


  Session session = Session.getDefaultInstance(props, null);


  // -- Get hold of a POP3 message store, and connect to it --


  store = session.getStore("pop3");


  store.connect(popServer, popUser, popPassword);


  // -- Try to get hold of the default folder --


  folder = store.getDefaultFolder();


  if (folder == null) throw new Exception("No default folder");


   // -- ...and its INBOX --


   folder = folder.getFolder("INBOX");


   if (folder == null) throw new Exception("No POP3 INBOX");


    // -- Open the folder for read only --


    folder.open(Folder.READ_ONLY);


    // -- Get the message wrappers and process them --


    Message[] msgs = folder.getMessages();


    for (int msgNum = 0; msgNum < msgs.length; msgNum++)


    {


     printMessage(msgs[msgNum]);


    }


  }


  catch (Exception ex)


  {


   ex.printStackTrace();


  }


  finally


  {


   // -- Close down nicely --


   try


   {


    if (folder!=null) folder.close(false);


    if (store!=null) store.close();


   }


  catch (Exception ex2) {ex2.printStackTrace();}


 }


}

  请注意:你从session中得到一个POP3消息存储封装器,然后使用最初在命令行上键入的mail设置跟它连接。

  一旦连接成功,你就得到了一个默认文件夹的句柄,在这里使用的是INBOX文件夹,它保存了进来的消息。你可以打开这个只读的INBOX信箱,然后一个一个的读取消息。

  另外,你可能想知道是否你能够以写的方式打开这个INBOX信箱。如果你想为这些消息做标记或者从服务器上删除,你可以做得到。不过在我们的这个例子中,你只能查看消息。

  最后,在上面的代码中,你做到了当查看完毕后关闭文件夹以及消息存储,然后留下printMessage()方法来完成这个类的剩余部分

打印消息
  在这一部分,很有必要讨论前面提到的javax.mail.Part接口。

  下面的代码让你明白怎样隐含地把消息转换为它的Part接口并且把它赋给messagePart变量。对于只有一部分的消息,你现在需要打印一些信息。

  假如调用messagePart.getContent()来生成一个Multipart实例,你知道你正在处理一个多部分消息;在这种情况下,你正在通过getBodyPart(0)来得到第一个多部分消息并且打印它。

  当然你还要知道是否你已经得到了这个消息本身,还是仅仅是消息正文的第一部份。只有当内容是普通文本或者HTML时,你才可以打印该消息,这是通过一个InputStream来完成的。

/**

* "printMessage()" method to print a message.

*/

public static void printMessage(Message message)

{

 try

 {

  // Get the header information

  String from=((InternetAddress)message.getFrom()[0]).getPersonal();

  if (from==null) from=((InternetAddress)message.getFrom()[0])

   .getAddress();

   System.out.println("FROM: "+from);

   String subject=message.getSubject();

   System.out.println("SUBJECT: "+subject);

   // -- Get the message part (i.e. the message itself) --

   Part messagePart=message;

   Object content=messagePart.getContent();

   // -- or its first body part if it is a multipart message --

   if (content instanceof Multipart)

   {

    messagePart=((Multipart)content).getBodyPart(0);

    System.out.println("[ Multipart Message ]");

   }

   // -- Get the content type --

   String contentType=messagePart.getContentType();

   // -- If the content is plain text, we can print it --

   System.out.println("CONTENT:"+contentType);

   if (contentType.startsWith("text/plain")|| contentType.startsWith("text/html"))

   {

    InputStream is = messagePart.getInputStream();

    BufferedReader reader=new BufferedReader(new InputStreamReader(is));

               String thisLine=reader.readLine();

    while (thisLine!=null)

    {

     System.out.println(thisLine);

     thisLine=reader.readLine();

    }

   }

   System.out.println("-----------------------------");

  }

  catch (Exception ex)

  {

   ex.printStackTrace();

  }

 }

}


  为了简单起见,我假设消息本身或者消息正文的第一部份是可以打印的。对于真正的应用软件,可能你想要依次检查消息正文的每一部分,并且对每一部分采取相应的行动-打印或者是保存到磁盘,这取决于内容的类型。



  当你从消息存储中得到每个消息时,你实际上已经得到了一个轻量级的封装器。数据内容的获取是每申请一次就读取一次-这对于你只想下载消息头时很有用。


SimpleReceiver测试
  让我们对SimpleReceiver做一次测试。为了让它有东西可以接收,我发送图4所示的消息(注意:消息由文本和一个附件组成)




    图4 用于SimpleReceiver的测试消息


  一旦接收到消息,就把该消息认为是一个多部分消息。打印的文本如下:



FROM: Tony Loton

SUBJECT: Number 1

[ Multipart Message ]

CONTENT:text/plain;

charset="iso-8859-1"

Attachment 1

from Tony Loton.

-----------------------------


  

把你的消息送出去



  为了有趣一点,并且说明JavaMail APIs的一个新颖的用法,我现在简要介绍一下我的谈话email项目。在做这个试验之前你需要得到lotontalk.jar文件,并把它加到你的classpath中去,添加方法如下:



  set CLASSPATH=%CLASSPATH%;lotontalk.jar


  你也需要在SimpleReceiver类中两个地方做代码修改。首先在receive()方法里面,把以下代码:



// -- Get the message wrappers and process them --

Message[] msgs = folder.getMessages();

for (int msgNum = 0; msgNum < msgs.length; msgNum++)

{
  printMessage(msgs[msgNum]);

}


  替换为:



// -- Get the message wrappers and process them --

Message[] msgs = folder.getMessages();

for (int msgNum = 0; msgNum < msgs.length; msgNum++)

{

 printMessage(msgs[msgNum]);

 speakMessage(msgs[msgNum]);

}


  现在增加以下的新方法speakMessage(),它与最初的printMessage()方法相似。



/**


* "speakMessage", a talking version of printMessage().


*/


public static void speakMessage(Message message)


{


 String speech="";


 try


 {


  com.lotontech.talk.LOTONtalk speaker=new com.lotontech.talk.LOTONtalk();


  String from=((InternetAddress)message.getFrom()[0]).getPersonal();


  if (from==null) from=((InternetAddress)message.getFrom()[0]).getAddress();


   speech=speech+"from "+from+", ";


   String subject=message.getSubject();


   speech=speech+"subject "+subject+", ";


   // -- Get the message part (i.e., the message itself) --


   Part messagePart=message;


   Object content=messagePart.getContent();


   // -- ...or its first body part if it is a multipart message --


   if (content instanceof Multipart)


    messagePart=((Multipart)content).getBodyPart(0);


    String contentType=messagePart.getContentType();


    if (contentType.startsWith("text/plain")|| contentType.startsWith("text/html"))


    {


     InputStream is = messagePart.getInputStream();


     BufferedReader reader=new BufferedReader(new InputStreamReader(is));


     String thisLine=reader.readLine();


     while (thisLine!=null)


     {


      speech=speech+thisLine+". ";


      thisLine=reader.readLine();


     }


    // -- SPEAK --


    speaker.speak(speech,true);


   }


  }


  catch (Exception ex)


  {


   ex.printStackTrace();


  }


 }


  因为在说话之前,你正在把整个消息积累到一个字符串中,所以这个方案可能只适合小的消息。作为一种选择,你可以读一行然后再讲一行。



  当然,我不可能把结果显示给你看,因此你必须亲自来做实验。



  你还可以做一些小的试验,当然不是在这个试验中,来发现语音合成的一些有趣的特征:怎样处理数字,以及怎样把全部大些的单词假想成只取首字母的缩写词,然后一个一个字母地把它们拼出来。



  

结论



  我们已经通过对发送和接收email消息的应用程序的各个基本构造块分别讲解,涉及到了收发email的方方面面。如果你是第一次接触JavaMail,是不是发现在应用程序中收发email不是一件困难的事情。