StoreEvent (JavaMail API documentation)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.mail.event
class StoreEvent

javax.mail.event.MailEvent
  javax.mail.event.StoreEvent

public class StoreEvent
extends MailEvent

This class models notifications from the Store connection. These notifications can be ALERTS or NOTICES. ALERTS must be presented to the user in a fashion that calls the user's attention to the message.

See Also (auto-generated):

Folder

Store

Session

Field Summary
`static int`	`ALERT` Indicates that this message is an ALERT.
`protected String`	`message` The message text to be presented to the user.
`static int`	`NOTICE` Indicates that this message is a NOTICE.
`protected int`	`type` The event type.

Constructor Summary
`StoreEvent(Store store, int type, String message)` Constructor.

Method Summary
`void`	`dispatch(Object listener)` Invokes the appropriate StoreListener method.
`String`	`getMessage()` Get the message from the Store.
`int`	`getMessageType()` Return the type of this event.

Methods inherited from class javax.mail.event.MailEvent
`dispatch`

Field Detail

ALERT

public static final int ALERT

Indicates that this message is an ALERT.

message

protected String message

The message text to be presented to the user.

NOTICE

public static final int NOTICE

Indicates that this message is a NOTICE.

type

protected int type

The event type.

Constructor Detail

StoreEvent

public StoreEvent(Store store,
                  int type,
                  String message)

Constructor.

Parameters:: store - The source Store; type; message

Method Detail

dispatch

public void dispatch(Object listener)

Invokes the appropriate StoreListener method.

Overrides:: dispatch in class MailEvent
Parameters:: listener

getMessage

public String getMessage()

Get the message from the Store.

Returns:: message from the Store

getMessageType

public int getMessageType()

Return the type of this event.

Returns:: type