dtw.webmail.model
Interface JwmaPreferences

All Known Subinterfaces:

JwmaPreferencesImpl

All Known Implementing Classes:

CastorPreferences

public interface JwmaPreferences

An interface defining the contract for interaction with the JwmaPreferences model.

JwmaPreferences allows a view programmer to obtain information about the users preferences to display them for reading or editing.

Version:

0.9.7 07/02/2003

Author:

Dieter Wimberger

Method Summary

java.text.DateFormat	getDateFormat() Returns a DateFormat representing the user's preferred date format.
java.lang.String	getDraftFolder() Returns a String representing the full name of the draft folder.
java.lang.String	getFirstname() Returns a String representing the firstname of the owner of this JwmaPreferences.
java.lang.String	getLanguage() Returns a String representing the language.
java.lang.String	getLastLogin() Returns a String representing the user's last login date and originating host.
java.lang.String	getLastname() Returns a String representing the lastname of the owner of this JwmaPreferences.
java.util.Locale	getLocale() Returns the Locale associated with this JwmaPreferences.
JwmaMailIdentity	getMailIdentity() Returns the user's default JwmaMailIdentity.
JwmaMailIdentity	getMailIdentity(java.lang.String uid) Returns the JwmaMailIdentity with the given unique identifier.
net.wimpi.text.Processor	getMessageProcessor() Returns a Processor representing the users preferred message processor for processing text/plain messages.
java.lang.String	getMessageProcessorName() Convenience method that returns a String representing the users preferred message processor name.
int	getMessageSortCriteria() Returns the sort criteria preference for messages.
java.lang.String	getQuoteChar() Returns a String representing the quote character.
java.lang.String	getReadMailArchive() Returns a String representing the path of the read-mail-archive.
java.lang.String	getRootFolder() Returns a String representing the path of the mail root folder.
java.lang.String	getSentMailArchive() Returns a String representing the path of the sent-mail-archive.
java.lang.String	getStyle() Returns a String representing the users preferred style.
java.lang.String	getTrashFolder() Returns a String representing the path of the read-mail-archive.
java.lang.String	getUserIdentity() Returns a String representing identity of the owner of this JwmaPreferences.
boolean	isAutoArchiveSent() Tests if messages should be automatically archived when sent.
boolean	isAutoEmpty() Tests if the trash should be emptied automatically when logging out.
boolean	isAutoMoveRead() Tests if messages should be automatically moved when read.
boolean	isAutoQuote() Tests if messages should be quoted automatically when replying.
boolean	isDisplayingInlined() Tests if known mime message content should be inlined when displaying the message.
boolean	isExpert() Tests if the user considers to be an xpert.
JwmaMailIdentity[]	listMailIdentities() Returns a JwmaMailIdentities[] that contains all JwmaMailIdentity instances of this JwmaPreferences.
void	setMessageSortCriteria(int crit) Sets the sort criteria preference for messages.

Method Detail

getUserIdentity

public java.lang.String getUserIdentity()

Returns a String representing identity of the owner of this JwmaPreferences.

Note:
The format of the string has to be <username>@<postofficehost>.

Returns:

the firstname of this preferences owner.

getFirstname

public java.lang.String getFirstname()

Returns a String representing the firstname of the owner of this JwmaPreferences.

Returns:

the firstname of this preferences owner.

getLastname

public java.lang.String getLastname()

Returns a String representing the lastname of the owner of this JwmaPreferences.

Returns:

the lastname of this preferences owner.

getLastLogin

public java.lang.String getLastLogin()

Returns a String representing the user's last login date and originating host.

Returns:

the last login with date and originating host as String.

getQuoteChar

public java.lang.String getQuoteChar()

Returns a String representing the quote character. Note: it always contains only one character.

Returns:

the quote character as String.

isAutoQuote

public boolean isAutoQuote()

Tests if messages should be quoted automatically when replying.

Returns:

true if messages should be quoted automatically, false otherwise.

getRootFolder

public java.lang.String getRootFolder()

Returns a String representing the path of the mail root folder.

Note: This setting varies for different IMAP implementations.

Returns:

the mail root folder as String.

getDraftFolder

public java.lang.String getDraftFolder()

Returns a String representing the full name of the draft folder.

Returns:

the full name of the draft folder as String.

isAutoArchiveSent

public boolean isAutoArchiveSent()

Tests if messages should be automatically archived when sent.

Returns:

true if messages should be archived automatically, false otherwise.

getSentMailArchive

public java.lang.String getSentMailArchive()

Returns a String representing the path of the sent-mail-archive.

Returns:

the path of the sent-mail-archive as String.

isAutoMoveRead

public boolean isAutoMoveRead()

Tests if messages should be automatically moved when read.

Returns:

true if messages should be moved automatically, false otherwise.

getReadMailArchive

public java.lang.String getReadMailArchive()

Returns a String representing the path of the read-mail-archive.

Returns:

the path of the read-mail-archive as String.

isAutoEmpty

public boolean isAutoEmpty()

Tests if the trash should be emptied automatically when logging out.

Returns:

true if the trash should be emptied automatically, false otherwise.

getTrashFolder

public java.lang.String getTrashFolder()

Returns a String representing the path of the read-mail-archive.

Returns:

the path of the read-mail-archive as String.

getLanguage

public java.lang.String getLanguage()

Returns a String representing the language.

Note that this method is a shortcut for getLocale().getLanguage().

Returns:

the language locale as String.

getLocale

public java.util.Locale getLocale()

Returns the Locale associated with this JwmaPreferences.

Returns:

the associated Locale.

getMessageProcessor

public net.wimpi.text.Processor getMessageProcessor()

Returns a Processor representing the users preferred message processor for processing text/plain messages.

Returns:

the message processor as Processor.

getMessageProcessorName

public java.lang.String getMessageProcessorName()

Convenience method that returns a String representing the users preferred message processor name.

Returns:

the name of the message processor as String.

getDateFormat

public java.text.DateFormat getDateFormat()

Returns a DateFormat representing the user's preferred date format.

Returns:

the user's preferred DateFormat.

getMailIdentity

public JwmaMailIdentity getMailIdentity()

Returns the user's default JwmaMailIdentity.

Returns:

a the preferred or default JwmaMailIdentity.

getMailIdentity

public JwmaMailIdentity getMailIdentity(java.lang.String uid)

Returns the JwmaMailIdentity with the given unique identifier. If the identifier is invalid, the method will return the default mail identity.

Parameters:

uid - a unique identifier of a mail identity.

Returns:

the JwmaMailIdentity with the given uid.

listMailIdentities

public JwmaMailIdentity[] listMailIdentities()

Returns a JwmaMailIdentities[] that contains all JwmaMailIdentity instances of this JwmaPreferences.

Returns:

the user's mail identities as JwmaMailIdentity[].

isExpert

public boolean isExpert()

Tests if the user considers to be an xpert.

Returns:

true if expert, false otherwise.

getStyle

public java.lang.String getStyle()

Returns a String representing the users preferred style.

Returns:

the style as String.

isDisplayingInlined

public boolean isDisplayingInlined()

Tests if known mime message content should be inlined when displaying the message.

Returns:

true if inlining is enabled, false otherwise.

getMessageSortCriteria

public int getMessageSortCriteria()

Returns the sort criteria preference for messages.

Returns:

the sort criteria as int.

setMessageSortCriteria

public void setMessageSortCriteria(int crit)

Sets the sort criteria preference for messages.

Parameters:

crit - the sort criteria as int.