Java Doc for HMailServer.java in » Groupware » ivatagroupware » com » ivata » groupware » business » mail » 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

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL 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 » Groupware » ivatagroupware » com.ivata.groupware.business.mail.server

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

com.ivata.groupware.business.mail.server .JavaMailServer

com.ivata.groupware.business.mail.server .HMailServer

HMailServer

public class HMailServer extends JavaMailServer implements MailServer(Code)

On Microsoft Windows platforms, we recommend you use the open source hMailServer. This class provides an interface to that system.

Note: this code indirectly uses Microsoft COM and will only work on Microsoft Windows. For UNIX Systems, use the com.ivata.groupware.business.mail.server.ScriptMailServerScriptMailServer .

This version of the code has been tested to work with hMailServer versions 3.x and 4.x.

since:
   ivata groupware 0.10 (2005-02-21)
author:
   Colin MacLeod
author:
   colin.macleod@ivata.com
version:
   $Revision: 1.9 $

Constructor Summary
public	HMailServer(String domainNameParam, AddressBook addressBook, Settings settings) Constructor.

Method Summary
public void	addUser(SecuritySession securitySession, String userNameParam, String fullNameParam)
public boolean	checkPassword(SecuritySession securitySession, String userNameParam, String passwordParam) Refer to . Parameters: securitySession - Parameters: userNameParam - Parameters: passwordParam - throws: SystemException - If the password doesn't match, or there isa technical problem communicating with hMailServer.
public static IDispatch	getDomains() Get all the domains of the mail server.
public String	getSystemUserName(SecuritySession securitySession, String userNameParam) On hMailServer, the system user name is the user followed by the 'at sign' and the domain name.
public List	getUserAliases(SecuritySession securitySession, String userNameParam)
public String	getUserForwarding(SecuritySession securitySession, String userNameParam) Parameters: securitySession - Parameters: userNameParam - Never returns.
public String	getUserNameFromSystemUserName(SecuritySession securitySession, String systemUserNameParam) Returns the username, the part before the 'at sign' in the system user name.
public String	getVacationMessage(SecuritySession securitySession, String userNameParam)
public boolean	isUser(SecuritySession securitySession, String userNameParam)
public static void	main(String[] args) Simple test routine, to check this class is working on Windows.
public void	removeList(SecuritySession securitySession, String nameParam)
public void	removeUser(SecuritySession securitySession, String userNameParam)
public void	setList(SecuritySession securitySession, String nameParam, Collection usersParam)
public void	setPassword(SecuritySession securitySession, String userNameParam, String passwordParam)
public void	setUserAliases(SecuritySession securitySession, String userNameParam, Collection aliasesParam)
public void	setUserForwarding(SecuritySession securitySession, String userNameParam, String addressParam)
public void	setVacationMessage(SecuritySession securitySession, String userNameParam, String messageParam)

Constructor Detail

HMailServer
public HMailServer(String domainNameParam, AddressBook addressBook, Settings settings)(Code)
	Constructor. Create a connection to hMailServer. Parameters: domainNameParam - hMailServer domain name. Parameters: addressBook - Parameters: settings -

Method Detail

addUser
public void addUser(SecuritySession securitySession, String userNameParam, String fullNameParam) throws SystemException(Code)
	Parameters: securitySession - Parameters: userNameParam - Parameters: fullNameParam - throws: SystemException - If the user already exists.

checkPassword
public boolean checkPassword(SecuritySession securitySession, String userNameParam, String passwordParam) throws SystemException(Code)
	Refer to . Parameters: securitySession - Parameters: userNameParam - Parameters: passwordParam - throws: SystemException - If the password doesn't match, or there isa technical problem communicating with hMailServer.

getDomains
public static IDispatch getDomains() throws SystemException(Code)
	Get all the domains of the mail server. Returns the mail server domains. throws: SystemException - If the domains cannot be retrieved for anyreason.

getSystemUserName
public String getSystemUserName(SecuritySession securitySession, String userNameParam)(Code)
	On hMailServer, the system user name is the user followed by the 'at sign' and the domain name. Parameters: securitySession - Parameters: userNameParam - always returns `userNameParam` followed by the atsign and the domain name.

getUserAliases
public List getUserAliases(SecuritySession securitySession, String userNameParam) throws SystemException(Code)
	Parameters: securitySession - Parameters: userNameParam - throws: SystemException - If there is a technical problem or the domainaliases cannot be retrieved.

getUserForwarding
public String getUserForwarding(SecuritySession securitySession, String userNameParam) throws SystemException(Code)
	Parameters: securitySession - Parameters: userNameParam - Never returns. This method has not been implemeneted and onlyever throws an exception. throws: SystemException - Always thrown as this method is not implementedfor hMailServer.

getUserNameFromSystemUserName
public String getUserNameFromSystemUserName(SecuritySession securitySession, String systemUserNameParam)(Code)
	Returns the username, the part before the 'at sign' in the system user name. Parameters: securitySession - Parameters: systemUserNameParam - always returns `systemUserNameParam` before 'at sign'.

getVacationMessage
public String getVacationMessage(SecuritySession securitySession, String userNameParam) throws SystemException(Code)
	Parameters: securitySession - Parameters: userNameParam - The vacation string for this user. throws: SystemException - If there is a technical problem or the domainaliases cannot be retrieved.

isUser
public boolean isUser(SecuritySession securitySession, String userNameParam) throws SystemException(Code)
	Parameters: securitySession - Parameters: userNameParam - `true` if the user exists. throws: SystemException - If there is a technical problem or the domainaliases cannot be retrieved.

main
public static void main(String[] args)(Code)
	Simple test routine, to check this class is working on Windows. Parameters: args - Program arguments - not used, in this program.

removeList
public void removeList(SecuritySession securitySession, String nameParam) throws SystemException(Code)
	Parameters: securitySession - Parameters: nameParam - throws: SystemException - Always thrown as this method is not implementedfor hMailServer.

removeUser
public void removeUser(SecuritySession securitySession, String userNameParam) throws SystemException(Code)
	Parameters: securitySession - Parameters: userNameParam - throws: SystemException - If there is a technical problem or the domainaliases cannot be retrieved.

setList
public void setList(SecuritySession securitySession, String nameParam, Collection usersParam) throws SystemException(Code)
	Parameters: securitySession - Parameters: nameParam - Parameters: usersParam - throws: SystemException - Always thrown as this method is not implementedfor hMailServer.

setPassword
public void setPassword(SecuritySession securitySession, String userNameParam, String passwordParam) throws SystemException(Code)
	Parameters: securitySession - Parameters: userNameParam - Parameters: passwordParam - throws: SystemException - If there is a technical problem or the domainaliases cannot be retrieved.

setUserAliases
public void setUserAliases(SecuritySession securitySession, String userNameParam, Collection aliasesParam) throws SystemException(Code)
	Parameters: securitySession - Parameters: userNameParam - Parameters: aliasesParam - throws: SystemException - If there is a technical problem or the domainaliases cannot be retrieved.

setUserForwarding
public void setUserForwarding(SecuritySession securitySession, String userNameParam, String addressParam) throws SystemException(Code)
	Parameters: securitySession - Parameters: userNameParam - Parameters: addressParam - throws: SystemException - Always thrown as this method is not implementedfor hMailServer.

setVacationMessage
public void setVacationMessage(SecuritySession securitySession, String userNameParam, String messageParam) throws SystemException(Code)
	Parameters: securitySession - Parameters: userNameParam - Parameters: messageParam - throws: SystemException - If there is a technical problem or the domainaliases cannot be retrieved.

Methods inherited from com.ivata.groupware.business.mail.server.JavaMailServer

public boolean checkPassword(SecuritySession securitySession, String userName, String password) throws SystemException(Code)(Java Doc)
public Store connectStore(MailSession mailSession) throws SystemException(Code)(Java Doc)
public Folder getFolder(SecuritySession securitySession, Store store, String name) throws SystemException(Code)(Java Doc)
public boolean hasNewMessages(SecuritySession securitySession, String userName, String folderName) throws SystemException(Code)(Java Doc)
public SecuritySession login(UserDO user, String password) throws SystemException(Code)(Java Doc)
public SecuritySession loginGuest() throws SystemException(Code)(Java Doc)

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.