receivedheaderparser.java

来自「spam source codejasen-0.9jASEN - java An」· Java 代码 · 共 75 行

/*
 * @(#)ReceivedHeaderParser.java	 7/09/2004
 *
 * Copyright (c) 2004, 2005  jASEN.org
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in
 *      the documentation and/or other materials provided with the distribution.
 *
 *   3. The names of the authors may not be used to endorse or promote products
 *      derived from this software without specific prior written permission.
 *
 *   4. Any modification or additions to the software must be contributed back
 *      to the project.
 *
 *   5. Any investigation or reverse engineering of source code or binary to
 *      enable emails to bypass the filters, and hence inflict spam and or viruses
 *      onto users who use or do not use jASEN could subject the perpetrator to
 *      criminal and or civil liability.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JASEN.ORG,
 * OR ANY CONTRIBUTORS TO THIS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
package org.jasen.interfaces;

import org.jasen.error.JasenParseException;


/**
 * <P>
 * 	The ReceivedHeaderParser interface represents a class which can parse a "received" header of an email message.
 * </P>
 * @author Jason Polites
 */
public interface ReceivedHeaderParser {
	
	/**
	 * Parses a single received header line.
	 * <p>
	 * We expect the Received header to be in the form:
	 * </p>
	 * <pre>
	 * received    =  "Received"    ":"          ; one per relay
     *                 ["from" domain]           ; sending host
     *                 ["by"   domain]           ; receiving host
     *                 ["via"  atom]             ; physical path
     *                *("with" atom)             ; link/mail protocol
     *                 ["id"   msg-id]           ; receiver msg id
     *                 ["for"  addr-spec]        ; initial form
	 * </pre>
	 * @param header
	 * @return ReceivedHeaderParserData containing the results of the parse
	 * @throws JasenParseException only if a parse failed due to an unexpected error. Or a parse could not complete due to 
	 * a malformed header line
	 */
	public ReceivedHeaderParserData parse(String header, InetAddressResolver resolver) throws JasenParseException;	

}