com.funambol.email.console.ws
Class EmailWS

java.lang.Object
  extended by com.funambol.email.console.ws.EmailWS

public class EmailWS
extends java.lang.Object


Field Summary
protected  com.funambol.framework.logging.FunambolLogger log
           
protected  ConsoleManager manager
           
 
Constructor Summary
EmailWS()
           
 
Method Summary
 int checkAccount(MailServerAccount msa)
          check the account on the mail server
 int deletePubMailServer(java.lang.String mailServerId)
          delete mail server
 int deleteUser(java.lang.String accountID)
          delete userId
 int disableUser(java.lang.String accountID)
          disable account
 int enableUser(java.lang.String accountID)
          enable account
 SyncItemInfoAdmin[] getCachedInfo(java.lang.String username, java.lang.String protocol)
          get the cached info for the specified username
 MailServer getPubMailServerFromID(java.lang.String mailServerId)
          get public mail server
 MailServer[] getPubMailServers(java.lang.String clauses)
          get public mail servers
 MailServerAccount getUser(java.lang.String username)
          get user
 MailServerAccount getUserFromID(java.lang.String accountID)
          get user
 MailServerAccount[] getUsers(java.lang.String clauses)
          get users in the filter
 int insertPubMailServer(MailServer pms)
          insert public mail server configuration
 int insertUser(MailServerAccount msa)
          insert user and the mail server configuration
 int updatePubMailServer(MailServer pms)
          update public mail server
 int updateUser(MailServerAccount msa)
          update user regarding the mail server connection
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

protected com.funambol.framework.logging.FunambolLogger log

manager

protected ConsoleManager manager
Constructor Detail

EmailWS

public EmailWS()
Method Detail

getUsers

public MailServerAccount[] getUsers(java.lang.String clauses)
                             throws com.funambol.framework.server.error.ServerException,
                                    EntityException
get users in the filter

Parameters:
clauses - String
Returns:
list with all the user in the filter ArrayList
Throws:
EntityException
com.funambol.framework.server.error.ServerException

getCachedInfo

public SyncItemInfoAdmin[] getCachedInfo(java.lang.String username,
                                         java.lang.String protocol)
                                  throws com.funambol.framework.server.error.ServerException,
                                         EntityException
get the cached info for the specified username

Parameters:
username - String
protocol - String
Returns:
array qith all the info
Throws:
EntityException
com.funambol.framework.server.error.ServerException

getPubMailServers

public MailServer[] getPubMailServers(java.lang.String clauses)
                               throws com.funambol.framework.server.error.ServerException,
                                      EntityException
get public mail servers

Returns:
list with all the mail server in the filter ArrayList
Throws:
EntityException
com.funambol.framework.server.error.ServerException

insertUser

public int insertUser(MailServerAccount msa)
               throws com.funambol.framework.server.error.ServerException,
                      EntityException
insert user and the mail server configuration

Parameters:
msa - MailServerAccount
Returns:
int
Throws:
EntityException
com.funambol.framework.server.error.ServerException

insertPubMailServer

public int insertPubMailServer(MailServer pms)
                        throws com.funambol.framework.server.error.ServerException,
                               EntityException
insert public mail server configuration

Parameters:
pms - MailServer
Returns:
int
Throws:
ServerException, - EntityException
com.funambol.framework.server.error.ServerException
EntityException

updatePubMailServer

public int updatePubMailServer(MailServer pms)
                        throws com.funambol.framework.server.error.ServerException,
                               EntityException
update public mail server

Parameters:
pms - MailServer
Returns:
int
Throws:
ServerException, - EntityException
com.funambol.framework.server.error.ServerException
EntityException

updateUser

public int updateUser(MailServerAccount msa)
               throws com.funambol.framework.server.error.ServerException,
                      EntityException
update user regarding the mail server connection

Parameters:
msa - MailServerAccount
Returns:
int
Throws:
EntityException
com.funambol.framework.server.error.ServerException

deleteUser

public int deleteUser(java.lang.String accountID)
               throws com.funambol.framework.server.error.ServerException,
                      EntityException
delete userId

Parameters:
accountID - String
Returns:
int
Throws:
ServerException, - EntityException
com.funambol.framework.server.error.ServerException
EntityException

disableUser

public int disableUser(java.lang.String accountID)
                throws com.funambol.framework.server.error.ServerException,
                       EntityException
disable account

Parameters:
accountID - String
Returns:
int
Throws:
ServerException, - EntityException
com.funambol.framework.server.error.ServerException
EntityException

enableUser

public int enableUser(java.lang.String accountID)
               throws com.funambol.framework.server.error.ServerException,
                      EntityException
enable account

Parameters:
accountID - String
Returns:
int
Throws:
ServerException, - EntityException
com.funambol.framework.server.error.ServerException
EntityException

deletePubMailServer

public int deletePubMailServer(java.lang.String mailServerId)
                        throws com.funambol.framework.server.error.ServerException,
                               EntityException
delete mail server

Parameters:
mailServerId - String
Returns:
int
Throws:
EntityException
com.funambol.framework.server.error.ServerException

getUser

public MailServerAccount getUser(java.lang.String username)
                          throws com.funambol.framework.server.error.ServerException,
                                 EntityException
get user

Parameters:
username - String
Returns:
all the info about the user and the related mail server MailServerAccount
Throws:
ServerException, - EntityException
com.funambol.framework.server.error.ServerException
EntityException

getUserFromID

public MailServerAccount getUserFromID(java.lang.String accountID)
                                throws com.funambol.framework.server.error.ServerException,
                                       EntityException
get user

Parameters:
accountID - String
Returns:
all the info about the user and the related mail server MailServerAccount
Throws:
ServerException, - EntityException
com.funambol.framework.server.error.ServerException
EntityException

getPubMailServerFromID

public MailServer getPubMailServerFromID(java.lang.String mailServerId)
                                  throws com.funambol.framework.server.error.ServerException,
                                         EntityException
get public mail server

Parameters:
mailServerId - String
Returns:
all the info about the public mail server MailServer
Throws:
ServerException, - EntityException
com.funambol.framework.server.error.ServerException
EntityException

checkAccount

public int checkAccount(MailServerAccount msa)
                 throws com.funambol.framework.server.error.ServerException,
                        EntityException
check the account on the mail server

Parameters:
msa - MailServerAccount
Returns:
true if the account is authenticated
Throws:
EntityException
com.funambol.framework.server.error.ServerException


Copyright © 2005-2006 Funambol.