Quadcap Embeddable Server

com/quadcap/pop3/client/HookShell.java

Go to the documentation of this file.

package com.quadcap.pop3.client;

/*
 * Copyright 1997 - 2003 by Stan Bailes and Quadcap Software.
 *
 **/

import java.io.IOException;
import java.io.InputStream;

import java.util.Map;
import java.util.Properties;

/**
 * Interface for message delivery.
 *
 * @author Stan Bailes
 */
public class HookShell implements MessageHook {
    /**
     * Initialize the hook with its property set
     */
    public void init(Properties p) {
    }

    /**
     * Return <code>true</code> if the call to
     * <code>boolean passHeaders(Map headers)</code> will always return
     * true, so the message receiver can avoid calling it.
     */
    public boolean passAllHeaders() { return false; }

    /**
     * A hook first gets called with the parsed headers from the message.
     * If the hook returns 'true' to this call, it will be called again
     * to process the body using <code>sendMessage()</code>, below.
     */
    public boolean passHeaders(Map headers) {
        return "shell".equals(headers.get("X-MessageHook"));
    }

    /**
     * The hook is called to process the entire message (including headers)
     * as an octet stream.
     *
     * @return <code>false</code> if the message is to be retained in
     * the store, <code>true</code> to delete it.
     */
    public boolean passMessage(InputStream is) throws IOException {
        return false;
    }
}