JavaEE API 8.0.1 · javax.mail.event.MessageCountEvent

This class notifies changes in the number of messages in a folder.

Note that some folder types may only deliver MessageCountEvents at certain times or after certain operations. IMAP in particular will only notify the client of MessageCountEvents when a client issues a new command. Refer to RFC 3501 for details. A client may want to "poll" the folder by occasionally calling the getMessageCount or isOpen methods to solicit any such notifications.

Field Summary

Modifier and Type	Field and Description
public static final int	ADDED The messages were added to their folder
protected transient Message[]	msgs The messages.
public static final int	REMOVED The messages were removed from their folder
protected boolean	removed If true, this event is the result of an explicit expunge by this client, and the messages in this folder have been renumbered to account for this.
private static final long	serialVersionUID Hides javax.mail.event.MailEvent.serialVersionUID.
protected int	type The event type.

Constructor Summary

Access	Constructor and Description
public	MessageCountEvent(Folder The containing folder folder, int The event type type, boolean If true, this event is the result of an explicit expunge by this client, and the messages in this folder have been renumbered to account for this. If false, this event is the result of an expunge by external sources. removed, Message[] The messages added/removed msgs) Constructor.

Method Summary

Modifier and Type	Method and Description
public void	dispatch(Object the listener to invoke on listener) Implements abstract javax.mail.event.MailEvent.dispatch. Invokes the appropriate MessageCountListener method.
public Message[]	Returns: array of messages getMessages() Return the array of messages added or removed.
public int	Returns: type getType() Return the type of this event.
public boolean	Returns: true if the message has been removed isRemoved() Indicates whether this event is the result of an explicit expunge by this client, or due to an expunge from external sources.

Field Detail

ADDED	back to summary
public static final int ADDED The messages were added to their folder

msgs	back to summary
protected transient Message[] msgs The messages.

REMOVED	back to summary
public static final int REMOVED The messages were removed from their folder

removed	back to summary
protected boolean removed If true, this event is the result of an explicit expunge by this client, and the messages in this folder have been renumbered to account for this. If false, this event is the result of an expunge by external sources.

serialVersionUID	back to summary
private static final long serialVersionUID Hides javax.mail.event.MailEvent.serialVersionUID.

type	back to summary
protected int type The event type.

Constructor Detail

MessageCountEvent	back to summary
public MessageCountEvent(Folder folder, int type, boolean removed, Message[] msgs) Constructor. Parameters folder:Folder The containing folder type:int The event type removed:boolean If true, this event is the result of an explicit expunge by this client, and the messages in this folder have been renumbered to account for this. If false, this event is the result of an expunge by external sources. msgs:Message[] The messages added/removed

MessageCountEvent

back to summary

public MessageCountEvent(Folder folder, int type, boolean removed, Message[] msgs)

Constructor.

Parameters

folder:Folder: The containing folder
type:int: The event type
removed:boolean: If true, this event is the result of an explicit expunge by this client, and the messages in this folder have been renumbered to account for this. If false, this event is the result of an expunge by external sources.
msgs:Message[]: The messages added/removed

Method Detail

dispatch	back to summary
public void dispatch(Object listener) Implements abstract javax.mail.event.MailEvent.dispatch. Invokes the appropriate MessageCountListener method. Parameters listener:Object Doc from javax.mail.event.MailEvent.dispatch. the listener to invoke on Annotations @Override

dispatch

back to summary

public void dispatch(Object listener)

Implements abstract javax.mail.event.MailEvent.dispatch.

Invokes the appropriate MessageCountListener method.

Parameters

listener:Object

Doc from javax.mail.event.MailEvent.dispatch.

the listener to invoke on

Annotations

@Override

getMessages	back to summary
public Message[] getMessages() Return the array of messages added or removed. Returns:Message[] array of messages

getMessages

back to summary

public Message[] getMessages()

Return the array of messages added or removed.

Returns:Message[]: array of messages

getType	back to summary
public int getType() Return the type of this event. Returns:int type

getType

back to summary

public int getType()

Return the type of this event.

Returns:int: type

isRemoved back to summary

isRemoved	back to summary
public boolean isRemoved() Indicates whether this event is the result of an explicit expunge by this client, or due to an expunge from external sources. If `true`, this event is due to an explicit expunge and hence all remaining messages in this folder have been renumbered. If `false`, this event is due to an external expunge. Note that this method is valid only if the type of this event is `REMOVED` Returns:boolean true if the message has been removed

public boolean isRemoved()

Indicates whether this event is the result of an explicit expunge by this client, or due to an expunge from external sources. If true, this event is due to an explicit expunge and hence all remaining messages in this folder have been renumbered. If false, this event is due to an external expunge.

Note that this method is valid only if the type of this event is REMOVED

Returns:boolean: true if the message has been removed

public Class MessageCountEvent

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail