dtw.webmail.model
Interface JwmaPreferencesImpl

All Superinterfaces:

java.lang.Cloneable, JwmaPreferences

All Known Implementing Classes:

CastorPreferences

public interface JwmaPreferencesImpl

extends JwmaPreferences, java.lang.Cloneable

Interface for JwmaPreferences implementations. This is the interface any specialized implementation has to expose internal to controllers and models.

Version:

0.9.7 07/02/2003

Author:

Dieter Wimberger

Method Summary

void	addMailIdentity(JwmaMailIdentity identity) Adds the given JwmaMailIdentity to this JwmaPreferences.
JwmaMailIdentityImpl	createMailIdentity() Factory method for an implementation specific JwmaMailIdentityImpl.
boolean	existsMailIdentity(java.lang.String uid) Tests if a JwmaMailIdentity with the given index exists.
java.lang.String	getContactDatabaseID() Returns a String representing the user's contact database UID.
int	getMailIdentityCount() Returns the count of JwmaMailIdentity instances that are associated with this JwmaPreferences.
void	removeMailIdentity(java.lang.String uid) Removes the JwmaMailIdentity with the given id from this JwmaPreferences.
void	setAutoArchiveSent(boolean doarchive) Sets the flag that controls wheter messages should be automatically archived when sent.
void	setAutoEmpty(boolean b) Sets the flag that controls wheter messages should be automatically deleted from the trash on logout.
void	setAutoMoveRead(boolean domoveread) Sets the flag that controls wheter messages should be automatically moved when read.
void	setAutoQuote(boolean doquote) Sets the flag that controls wheter messages should be automatically quoted on reply.
void	setContactDatabaseID(java.lang.String dbid) Sets a String representing the user's contact database UID.
void	setDateFormat(java.text.SimpleDateFormat dateformat) Sets the DateFormat representing the user's preferred date format.
void	setDefaultMailIdentity(java.lang.String uid) Sets the user's default identity JwmaMailIdentity instance.
void	setDisplayingInlined(boolean b) Sets the flag that controls whether known mime message content is displayed inline.
void	setDraftFolder(java.lang.String path) Sets the path of the draft folder.
void	setExpert(boolean b) Sets the flag that shows wheter the owner of this JwmaPreferences considers to be an xpert.
void	setFirstname(java.lang.String firstname) Sets the firstname of the owner of this JwmaPreferences.
void	setLanguage(java.lang.String language) Sets a String representing the language.
void	setLastLogin(java.lang.String lastlogin) Sets the the user's last login date and originating host.
void	setLastname(java.lang.String lastname) Sets the lastname of the owner of this JwmaPreferences.
void	setLocale(java.util.Locale locale) Sets the Locale associated with this JwmaPreferences.
void	setMessageProcessor(net.wimpi.text.Processor processor) Sets the Processor representing the users preferred message processor for processing plain/text messages.
void	setMessageProcessorName(java.lang.String name) Sets the Processor representing the users preferred message processor for processing plain/text messages by its name.
void	setQuoteChar(java.lang.String qc) Sets the quoting character.
void	setReadMailArchive(java.lang.String path) Sets the path of the read-mail-archive.
void	setRootFolder(java.lang.String path) Sets the path of the mail root folder.
void	setSentMailArchive(java.lang.String path) Sets the path of the sent-mail-archive.
void	setStyle(java.lang.String style) Sets a String representing the users preferred style.
void	setTrashFolder(java.lang.String path) Sets the path of the trashfolder.
void	setUserIdentity(java.lang.String userid) Sets the identity of this JwmaPreferences.

Methods inherited from interface dtw.webmail.model.JwmaPreferences

getDateFormat, getDraftFolder, getFirstname, getLanguage, getLastLogin, getLastname, getLocale, getMailIdentity, getMailIdentity, getMessageProcessor, getMessageProcessorName, getMessageSortCriteria, getQuoteChar, getReadMailArchive, getRootFolder, getSentMailArchive, getStyle, getTrashFolder, getUserIdentity, isAutoArchiveSent, isAutoEmpty, isAutoMoveRead, isAutoQuote, isDisplayingInlined, isExpert, listMailIdentities, setMessageSortCriteria

Method Detail

setUserIdentity

public void setUserIdentity(java.lang.String userid)

Sets the identity of this JwmaPreferences.

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

setFirstname

public void setFirstname(java.lang.String firstname)

Sets the firstname of the owner of this JwmaPreferences.

Parameters:

firstname - the owner's firstname.

setLastname

public void setLastname(java.lang.String lastname)

Sets the lastname of the owner of this JwmaPreferences.

Parameters:

lastname - the owner's lastname.

setLastLogin

public void setLastLogin(java.lang.String lastlogin)

Sets the the user's last login date and originating host.

setLanguage

public void setLanguage(java.lang.String language)

Sets a String representing the language.

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

Parameters:

language - the standard ISO639 identifier as String.

setLocale

public void setLocale(java.util.Locale locale)

Sets the Locale associated with this JwmaPreferences.

Parameters:

locale - the Locale to be set.

setQuoteChar

public void setQuoteChar(java.lang.String qc)

Sets the quoting character.

Note: only the first character is taken from the String.

Returns:

the quote character as String.

setAutoQuote

public void setAutoQuote(boolean doquote)

Sets the flag that controls wheter messages should be automatically quoted on reply.

Parameters:

doquote - true if messages being replied to should be automatically quoted, false otherwise.

setRootFolder

public void setRootFolder(java.lang.String path)

Sets the path of the mail root folder.

Parameters:

path - the path of root mail folder as String.

setSentMailArchive

public void setSentMailArchive(java.lang.String path)

Sets the path of the sent-mail-archive.

Parameters:

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

setReadMailArchive

public void setReadMailArchive(java.lang.String path)

Sets the path of the read-mail-archive.

Parameters:

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

setTrashFolder

public void setTrashFolder(java.lang.String path)

Sets the path of the trashfolder.

Parameters:

path - the path of the trashfolder as String.

setDraftFolder

public void setDraftFolder(java.lang.String path)

Sets the path of the draft folder.

Parameters:

path - the path of the draft folder as String.

setAutoArchiveSent

public void setAutoArchiveSent(boolean doarchive)

Sets the flag that controls wheter messages should be automatically archived when sent.

Parameters:

doarchive - true if messages being sent should be automatically archived, false otherwise.

setAutoMoveRead

public void setAutoMoveRead(boolean domoveread)

Sets the flag that controls wheter messages should be automatically moved when read.

Parameters:

domoveread - true if read messages should be automatically moved, false otherwise.

setAutoEmpty

public void setAutoEmpty(boolean b)

Sets the flag that controls wheter messages should be automatically deleted from the trash on logout.

Parameters:

b - true if messages in trash should be automatically deleted on logout, false otherwise.

getContactDatabaseID

public java.lang.String getContactDatabaseID()

Returns a String representing the user's contact database UID.

Returns:

the UID of the contact database as String.

setContactDatabaseID

public void setContactDatabaseID(java.lang.String dbid)

Sets a String representing the user's contact database UID.

Returns:

the UID of the contact database as String.

setMessageProcessorName

public void setMessageProcessorName(java.lang.String name)

Sets the Processor representing the users preferred message processor for processing plain/text messages by its name.

Note that this method is a shortcut for

 
 setMessageProcessor(
         JwmaKernel.getReference().getMessageProcessor(String name)
 );
 
 

Parameters:

name - the Processor's identifier as String.

setMessageProcessor

public void setMessageProcessor(net.wimpi.text.Processor processor)

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

Parameters:

processor - the preferred message processor.

setDateFormat

public void setDateFormat(java.text.SimpleDateFormat dateformat)

Sets the DateFormat representing the user's preferred date format. Note that the passed in dateformat should be an instance of SimpleDateFormat, which is enforced by the parameter type.

Parameters:

dateformat - the user's preferred SimpleDateFormat.

setDefaultMailIdentity

public void setDefaultMailIdentity(java.lang.String uid)

Sets the user's default identity JwmaMailIdentity instance.

Parameters:

uid - the identifier of the JwmaMailIdentity to be set as default.

addMailIdentity

public void addMailIdentity(JwmaMailIdentity identity)

Adds the given JwmaMailIdentity to this JwmaPreferences.

Parameters:

identity - the JwmaMailIdentity to be added.

removeMailIdentity

public void removeMailIdentity(java.lang.String uid)

Removes the JwmaMailIdentity with the given id from this JwmaPreferences.

Parameters:

uid - the identifier of the JwmaMailIdentity to be removed.

existsMailIdentity

public boolean existsMailIdentity(java.lang.String uid)

Tests if a JwmaMailIdentity with the given index exists.

Parameters:

uid - the identifier of the JwmaMailIdentity.

getMailIdentityCount

public int getMailIdentityCount()

Returns the count of JwmaMailIdentity instances that are associated with this JwmaPreferences.

Returns:

the number of JwmaMailIdentity instances associated with this JwmaPreferences.

setExpert

public void setExpert(boolean b)

Sets the flag that shows wheter the owner of this JwmaPreferences considers to be an xpert.

Parameters:

b - true if expert, false otherwise.

setStyle

public void setStyle(java.lang.String style)

Sets a String representing the users preferred style.

Parameters:

style - the style as String.

setDisplayingInlined

public void setDisplayingInlined(boolean b)

Sets the flag that controls whether known mime message content is displayed inline.

Returns:

true if inline displaying is to be enabled, false otherwise.

createMailIdentity

public JwmaMailIdentityImpl createMailIdentity()

Factory method for an implementation specific JwmaMailIdentityImpl.

Returns:

an instance of the related JwmaMailIdentityImpl implementation.