Quadcap Embeddable Server

com.quadcap.pop3.client.HookShell Class Reference

Inheritance diagram for com.quadcap.pop3.client.HookShell:

List of all members.

---

Detailed Description

Interface for message delivery.

Author:

Stan Bailes

Definition at line 19 of file HookShell.java.

Public Member Functions
void	init (Properties p)
	Initialize the hook with its property set.
boolean	passAllHeaders ()
	Return true if the call to boolean passHeaders(Map headers) will always return true, so the message receiver can avoid calling it.
boolean	passHeaders (Map headers)
	A hook first gets called with the parsed headers from the message.
boolean	passMessage (InputStream is) throws IOException
	The hook is called to process the entire message (including headers) as an octet stream.

---

Member Function Documentation

void com.quadcap.pop3.client.HookShell.init (  Properties  p  )

Initialize the hook with its property set. Implements com.quadcap.pop3.client.MessageHook. Definition at line 23 of file HookShell.java. References com.quadcap.pop3.client.HookShell.init(). Referenced by com.quadcap.pop3.client.HookShell.init().

boolean com.quadcap.pop3.client.HookShell.passAllHeaders (   )

Return true if the call to boolean passHeaders(Map headers) will always return true, so the message receiver can avoid calling it. Implements com.quadcap.pop3.client.MessageHook. Definition at line 31 of file HookShell.java.

boolean com.quadcap.pop3.client.HookShell.passHeaders (  Map  headers  )

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 sendMessage(), below. Implements com.quadcap.pop3.client.MessageHook. Definition at line 38 of file HookShell.java. References com.quadcap.pop3.client.HookShell.passHeaders(). Referenced by com.quadcap.pop3.client.HookShell.passHeaders().

boolean com.quadcap.pop3.client.HookShell.passMessage (  InputStream  is  )  throws IOException

The hook is called to process the entire message (including headers) as an octet stream. Returns: false if the message is to be retained in the store, true to delete it. Implements com.quadcap.pop3.client.MessageHook. Definition at line 49 of file HookShell.java. References com.quadcap.pop3.client.HookShell.passMessage(). Referenced by com.quadcap.pop3.client.HookShell.passMessage().