JavaEE API 8.0.1 · javax.mail.event.FolderEvent

This class models Folder existence events. FolderEvents are delivered to FolderListeners registered on the affected Folder as well as the containing Store.

Service providers vary widely in their ability to notify clients of these events. At a minimum, service providers must notify listeners registered on the same Store or Folder object on which the operation occurs. Service providers may also notify listeners when changes are made through operations on other objects in the same virtual machine, or by other clients in the same or other hosts. Such notifications are not required and are typically not supported by mail protocols (including IMAP).

Field Summary

Modifier and Type	Field and Description
public static final int	CREATED The folder was created.
public static final int	DELETED The folder was deleted.
protected transient Folder	folder The folder the event occurred on.
protected transient Folder	newFolder The folder that represents the new name, in case of a RENAMED event.
public static final int	RENAMED The folder was renamed.
private static final long	serialVersionUID Hides javax.mail.event.MailEvent.serialVersionUID.
protected int	type The event type.

Constructor Summary

Access	Constructor and Description
public	FolderEvent(Object The source of the event source, Folder The affected folder folder, int The event type type) Constructor.
public	FolderEvent(Object The source of the event source, Folder The folder that is renamed oldFolder, Folder The folder that represents the new name newFolder, int The event type type) 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 FolderListener method
public Folder	Returns: the affected folder getFolder() Return the affected folder.
public Folder	Returns: Folder representing the new name. getNewFolder() If this event indicates that a folder is renamed, (i.e, the event type is RENAMED), then this method returns the Folder object representing the new name.
public int	Returns: type getType() Return the type of this event.

Field Detail

CREATED	back to summary
public static final int CREATED The folder was created.

DELETED	back to summary
public static final int DELETED The folder was deleted.

folder	back to summary
protected transient Folder folder The folder the event occurred on.

newFolder	back to summary
protected transient Folder newFolder The folder that represents the new name, in case of a RENAMED event. Since JavaMail 1.1

newFolder

back to summary

protected transient Folder newFolder

The folder that represents the new name, in case of a RENAMED event.

Since: JavaMail 1.1

RENAMED	back to summary
public static final int RENAMED The folder was renamed.

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

FolderEvent	back to summary
public FolderEvent(Object source, Folder folder, int type) Constructor. Parameters source:Object The source of the event folder:Folder The affected folder type:int The event type

FolderEvent

back to summary

public FolderEvent(Object source, Folder folder, int type)

Constructor.

Parameters

source:Object: The source of the event
folder:Folder: The affected folder
type:int: The event type

FolderEvent	back to summary
public FolderEvent(Object source, Folder oldFolder, Folder newFolder, int type) Constructor. Use for RENAMED events. Parameters source:Object The source of the event oldFolder:Folder The folder that is renamed newFolder:Folder The folder that represents the new name type:int The event type Since JavaMail 1.1

FolderEvent

back to summary

public FolderEvent(Object source, Folder oldFolder, Folder newFolder, int type)

Constructor. Use for RENAMED events.

Parameters

source:Object: The source of the event
oldFolder:Folder: The folder that is renamed
newFolder:Folder: The folder that represents the new name
type:int: The event type

Since

JavaMail 1.1

Method Detail

dispatch	back to summary
public void dispatch(Object listener) Implements abstract javax.mail.event.MailEvent.dispatch. Invokes the appropriate FolderListener 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 FolderListener method

Parameters

listener:Object

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

the listener to invoke on

Annotations

@Override

getFolder back to summary

getFolder	back to summary
public Folder getFolder() Return the affected folder. Returns:Folder the affected folder See Also `getNewFolder`

public Folder getFolder()

Return the affected folder.

Returns:Folder: the affected folder
See Also: getNewFolder

getNewFolder back to summary

getNewFolder	back to summary
public Folder getNewFolder() If this event indicates that a folder is renamed, (i.e, the event type is RENAMED), then this method returns the Folder object representing the new name. The `getFolder()` method returns the folder that is renamed. Returns:Folder Folder representing the new name. Since JavaMail 1.1 See Also `getFolder`

public Folder getNewFolder()

If this event indicates that a folder is renamed, (i.e, the event type is RENAMED), then this method returns the Folder object representing the new name.

The getFolder() method returns the folder that is renamed.

Returns:Folder: Folder representing the new name.
Since: JavaMail 1.1
See Also: getFolder

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

public Class FolderEvent

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail