: Interface FetchAgent

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| ## TsBiff 1.3
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## ts.mail
Interface FetchAgent

All Superinterfaces:
  SafeTerminate

All Known Implementing Classes:
  MboxAgent, Pop3Agent

public interface FetchAgent
extends SafeTerminate

This interface represent an abstract Mail Fetch Agent. A MFA is used for fetching mail messages. Implementors should implement the getMail method which will be the actual protocol used for fetching mail.

Version:
  $Id: FetchAgent.java,v 1.5 1999/06/09 18:55:57 hauk Exp $
Author:
  Jan-Henrik Haukeland <hauk@tildeslash.com>
See Also:
  `MboxAgent`

Method Summary
`java.util.Vector` | `getMail()` Fetch mail messages using a certain protocol.
`java.lang.String` | `getProtocol()`
`void` | `stopScan()` Stop reading mail

Methods inherited from interface ts.biff.SafeTerminate
`canTerminate`

Method Detail

### getMail

    public java.util.Vector getMail()
                             throws GetMailException

  Fetch mail messages using a certain protocol.
  Returns:
    A vector with MailModel objects
  Throws:
    `GetMailException` - Is thrown if mail for some reason could not be fetched

### stopScan

    public void stopScan()

  Stop reading mail

### getProtocol

    public java.lang.String getProtocol()

  Returns:
    The protocol used

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| ## TsBiff 1.3
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD