Прием почты при помощи JavaMail(tm) API

Содержание

1 Введение
2 Работа с папками
3 Чтение сообщений и завершение сессии
4 Листинг программы
5 Ссылки и дополнительная информация

Введение

JavaMail API предоставляет оболочку для передачи и приема электронных сообщений (email). Статья "Передача почты при помощи JavaMail API" (http://java.sun.com/jdc/JDCTechTips/2001/tt1023.html#tip2) продемонстрировала вам, как передать почту через SMTP при помощи JavaMail API. В этой статье вы увидите, как принимать сообщения с вашего сервера POP/IMAP.

Во многих отношениях прием сообщений аналогичен передаче. Например, передача почты включает в себя использование классов Session, Message, Address и Transport. Прием сообщений включает в себя такие же классы Session и Message, но также используются классы Folder и Store. Как только вы создали соединение с почтовым сервером для приема сообщений, сообщения сохраняются в Folder класса Store.

Для приема почты прежде всего нужно получить соединение с почтовым сервером, так же как и для передачи почты. Но почтовые серверы различны. Когда вы передаете почту, вы соединяетесь с сервером, поддерживающим протокол SMTP (Simple Mail Transfer Protocol). Это протокол, предназначенный исключительно для передачи электронной почты. Когда вы принимаете почту, вы соединяетесь с сервером, поддерживающим протокол POP3 (Post Office Protocol, Version 3) или протокол IMAP4 (Internet Message Access Protocol, Version 4). Эти протоколы разработаны для приема электронной почты. POP является простым протоколом. Он позволяет пользователям получать почту, но не имеет более изощренных функций, таких как идентификация "новой" почты. Для сравнения IMAP является более функциональным протоколом.

Вы можете получить почтовую сессию при помощи либо метода getDefaultInstance(), либо метода getInstance() объекта Session. Вызов метода getDefaultInstance() возвращает экземпляр общей сессии. Это означает, что одна и та же сессия возвращается (и таким образом является общей) при каждом вызове метода. Метод getInstance() возвращает экземпляр новой сессии каждый раз, когда вы вызываете его. Новые сессии полезны в случаях, когда вы не хотите, чтобы другие потоки работали одновременно с общей сессией.

После получения сессии необходимо передать экземпляр Properties. Он содержит установки свойств, таких как используемый для соединения почтовый сервер. Вы должны установить значение "mail.pop3.host" (или "mail.imap.host") в почтовом сервере для соединения (например, pop.example.com):

// Свойства установки
Properties props = System.getProperties();
props.put("mail.pop3.host", host);

При передаче почты необходимо аутентифицировать соединение, например, запросить имя пользователя и пароль. Вы можете сделать это, расширив класс JavaMail Authenticator. Например, следующий класс PopupAuthenticator использует Swing JOptionPane для запроса имени пользователя и пароля. В данном примере пользователь должен ввести имя пользователя и пароль в виде разделенного запятой списка. Обратите внимание, что метод getPasswordAuthentication() возвращает имя пользователя и пароль. (Вы можете сами улучшить эту процедуру, использовав вместо него JPasswordField для пароля.)

import javax.mail.*;
import javax.swing.*;
import java.util.*;

public class PopupAuthenticator extends Authenticator {

  public PasswordAuthentication getPasswordAuthentication() {
    String username, password;

    String result = JOptionPane
        .showInputDialog("Enter 'username,password'");

    StringTokenizer st = new StringTokenizer(result, ",");
    username = st.nextToken();
    password = st.nextToken();

    return new PasswordAuthentication(username, password);
  }
}

После получения Properties и Authenticator можно получить Session:

// Настроить аутентификацию, получить session
Authenticator auth = new PopupAuthenticator();
Session session = Session.getDefaultInstance(props, auth);

Затем установите соединение с Store при помощи метода getStore(), передав ему соответствующий почтовый протокол вашего сервера - либо "pop3", либо "imap". Вот пример установки соединения с POP3-сервером:

// Получить store
Store store = session.getStore("pop3");
store.connect();

Вызов метода Store connect() инициирует обращение к PopupAuthenticator. Как упоминалось ранее, PopupAuthenticator запрашивает правильную комбинацию имени пользователя и пароля. Если вы ответите правильным идентификатором и паролем для учетной записи почты, соединение с почтовым сервером установится, и вы сможете затем прочитать вашу почту.

Работа с папками

Вся почта сохраняется в папках, то есть, экземплярах класса Folder. Следовательно, для чтения почты, прежде всего, нужно установить соединение с соответствующим экземпляром Folder. В протоколе POP существует только одна папка INBOX. В протоколе IMAP экземпляром Folder может быть INBOX или любая другая созданная вами папка. Предположим, что вы хотите прочитать почту из вашей папки INBOX. Просто получите соединение с папкой при помощи метода Session getFolder():

// Получить folder
Folder folder = store.getFolder("INBOX");

Затем вам необходимо открыть Folder при помощи метода open(). Это можно сделать либо используя режим Folder.READ_WRITE, либо режим Folder.READ_ONLY. Для чтения сообщений можно использовать режим только для чтения, хотя если вы хотите удалить сообщения, нужно использовать режим READ_WRITE.

folder.open(Folder.READ_ONLY);

Соединение с Folder дает вам доступ к индивидуальным объектам Message. Вы можете использовать метод getMessage() для получения конкретного сообщения, или, как в следующем примере, используйте метод getMessages() для получения всех сообщений:

// Получить каталог
Message message[] = folder.getMessages();

Класс Folder определяет также метод getNewMessageCount() для подсчета количества новых сообщений в папке. Однако вы не должны использовать его с протоколом POP - вспомните, что POP не поддерживает концепцию "новых" сообщений.

Чтение сообщений и завершение сессии

Вы имеете несколько вариантов решения, что именно извлечь из каждого сообщения. Например, вы можете вызвать getFrom() или getSubject() для извлечения соответственно информации об отправителе, или о теме сообщения.

// Отобразить поля from (только первый отправитель) и subject сообщений
for (int i=0, n=message.length; i<n; i++) {
  System.out.println(i + ": "
    + message[i].getFrom()[0]
    + "\t" + message[i].getSubject());
}

Хотя наверняка вас больше интересует содержимое сообщения. Обычно используется метод getContent() для просмотра содержимого сообщения:

System.out.println(message[i].getContent());

Для получения содержимого сообщения можно также использовать метод writeTo(). При этом вы можете сохранить все содержимое сообщения полностью (включая заголовки) в выходной поток.

После чтения почты закройте Folder и Store. В случае Folder метод close() требует от вас указания, хотите ли вы стереть все удаленные сообщения. Store не требует аргументов для своего метода close():

// Закрыть соединение
folder.close(false);
store.close();

Далее приведена полная программа Fetch, демонстрирующая концепции, описанные выше. Для того чтобы запустить программу, необходимо иметь установленный JavaMail API, а также JavaBeans(tm) Activation Framework. Информация о том, где найти эти загрузочные пакеты смотрите в части "Ссылки и дополнительная информация".

Листинг программы

Программа Fetch отображает первые 200 символов всех сообщений, находящихся в настоящее время в вашей папке INBOX. Если ваш сервер поддерживает IMAP а не POP, измените в коде ссылку "pop3" на "imap". Перед компиляцией программы не забудьте сначала откомпилировать приведенный ранее класс PopupAuthenticator.

Запустите программу Fetch из командной строки следующим образом:

java Fetch mailserver

Замените "mailserver" именем вашего почтового сервера.

В ответ программа запросит идентификатор пользователя и пароль.

import java.io.*;
import java.util.Properties;
import javax.mail.*;
import javax.mail.internet.*;

public class Fetch {
  public static void main(String args[]) throws Exception {
    String host = args[0];

    // Получить системные свойства
    Properties props = System.getProperties();
    props.put("mail.pop3.host", host);

    // Настроить аутентификацию, получить session
    Authenticator auth = new PopupAuthenticator();
    Session session = Session.getDefaultInstance(props, auth);

    // Получить store
    Store store = session.getStore("pop3");
    store.connect();

    // Получить folder
    Folder folder = store.getFolder("INBOX");
    folder.open(Folder.READ_ONLY);

    // Получить каталог
    Message message[] = folder.getMessages();
    for (int i = 0, n = message.length; i < n; i++) {

      System.out.println(i + ": " + message[i].getFrom()[0] + "\t"
          + message[i].getSubject());
      String content = message[i].getContent().toString();
      if (content.length() > 200) {
        content = content.substring(0, 200);
      }
      System.out.print(content);
    }

    // Закрыть соединение
    folder.close(false);
    store.close();
    System.exit(0);
  }
}

Далее следует вариация предыдущего подхода. Если вы не хотите использовать Authenticator, получите Session без установки каких-либо свойств. Затем предоставьте имя хоста, имя пользователя и пароль в метод connect(). Следующий фрагмент демонстрирует этот подход:

// Установить системные свойства
Properties props = new Properties();

// Получить session
Session session = Session.getDefaultInstance(props, null);

// Получить store
Store store = session.getStore("pop3");
store.connect(host, username, password)

Если вы используете для обмена почтой Yahoo, вы должны разрешить функцию "POP Access & Forwarding" на его экране "Options" для получения почты при помощи JavaMail API. Вы не можете использовать Hotmail - он не поддерживает удаленный доступ.

Ссылки и дополнительная информация

Последняя версия JavaMail API доступна для загрузки со страницы JavaMail API (http://java.sun.com/products/javamail/). Для использования JavaMail API, вы должны также иметь установленный JavaBeans Activation Framework. JavaBeans Activation Framework доступен для загрузки со страницы JavaBeans Activation Framework (http://java.sun.com/products/javabeans/glasgow/jaf.html). Вы можете также получить JavaMail API и JavaBeans Activation Framework как часть загрузочного пакета Java 2 Platform, Enterprise Edition 1.3 на http://java.sun.com/j2ee/download.html. Исходный код классов JavaMail доступен по программе J2EE 1.3 Sun Community Source Licensing (SCSL) на http://www.sun.com/software/communitysource/j2ee/.

Обратите внимание, что пример Fetch не работает с присоединенным содержимым сообщения. Информация по извлечению вложений приведена в учебнике "Основы JavaMail API" на странице http://java.sun.com/jdc/onlineTraining/JavaMail/.

Теги: API mail API