Open Source Repository

Home /jodd/jodd-3.3.2 | Repository Home



jodd/mail/Pop3Server.java
// Copyright (c) 2003-2012, Jodd Team (jodd.org). All Rights Reserved.

package jodd.mail;

import javax.mail.Authenticator;
import javax.mail.NoSuchProviderException;
import javax.mail.Session;
import javax.mail.Store;
import java.util.Properties;

import static jodd.util.StringPool.TRUE;

/**
 * Represents simple plain POP server for sending emails.
 */
public class Pop3Server implements ReceiveMailSessionProvider {

  protected static final String MAIL_POP3_PORT = "mail.pop3.port";
  protected static final String MAIL_POP3_HOST = "mail.pop3.host";
  protected static final String MAIL_POP3_AUTH = "mail.pop3.auth";

  protected static final String PROTOCOL_POP3 = "pop3";

  protected static final int DEFAULT_POP3_PORT = 110;

  protected final String host;
  protected final int port;
  protected final Authenticator authenticator;
  protected final Properties sessionProperties;

  /**
   * POP3 server defined with its host and default port.
   */
  public Pop3Server(String host) {
    this(host, DEFAULT_POP3_PORT, null);
  }
  /**
   * POP3 server defined with its host and port.
   */
  public Pop3Server(String host, int port) {
    this(host, port, null);
  }

  public Pop3Server(String host, Authenticator authenticator) {
    this(host, DEFAULT_POP3_PORT, authenticator);
  }

  public Pop3Server(String host, int port, String username, String password) {
    this(host, port, new SimpleAuthenticator(username, password));
  }

  /**
   * SMTP server defined with its host and authentication.
   */
  public Pop3Server(String host, int port, Authenticator authenticator) {
    this.host = host;
    this.port = port;
    this.authenticator = authenticator;
    sessionProperties = createSessionProperties();
  }

  /**
   * Prepares mail session properties.
   */
  protected Properties createSessionProperties() {
    Properties props = new Properties();
    props.setProperty(MAIL_POP3_HOST, host);
    props.setProperty(MAIL_POP3_PORT, String.valueOf(port));
    if (authenticator != null) {
      props.setProperty(MAIL_POP3_AUTH, TRUE);
    }
    return props;
  }


  /**
   * {@inheritDoc}
   */
  public ReceiveMailSession createSession() {
    Session session = Session.getInstance(sessionProperties, authenticator);
    Store store;
    try {
      store = getStore(session);
    catch (NoSuchProviderException nspex) {
      throw new MailException("Unable to create POP3 session", nspex);
    }
    return new ReceiveMailSession(session, store);
  }

  /**
   * Returns email store.
   */
  protected Store getStore(Session sessionthrows NoSuchProviderException {
    return session.getStore(PROTOCOL_POP3);
  }

  // ---------------------------------------------------------------- getters

  /**
   * Returns POP host address.
   */
  public String getHost() {
    return host;
  }

  /**
   * Returns authenticator.
   */
  public Authenticator getAuthenticator() {
    return authenticator;
  }

  /**
   * Returns current port.
   */
  public int getPort() {
    return port;
  }
}