org.unitils.mail.impl.SmtpServerImpl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of unitils-mail Show documentation

Will start a fake (spy) SMTP server for you tests. It makes it easy to verify the mails your application has sent

The newest version!

/*
 * Copyright 2012,  Unitils.org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.unitils.mail.impl;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import javax.mail.MessagingException;

import org.subethamail.wiser.Wiser;
import org.subethamail.wiser.WiserMessage;
import org.unitils.mail.SmtpMessage;
import org.unitils.mail.SmtpServer;

/**
 * Wrapper class for the SimpleSmtpServer of Wiser.
 *
 * @author Jeroen Horemans
 * @author Thomas De Rycke
 * @author Willemijn Wouters
 *
 */
public class SmtpServerImpl implements SmtpServer {

    private Wiser wiser;

    private int port;


    /**
     * @param port : the port where the server should be started on.
     */
    public SmtpServerImpl(int port) {
        this.port = port;
        wiser = new Wiser();
        wiser.setPort(port);
        wiser.start();
        wiser.getServer().isRunning();
    }

    /**
     * It returns all the mails that were received on the fake SMTP server.
     *
     * @return {@link List}
     * @throws MessagingException
     * @throws IOException
     */
    @Override
    public List getReceivedEmail() throws IOException, MessagingException {

        List messages = new ArrayList();
        for (WiserMessage wiserMessage : wiser.getMessages()) {
            SmtpMessage smtpmessage = new SmtpMessageImpl(wiserMessage);
            messages.add(smtpmessage);
        }
        return messages;
    }

    @Override
    public int getReceivedEmailSize() {
        return wiser.getMessages().size();

    }

    /**
     * This method stops the server.
     */
    @Override
    public void stop() {
        wiser.stop();
    }

    /**
     * Check if the server is running or not.
     *
     * @return {@link Boolean}
     *
     * @see org.unitils.mail.SmtpServer#isRunning()
     */
    @Override
    public Boolean isRunning() {
        return wiser.getServer().isRunning();

    }

    /**
     * @see org.unitils.mail.SmtpServer#clean()
     */
    @Override
    public void clean() {
        wiser.stop();
        wiser = new Wiser();
        wiser.setPort(port);
        wiser.start();

    }

}