Java Doc for UserData.java in  » Web-Mail » jwebmail-0.7 » net » wastl » webmail » server » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Web Mail » jwebmail 0.7 » net.wastl.webmail.server 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


net.wastl.webmail.server.UserData

All known Subclasses:   net.wastl.webmail.xml.XMLUserData,
UserData
public interface UserData (Code)

author:
   Sebastian Schaffert
version:
   $Revision: 1.1.1.1 $




Method Summary
public  voidaddMailHost(String name, String host, String login, String password)
     Add a mailbox to this user's data.
public  booleancheckPassword(String s)
     Check the given password against the user's password.
public  StringgetDomain()
     Return the name of the virtual domain this user is in.
public  StringgetEmail()
     Get the email address of the user.
public  StringgetFirstLogin()
     Get a localized string containing the date when the user first logged in.
public  StringgetFullName()
     Return the full name (christian and last name) of the user.
public  StringgetLastLogin()
     Get a localized string containing the date when the user logged in the last time.
public  StringgetLogin()
     Returns the username concatenated with '@' and the virtual domain.
public  StringgetLoginCount()
     Get a string containing the total count of logins for the user.
public  MailHostDatagetMailHost(String name)
     Return the mailhost data for the mailbox with the given name.
public  intgetMaxLineLength()
     Break lines at this maximum length.Only applicable if the user configured to break lines.
public  intgetMaxShowMessages()
     Return the value that the user configured as maximum number of messages to display on one page of the message list.
public  StringgetPasswordData()
     Get the password data for this user.
public  LocalegetPreferredLocale()
     Return the locale that this user configured.
public  StringgetSentFolder()
     Return the id of the folder that should be used to store sent messages.
public  StringgetSignature()
     Return the signature of this user that should be appended to composed messages.
public  StringgetTheme()
     Return the theme that the user configured.
public  StringgetUserName()
     Return the username without the domain (in contrast to getLogin()).
public  voidlogin()
    
public  voidlogout()
    
public  EnumerationmailHosts()
     Return the list of mailbox names of the mailboxes this user has.
public  voidremoveMailHost(String name)
     Remove the mailhost with the given name.
public  voidsetBreakLines(boolean b)
     Set whether the user wants to force line breaks or not.
public  voidsetDomain(String s)
     Set the name of the virtual domain this user is in.
public  voidsetEmail(String s)
     Set the email address of the user.
public  voidsetFullName(String s)
     Set the full name (christian and last name) of the user.
public  voidsetMaxLineLength(int i)
     Set the maximum column count for messages.
public  voidsetMaxShowMessages(int i)
     Set the number of maximum messages to display on one page of the messagelist.
public  voidsetPassword(String newpasswd, String verify)
     Change the users password.
public  voidsetPasswordData(String data)
     Set the password data for a user.
public  voidsetPreferredLocale(String newloc)
     Set the preferred locale for this user
Parameters:
  newloc - name of the new locale (e.g.
public  voidsetSaveSent(boolean b)
     Set whether the user wants to save sent messages or not.
public  voidsetSentFolder(String s)
     Set the id of the folder that should be used to store sent messages.
public  voidsetSetFlags(boolean b)
     Enable/disable write mode on mailboxes.
public  voidsetShowFancy(boolean b)
     Set whether the user wants some graphical enhancements (image smileys, etc).
public  voidsetShowImages(boolean b)
     Set whether the user wants attached images to be shown inlined in the messages.
public  voidsetSignature(String s)
     Set the signature that should be appended to composed messages.
public  voidsetTheme(String theme)
     Change the theme for this user.
public  booleanwantsBreakLines()
     Check whether the user wants to force line breaks.
public  booleanwantsSaveSent()
     Check whether the user wants to save sent messages or not.
public  booleanwantsSetFlags()
     Check whether write mode is enabled on mailboxes.
public  booleanwantsShowFancy()
     Check whether the user wants some graphical enhancements (image smileys, etc).
public  booleanwantsShowImages()
     Check whether the user wants attached images to be shown inlined in the messages or not.



Method Detail
addMailHost
public void addMailHost(String name, String host, String login, String password)(Code)
Add a mailbox to this user's data. The new mailbox will be stored in the user configuration and used for connection.
Parameters:
  name - Name used to represent the mailhost in WebMail
Parameters:
  host - This will usually be the URL to the mailhost, constructed from the protocol and the hostname
Parameters:
  login - The login name used for the host
Parameters:
  password - The corresponding password



checkPassword
public boolean checkPassword(String s)(Code)
Check the given password against the user's password.
Parameters:
  s - String with the password that is to be checked
See Also:   SimpleAuthenticator



getDomain
public String getDomain()(Code)
Return the name of the virtual domain this user is in.



getEmail
public String getEmail()(Code)
Get the email address of the user. This will be used for outgoing mail.



getFirstLogin
public String getFirstLogin()(Code)
Get a localized string containing the date when the user first logged in.



getFullName
public String getFullName()(Code)
Return the full name (christian and last name) of the user.



getLastLogin
public String getLastLogin()(Code)
Get a localized string containing the date when the user logged in the last time.



getLogin
public String getLogin()(Code)
Returns the username concatenated with '@' and the virtual domain. As of WebMail 0.7.0 this is different from the username, because it consists of the username and the domain.
See Also:    getUserName()



getLoginCount
public String getLoginCount()(Code)
Get a string containing the total count of logins for the user.



getMailHost
public MailHostData getMailHost(String name)(Code)
Return the mailhost data for the mailbox with the given name.
Parameters:
  name - The WebMail internal name of this mailbox
See Also:   MailHostData



getMaxLineLength
public int getMaxLineLength()(Code)
Break lines at this maximum length.Only applicable if the user configured to break lines.
See Also:    wantsBreakLines()



getMaxShowMessages
public int getMaxShowMessages()(Code)
Return the value that the user configured as maximum number of messages to display on one page of the message list.



getPasswordData
public String getPasswordData()(Code)
Get the password data for this user. The saved password data



getPreferredLocale
public Locale getPreferredLocale()(Code)
Return the locale that this user configured.



getSentFolder
public String getSentFolder()(Code)
Return the id of the folder that should be used to store sent messages. This is only applicable if the user enabled the storage of sent messages.
See Also:    net.wastl.webmail.server.WebMailSession.generateFolderHash()
See Also:    wantsSaveSent()
See Also:    setSaveSent()



getSignature
public String getSignature()(Code)
Return the signature of this user that should be appended to composed messages.



getTheme
public String getTheme()(Code)
Return the theme that the user configured. (Reserved for future use, just returns "default").



getUserName
public String getUserName()(Code)
Return the username without the domain (in contrast to getLogin()).
See Also:    getLogin()



login
public void login()(Code)



logout
public void logout()(Code)



mailHosts
public Enumeration mailHosts()(Code)
Return the list of mailbox names of the mailboxes this user has.



removeMailHost
public void removeMailHost(String name)(Code)
Remove the mailhost with the given name.
Parameters:
  name - The WebMail internal name of this mailbox



setBreakLines
public void setBreakLines(boolean b)(Code)
Set whether the user wants to force line breaks or not.
Parameters:
  b - true if the user wants linebreaks



setDomain
public void setDomain(String s)(Code)
Set the name of the virtual domain this user is in.
Parameters:
  s - name of the virtual domain



setEmail
public void setEmail(String s)(Code)
Set the email address of the user. This will be used for outgoing mail.
Parameters:
  s - String containing the Email address



setFullName
public void setFullName(String s)(Code)
Set the full name (christian and last name) of the user.
Parameters:
  s - the String containing the full name of the user



setMaxLineLength
public void setMaxLineLength(int i)(Code)
Set the maximum column count for messages. Only applicable if the user configured to break lines.
Parameters:
  i - maximum column count
See Also:    wantsBreakLines()



setMaxShowMessages
public void setMaxShowMessages(int i)(Code)
Set the number of maximum messages to display on one page of the messagelist.
Parameters:
  i - maximum number of messages on one page



setPassword
public void setPassword(String newpasswd, String verify) throws InvalidPasswordException(Code)
Change the users password.
Parameters:
  newpasswd - new password
Parameters:
  verify - new password again to verify that it was not misspelled



setPasswordData
public void setPasswordData(String data)(Code)
Set the password data for a user. This can contain any string which will then become password data for a user. It can be encoded however the authenticator chooses. Note that when switching authenticators, this password data will most likely not be valid anymore, and the user will be locked out of their account.
Parameters:
  data - The new data to use



setPreferredLocale
public void setPreferredLocale(String newloc)(Code)
Set the preferred locale for this user
Parameters:
  newloc - name of the new locale (e.g. de_DE)



setSaveSent
public void setSaveSent(boolean b)(Code)
Set whether the user wants to save sent messages or not. The folder where sent messages will be stored has to be configured also.
Parameters:
  b - true if the user wants to save sent messages
See Also:    getSentFolder()
See Also:    setSentFolder()



setSentFolder
public void setSentFolder(String s)(Code)
Set the id of the folder that should be used to store sent messages. This is only applicable if the user enabled the storage of sent messages.
See Also:    net.wastl.webmail.server.WebMailSession.generateFolderHash()
See Also:    wantsSaveSent()
See Also:    setSaveSent()



setSetFlags
public void setSetFlags(boolean b)(Code)
Enable/disable write mode on mailboxes. This influences many things like setting message flags, copying/moving messages, deleting messages and the like.
Parameters:
  b - true: enable write mode
See Also:    net.wastl.webmail.server.WebMailSession.getMessage()
See Also:    net.wastl.webmail.server.WebMailSession.copyMoveMessage()
See Also:    net.wastl.webmail.server.WebMailSession.setFlags()



setShowFancy
public void setShowFancy(boolean b)(Code)
Set whether the user wants some graphical enhancements (image smileys, etc).
Parameters:
  b - true if the user wants graphical enhancements.



setShowImages
public void setShowImages(boolean b)(Code)
Set whether the user wants attached images to be shown inlined in the messages.
Parameters:
  b - true if images are to be shown inline



setSignature
public void setSignature(String s)(Code)
Set the signature that should be appended to composed messages.
Parameters:
  s - String containing the signature



setTheme
public void setTheme(String theme)(Code)
Change the theme for this user.
Parameters:
  theme - name of the theme



wantsBreakLines
public boolean wantsBreakLines()(Code)
Check whether the user wants to force line breaks. If this is set to true, lines in composed and shown messages are smartly broken at the configured positions.
See Also:    getMaxLineLength()



wantsSaveSent
public boolean wantsSaveSent()(Code)
Check whether the user wants to save sent messages or not. The folder where sent messages will be stored has to be configured also.
See Also:    getSentFolder()
See Also:    setSentFolder()



wantsSetFlags
public boolean wantsSetFlags()(Code)
Check whether write mode is enabled on mailboxes. This influences many things like setting message flags, copying/moving messages, deleting messages and the like.
See Also:    net.wastl.webmail.server.WebMailSession.getMessage()
See Also:    net.wastl.webmail.server.WebMailSession.copyMoveMessage()
See Also:    net.wastl.webmail.server.WebMailSession.setFlags()



wantsShowFancy
public boolean wantsShowFancy()(Code)
Check whether the user wants some graphical enhancements (image smileys, etc).



wantsShowImages
public boolean wantsShowImages()(Code)
Check whether the user wants attached images to be shown inlined in the messages or not. true, if the user wants images to be shown inline



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.