4 Mailet快速入门
Mailet API是一个用来创建邮件处理程序的简单的API,它被配置在邮件服务器端执行,分匹配器Matcher和Mailet的接口两种,匹配器根据特定的条件匹配邮件消息,并触发相应的Mailet.
Mailet这个词是跟Servlet相似,功能也相似,他们的共同之处都是在服务器端触发并执行,只是Servlet的Matcher通常是url的pattern,跟Servlet的接口一样,Mailet也有init()方法,service()方法和destroy()方法.即他们都有类似的生命周期. Mailet的简单可编程接口可以用来做一些邮件处理,比如反垃圾邮件,检查邮件病毒以及邮件博客等等,利用移动设备可发送email的功能,可以做到手机通过mail发送信息到邮件服务器交给Mailet处理,形成移动博客的模型.
Mailet的运行需要mailet-2.3.jar和mailet-api-2.3.jar两个包的支持,James本身就有这两个包,可不作修改,但在开发的时候还是需要开发者自己将这两个包导入到工程的Build path中或配置到系统环境变量中。
4.1 用Mailet做一个Hello的例子
4.1.1 业务描述
我们要实现当外部发送给James服务器中名字含hello的邮箱时,服务器在这封邮件的主题前加入“Hello”,并在服务器后台输出“Received a piece of Email”。如前所述,Mailet包括匹配器Matcher和Mailet两种接口,现在就让我们用Mailet API实现这两个接口吧。
4.1.2 编码实现
匹配器BizMatcher.java
- package com.newland.james.mailet.sample1;
- import org.apache.mailet.GenericRecipientMatcher;
- import org.apache.mailet.MailAddress;
- /**
- * Mailet匹配器
- * @author Chen.Feng(Kevin)<br>
- * mail:chenfengcn@yeah.net<br>
- * qq:67758633
- *
- */
- public class BizMatcher extends GenericRecipientMatcher {
- public boolean matchRecipient(MailAddress recipient) {
- // 邮件地址必须包含hello的
- if (recipient.getUser().indexOf("hello") != -1) {
- return true;
- }
- return false;
- }
- }
BizMaillet.java
- package com.newland.james.mailet.sample1;
- import java.io.IOException;
- import javax.mail.MessagingException;
- import javax.mail.internet.MimeMessage;
- import org.apache.mailet.GenericMailet;
- import org.apache.mailet.Mail;
- /**
- * Mailet处理程序
- * @author Chen.Feng(Kevin)<br>
- * mail:chenfengcn@yeah.net<br>
- * qq:67758633
- *
- */
- public class BizMaillet extends GenericMailet {
- public void init() throws MessagingException {
- }
- public void service(Mail mail) throws MessagingException {
- MimeMessage mmp;
- mmp = (MimeMessage) mail.getMessage();
- mmp.setSubject("Hello "+mmp.getSubject());
- System.out.println("Received a piece of Email");
- }
- }
4.1.3 配置部署
Mailet跟Servlet一样,是服务器端程序,是不能直接在客户端运行的,必须要部署到服务器端方可生效。部署具体步骤如下:
1、 将我们编写的Matcher和Mailet打包成jar文件;
2、 在/james-2.3.1/apps/james/SAR-INF目录下新建一个lib文件夹;
3、 将打包好的jar文件复制到刚刚新建的lib文件夹下;
4、 打开config.xml配置文件,找到以下这段代码:
- <mailetpackages>
- <mailetpackage>org.apache.james.transport.mailets</mailetpackage>
- <mailetpackage>org.apache.james.transport.mailets.smime</mailetpackage></mailetpackages>
- <matcherpackages>
- <matcherpackage>org.apache.james.transport.matchers</matcherpackage>
- <matcherpackage>org.apache.james.transport.matchers.smime</matcherpackage></matcherpackages>
前半部分是用于配置Mailet包所在位置,后半部分是用于配置Matcher包所在位置,我们把我们刚编写的Mailet和Matcher所在位置配置进去就可以了。配置后的结果如下:
- <mailetpackages>
- <mailetpackage>com.newland.james.mailet.sample1</mailetpackage>
- <mailetpackage>org.apache.james.transport.mailets</mailetpackage>
- <mailetpackage>org.apache.james.transport.mailets.smime</mailetpackage>
- </mailetpackages>
- <matcherpackages>
- <matcherpackage>com.newland.james.mailet.sample1</matcherpackage>
- <matcherpackage>org.apache.james.transport.matchers</matcherpackage>
- <matcherpackage>org.apache.james.transport.matchers.smime</matcherpackage>
- </matcherpackages>
这样就完成了包的配置。我们都知道,Mailet的工作过程是:首先由Matcher来匹配所接收到的邮件,然后提交给相应的Mailet处理,但是哪个匹配器对应哪个Mailet呢?我们还需要配置Mailet的对应关系。同样在config.xml中找到下面的代码:
- <mailet match="All" class="PostmasterAlias"/>
在这段代码下面加入我们自己的Mailet:
- <mailet match="All" class="PostmasterAlias"/>
- <mailet match="BizMatcher" class="BizMaillet"/>
这样就完成了我们自定义的Mailet的配置部署工作了。重启James服务器,则此Mailet即可生效。
4.1.4 测试Mailet
前面我们已经完成了Mailet的编码和部署工作,现在就让我们来测试一下我们的Mailet是否生效吧。首先,需要在James服务器上新建一个名称含Hello的用户。前面已介绍过新建用户的方法了,在此就不重复叙述了。
使用adduser helloworld 881213命令新建一个helloworld用户。
使用第三章所谈及的“使用Javamail向James的邮箱帐户发送邮件”来向helloworld@localhost发送一封邮件(当然,你同样可以使用Foxmail或Outlook向此地址发送邮件),邮件发送成功后,James服务器后台将输出“Receive a piece of email”。运行效果如下图所示:
这就说明我们的Mailet已经部署成功了.