com.psoft.hsphere.axis
Interface MSExchangeServices_PortType

All Superinterfaces:

java.rmi.Remote

public interface MSExchangeServices_PortType
extends java.rmi.Remote

Method Summary

void	addForward(AuthToken at, com.psoft.hsphere.axis.ResId rid, java.lang.String email) Enables the forward feature for the Business User
void	addPlan(AuthToken at, java.lang.String type) Adds a new plan into a list of available organization plans.
void	addProxyAddress(AuthToken at, com.psoft.hsphere.axis.ResId rid, com.psoft.hsphere.axis.ProxyAddr addr) Creates proxy address for the Business User
void	addSubscriber(AuthToken at, com.psoft.hsphere.axis.ResId distListId, com.psoft.hsphere.axis.ResId subscriberId) Adds a subscriber into the existing distribution list
com.psoft.hsphere.axis.ResId	addUser(AuthToken at, com.psoft.hsphere.axis.BUser user, java.lang.String password) Adds a Business User to the Organization
void	changeUserPassword(AuthToken at, com.psoft.hsphere.axis.ResId rid, java.lang.String password) Changes Business User's password
void	changeUserPlan(AuthToken at, com.psoft.hsphere.axis.ResId rid, java.lang.String planType) Changes plan type of Business User
void	createMXRecForDomain(AuthToken at, com.psoft.hsphere.axis.ResId domainId) Creates DNS zone and corresponding DNS MX record for the domain.
void	deleteForward(AuthToken at, com.psoft.hsphere.axis.ResId rid, java.lang.String email) Disables the forward feature for the Business User
void	deleteProxyAddress(AuthToken at, com.psoft.hsphere.axis.ResId rid, java.lang.String name, java.lang.String domainName) Removes proxy address
void	deleteUser(AuthToken at, com.psoft.hsphere.axis.ResId rid) Removes Business User from the Organization
void	delSubscriber(AuthToken at, com.psoft.hsphere.axis.ResId distListId, com.psoft.hsphere.axis.ResId subscriberId) Removes a subscriber from the distribution list
void	disablePublicFolder(AuthToken at) Disables public folder on the business organization
void	enablePublicFolder(AuthToken at) Enables public folder on the business organization
java.lang.String[]	getAvailablePlans(AuthToken at) Returns list of available plan types (base_mail, gold_mail, etc ...) for the organization.
java.lang.String	getDescription() Finds a Business User using unique user principal name.
java.lang.String	getDescription(AuthToken at) Returns organization description.
com.psoft.hsphere.axis.DistList	getDistrList(AuthToken at, com.psoft.hsphere.axis.ResId id) Returns DistList object that includes all Distribution list properties.
com.psoft.hsphere.axis.ResId[]	getDistrLists(AuthToken at) returns Distribution list IDs that are created under the Organization
com.psoft.hsphere.axis.SMTPDom	getDomain(AuthToken at, com.psoft.hsphere.axis.ResId domainId) Returns domain info stored in the SMTPDom object
com.psoft.hsphere.axis.ResId[]	getDomainList(AuthToken at) returns IDs of the domains that are created under the Organization
com.psoft.hsphere.axis.ResId	getDomainRidByName(AuthToken at, java.lang.String name) Finds an SMTP domain by domain name.
java.lang.String	getDomainRole(AuthToken at, com.psoft.hsphere.axis.ResId domainId) Returns domain role.
int	getMailStoreSize(AuthToken at) Gets mail store size
double	getMailStoreUsage(AuthToken at) Returns mail store usage of the organization.
com.psoft.hsphere.axis.MXInfo[]	getMXInfo(AuthToken at) Returns information about MX records created to support SMTPDomains.
java.lang.String[]	getNewAvailablePlans(AuthToken at) Returns the list of available plan types (base_mail, gold_mail etc ...) that can be added to the organization.
java.lang.String	getOrganizationName(AuthToken at)
com.psoft.hsphere.axis.MSExchangePlanSettings	getPlan(AuthToken at, java.lang.String type) Returns Hosted Exchange plan related properties
com.psoft.hsphere.axis.ResId	getPrimaryDomainName(AuthToken at) Returns primary domain ResId
java.lang.String	getPubFolderState(AuthToken at) Gets the public folder state.
int	getPublicFolderSize(AuthToken at) Gets the public folder size
java.lang.String	getServerName(AuthToken at) Returns server name that is used to connect to the mail server (POP, SMTP,IMAP, etc...)
com.psoft.hsphere.axis.BUser	getUser(AuthToken at, com.psoft.hsphere.axis.ResId rid) Returns BUser object that contains set of Business User properties
com.psoft.hsphere.axis.ResId[]	getUsers(AuthToken at) Returns the list of ResId's of users (Business Users) registered under the organization.
void	removeMXRecForDomain(AuthToken at, com.psoft.hsphere.axis.ResId domainId) Removes DNS zone and MX record created before for the specified SMTP domain.
java.lang.String	resIdtoString(com.psoft.hsphere.axis.ResId id)
void	setDomainPrimary(AuthToken at, com.psoft.hsphere.axis.ResId domainId) Sets specified domain as a primary domain.
void	setMailStoreSize(AuthToken at, int size) Sets mail store size
void	setPublicFolderSize(AuthToken at, int size) Sets public folder size
void	setStoreAndForward(AuthToken at, com.psoft.hsphere.axis.ResId rid, boolean state) Enables/Disables the Store and Forward property for the Business User
void	setUserAdminPrivilege(AuthToken at, com.psoft.hsphere.axis.ResId rid, boolean state) Sets/Resets the Business User's "admin" property
void	setUserParams(AuthToken at, com.psoft.hsphere.axis.BUser u) Updates Busines User properties specified in the BUser object
void	updateManagedBy(AuthToken at, com.psoft.hsphere.axis.ResId distListId, java.lang.String managedBy) Sets the "managed by" property of the distribution list

Method Detail

getDomain

com.psoft.hsphere.axis.SMTPDom getDomain(AuthToken at,
                                         com.psoft.hsphere.axis.ResId domainId)
                                         throws java.rmi.RemoteException

Returns domain info stored in the SMTPDom object

Parameters:

at - H-Sphere account authentication information

domainId - ResId of the Domain

Returns:

Throws:

java.lang.Exception

java.rmi.RemoteException

getDescription

java.lang.String getDescription()
                                throws java.rmi.RemoteException

Finds a Business User using unique user principal name.

Parameters:

at - H-Sphere account authentication information

name - Unique user principal name

Returns:

Unique Business User ResourceId registered in the H-Sphere database.

Throws:

java.lang.Exception

java.rmi.RemoteException

getDescription

java.lang.String getDescription(AuthToken at)
                                throws java.rmi.RemoteException

Returns organization description.

Parameters:

at - H-Sphere account authentication information

Returns:

Business organization Account Description

Throws:

java.lang.Exception

java.rmi.RemoteException

getServerName

java.lang.String getServerName(AuthToken at)
                               throws java.rmi.RemoteException

Returns server name that is used to connect to the mail server (POP, SMTP,IMAP, etc...)

Parameters:

at - H-Sphere account authentication information

Returns:

Server name that is used in the connection settings for the following protocols: Outlook Web Access Server, Incoming (POP3) Mail Server, Outgoing (SMTP) Mail Server, Incoming (IMAP) Mail Server, RPC Server

Throws:

java.lang.Exception

java.rmi.RemoteException

getUser

com.psoft.hsphere.axis.BUser getUser(AuthToken at,
                                     com.psoft.hsphere.axis.ResId rid)
                                     throws java.rmi.RemoteException

Returns BUser object that contains set of Business User properties

Parameters:

at - H-Sphere account authentication information

rid - ResId of the Business User

Returns:

Throws:

java.rmi.RemoteException

getPlan

com.psoft.hsphere.axis.MSExchangePlanSettings getPlan(AuthToken at,
                                                      java.lang.String type)
                                                      throws java.rmi.RemoteException

Returns Hosted Exchange plan related properties

Parameters:

at - H-Sphere account authentication information

type - Plan type that is specified in msExchangePlans.xml. For example: base_mail, gold_mail, etc ...

Returns:

MSExchangePlanSettings This class includes all information about MSExchange plan settings and features.

Throws:

java.lang.Exception

java.rmi.RemoteException

getDomainRidByName

com.psoft.hsphere.axis.ResId getDomainRidByName(AuthToken at,
                                                java.lang.String name)
                                                throws java.rmi.RemoteException

Finds an SMTP domain by domain name.

Parameters:

at - H-Sphere account authentication information

name - Domain Name

Returns:

Unique domain ResId registered in the H-Sphere database.

Throws:

java.lang.Exception

java.rmi.RemoteException

getUsers

com.psoft.hsphere.axis.ResId[] getUsers(AuthToken at)
                                        throws java.rmi.RemoteException

Returns the list of ResId's of users (Business Users) registered under the organization.

Parameters:

at - H-Sphere account authentication information

Returns:

User ID list

Throws:

java.rmi.RemoteException

deleteUser

void deleteUser(AuthToken at,
                com.psoft.hsphere.axis.ResId rid)
                throws java.rmi.RemoteException

Removes Business User from the Organization

Parameters:

at - H-Sphere account authentication information

rid - ResId of the Business User that should be removed.

Throws:

java.lang.Exception

java.rmi.RemoteException

addSubscriber

void addSubscriber(AuthToken at,
                   com.psoft.hsphere.axis.ResId distListId,
                   com.psoft.hsphere.axis.ResId subscriberId)
                   throws java.rmi.RemoteException

Adds a subscriber into the existing distribution list

Parameters:

at - H-Sphere account authentication information

distListId - ResId of the Distribution list

subscriberId - ResId of the subscriber (Business User)

Throws:

java.lang.Exception

java.rmi.RemoteException

setStoreAndForward

void setStoreAndForward(AuthToken at,
                        com.psoft.hsphere.axis.ResId rid,
                        boolean state)
                        throws java.rmi.RemoteException

Enables/Disables the Store and Forward property for the Business User

Parameters:

at - H-Sphere account authentication information

rid - ResId of the Business User

state - "true" value will force method to enable "Store and forward"

Throws:

java.lang.Exception

java.rmi.RemoteException

addUser

com.psoft.hsphere.axis.ResId addUser(AuthToken at,
                                     com.psoft.hsphere.axis.BUser user,
                                     java.lang.String password)
                                     throws java.rmi.RemoteException

Adds a Business User to the Organization

Parameters:

at - H-Sphere account authentication information

user - BUser object with all the necessary Business User properties.

password - Password that will be used to register the Business User in the MPS.

Returns:

ResId of created user

Throws:

java.lang.Exception

java.rmi.RemoteException

setDomainPrimary

void setDomainPrimary(AuthToken at,
                      com.psoft.hsphere.axis.ResId domainId)
                      throws java.rmi.RemoteException

Sets specified domain as a primary domain.

Parameters:

at - H-Sphere account authentication information

domain - ID SMTP domain resource ID that should be set as a primary domain.

Throws:

java.lang.Exception

java.rmi.RemoteException

getDomainRole

java.lang.String getDomainRole(AuthToken at,
                               com.psoft.hsphere.axis.ResId domainId)
                               throws java.rmi.RemoteException

Returns domain role. It can be: 1 - primary; 2 - secondary; 3 - vanity;

Parameters:

at - H-Sphere account authentication information

domainId - SMTP domain ResId.

Returns:

Throws:

java.lang.Exception

java.rmi.RemoteException

addPlan

void addPlan(AuthToken at,
             java.lang.String type)
             throws java.rmi.RemoteException

Adds a new plan into a list of available organization plans.

Parameters:

at - H-Sphere account authentication information

type - Plan type that is specified in msExchangePlans.xml. For example base_mail, gold_mail etc ...

Throws:

java.lang.Exception

java.rmi.RemoteException

getAvailablePlans

java.lang.String[] getAvailablePlans(AuthToken at)
                                     throws java.rmi.RemoteException

Returns list of available plan types (base_mail, gold_mail, etc ...) for the organization.

Parameters:

at - H-Sphere account authentication information

Returns:

list of available plan types.

Throws:

java.rmi.RemoteException

getOrganizationName

java.lang.String getOrganizationName(AuthToken at)
                                     throws java.rmi.RemoteException

Parameters:

at - H-Sphere account authentication information

Returns:

Organization name (the same as the H-Sphere account login)

Throws:

java.lang.Exception

java.rmi.RemoteException

getPrimaryDomainName

com.psoft.hsphere.axis.ResId getPrimaryDomainName(AuthToken at)
                                                  throws java.rmi.RemoteException

Returns primary domain ResId

Parameters:

at - H-Sphere account authentication information

Returns:

primary domain ResId

Throws:

java.lang.Exception

java.rmi.RemoteException

getMailStoreUsage

double getMailStoreUsage(AuthToken at)
                         throws java.rmi.RemoteException

Returns mail store usage of the organization.

Parameters:

at - H-Sphere account authentication information

Returns:

Mail Store Usage in MB

Throws:

java.lang.Exception

java.rmi.RemoteException

getNewAvailablePlans

java.lang.String[] getNewAvailablePlans(AuthToken at)
                                        throws java.rmi.RemoteException

Returns the list of available plan types (base_mail, gold_mail etc ...) that can be added to the organization.

Parameters:

at - H-Sphere account authentication information

Returns:

list of available plan types.

Throws:

java.rmi.RemoteException

setUserAdminPrivilege

void setUserAdminPrivilege(AuthToken at,
                           com.psoft.hsphere.axis.ResId rid,
                           boolean state)
                           throws java.rmi.RemoteException

Sets/Resets the Business User's "admin" property

Parameters:

at - H-Sphere account authentication information

rid - ResId of the Business User

state - true value will enable adnim privilegie

Throws:

java.lang.Exception

java.rmi.RemoteException

setUserParams

void setUserParams(AuthToken at,
                   com.psoft.hsphere.axis.BUser u)
                   throws java.rmi.RemoteException

Updates Busines User properties specified in the BUser object

Parameters:

at - H-Sphere account authentication information

u - Busines User properties specified in the BUser object

Throws:

java.lang.Exception

java.rmi.RemoteException

changeUserPlan

void changeUserPlan(AuthToken at,
                    com.psoft.hsphere.axis.ResId rid,
                    java.lang.String planType)
                    throws java.rmi.RemoteException

Changes plan type of Business User

Parameters:

at - H-Sphere account authentication information

rid - ResId of the Business User

planType - plan type name. Plan type names list can be received using getAvailablePlans(AuthToken at) method

Throws:

java.lang.Exception

java.rmi.RemoteException

changeUserPassword

void changeUserPassword(AuthToken at,
                        com.psoft.hsphere.axis.ResId rid,
                        java.lang.String password)
                        throws java.rmi.RemoteException

Changes Business User's password

Parameters:

at - H-Sphere account authentication information

rid - ResId of the Business User

password - Business User password

Throws:

java.lang.Exception

java.rmi.RemoteException

addProxyAddress

void addProxyAddress(AuthToken at,
                     com.psoft.hsphere.axis.ResId rid,
                     com.psoft.hsphere.axis.ProxyAddr addr)
                     throws java.rmi.RemoteException

Creates proxy address for the Business User

Parameters:

at - H-Sphere account authentication information

ResId - of the Business User

addr - ProxyAddr object that specifies proxy address properties

Throws:

java.lang.Exception

java.rmi.RemoteException

deleteProxyAddress

void deleteProxyAddress(AuthToken at,
                        com.psoft.hsphere.axis.ResId rid,
                        java.lang.String name,
                        java.lang.String domainName)
                        throws java.rmi.RemoteException

Removes proxy address

Parameters:

at - H-Sphere account authentication information

rid - ResId of the Business User

name - part of proxy address that contains user name. For example, for the address name@test.com you need to specify "name"

domainName - part of proxy address that contains domain name. For example, for the address name@test.com you need to specify "test.com"

Throws:

java.lang.Exception

java.rmi.RemoteException

addForward

void addForward(AuthToken at,
                com.psoft.hsphere.axis.ResId rid,
                java.lang.String email)
                throws java.rmi.RemoteException

Enables the forward feature for the Business User

Parameters:

at - H-Sphere account authentication information

rid - ResId of the Business User

email - Email address that will be used to forward an email.

Throws:

java.lang.Exception

java.rmi.RemoteException

deleteForward

void deleteForward(AuthToken at,
                   com.psoft.hsphere.axis.ResId rid,
                   java.lang.String email)
                   throws java.rmi.RemoteException

Disables the forward feature for the Business User

Parameters:

at - H-Sphere account authentication information

rid - ResId of the Business User

email - Email address that is used to forward an email.

Throws:

java.lang.Exception

java.rmi.RemoteException

getDistrLists

com.psoft.hsphere.axis.ResId[] getDistrLists(AuthToken at)
                                             throws java.rmi.RemoteException

returns Distribution list IDs that are created under the Organization

Parameters:

at - H-Sphere account authentication information

Returns:

Distribution list IDs (ResId array) that are created under the Organization

Throws:

java.lang.Exception

java.rmi.RemoteException

getDistrList

com.psoft.hsphere.axis.DistList getDistrList(AuthToken at,
                                             com.psoft.hsphere.axis.ResId id)
                                             throws java.rmi.RemoteException

Returns DistList object that includes all Distribution list properties.

Parameters:

at - H-Sphere account authentication information

id - ResId of the Distribution List

Returns:

DistList object that includes all Distribution list properties.

Throws:

java.lang.Exception

java.rmi.RemoteException

delSubscriber

void delSubscriber(AuthToken at,
                   com.psoft.hsphere.axis.ResId distListId,
                   com.psoft.hsphere.axis.ResId subscriberId)
                   throws java.rmi.RemoteException

Removes a subscriber from the distribution list

Parameters:

at - H-Sphere account authentication information

distListId - ResId of the Distribution list

subscriberId - ResId of the subscriber (Business User)

Throws:

java.lang.Exception

java.rmi.RemoteException

updateManagedBy

void updateManagedBy(AuthToken at,
                     com.psoft.hsphere.axis.ResId distListId,
                     java.lang.String managedBy)
                     throws java.rmi.RemoteException

Sets the "managed by" property of the distribution list

Parameters:

at - H-Sphere account authentication information

distListId - ResourceId of the Distribution list

managedBy - principalName of the Business User

Throws:

java.lang.Exception

java.rmi.RemoteException

getMailStoreSize

int getMailStoreSize(AuthToken at)
                     throws java.rmi.RemoteException

Gets mail store size

Parameters:

at - H-Sphere account authentication information

Returns:

mail store size in Megabytes

Throws:

java.lang.Exception

java.rmi.RemoteException

setMailStoreSize

void setMailStoreSize(AuthToken at,
                      int size)
                      throws java.rmi.RemoteException

Sets mail store size

Parameters:

at - H-Sphere account authentication information

size - mail store size in Megabytes

Throws:

java.lang.Exception

java.rmi.RemoteException

setPublicFolderSize

void setPublicFolderSize(AuthToken at,
                         int size)
                         throws java.rmi.RemoteException

Sets public folder size

Parameters:

at - H-Sphere account authentication information

size - Public Folder size in megabytes

Throws:

java.lang.Exception

java.rmi.RemoteException

getPublicFolderSize

int getPublicFolderSize(AuthToken at)
                        throws java.rmi.RemoteException

Gets the public folder size

Parameters:

at - H-Sphere account authentication information

Returns:

public folder size in megabytes.

Throws:

java.lang.Exception

java.rmi.RemoteException

getPubFolderState

java.lang.String getPubFolderState(AuthToken at)
                                   throws java.rmi.RemoteException

Gets the public folder state. It can be "ENABLED", "DISABLED" or "NOT AVAILABLE". The "NOT AVAILABLE" state will be returned if the "public_folder" resource is unavailable in the plan.

Parameters:

at - H-Sphere account authentication information

Returns:

public folder state

Throws:

java.lang.Exception

java.rmi.RemoteException

enablePublicFolder

void enablePublicFolder(AuthToken at)
                        throws java.rmi.RemoteException

Enables public folder on the business organization

Parameters:

at - H-Sphere account authentication information

Throws:

java.lang.Exception

java.rmi.RemoteException

disablePublicFolder

void disablePublicFolder(AuthToken at)
                         throws java.rmi.RemoteException

Disables public folder on the business organization

Parameters:

at - H-Sphere account authentication information

Throws:

java.lang.Exception

java.rmi.RemoteException

getDomainList

com.psoft.hsphere.axis.ResId[] getDomainList(AuthToken at)
                                             throws java.rmi.RemoteException

returns IDs of the domains that are created under the Organization

Parameters:

at - H-Sphere account authentication information

Returns:

IDs of the domains that are created under the Organization

Throws:

java.lang.Exception

java.rmi.RemoteException

getMXInfo

com.psoft.hsphere.axis.MXInfo[] getMXInfo(AuthToken at)
                                          throws java.rmi.RemoteException

Returns information about MX records created to support SMTPDomains.

Parameters:

at - H-Sphere account authentication information

Returns:

Array of MXInfo object that represents all the necessary information about MX record

Throws:

java.lang.Exception

java.rmi.RemoteException

createMXRecForDomain

void createMXRecForDomain(AuthToken at,
                          com.psoft.hsphere.axis.ResId domainId)
                          throws java.rmi.RemoteException

Creates DNS zone and corresponding DNS MX record for the domain.

Parameters:

at - H-Sphere account authentication information

domainId - ResId of the SMTP Domain

Throws:

java.lang.Exception

java.rmi.RemoteException

removeMXRecForDomain

void removeMXRecForDomain(AuthToken at,
                          com.psoft.hsphere.axis.ResId domainId)
                          throws java.rmi.RemoteException

Removes DNS zone and MX record created before for the specified SMTP domain.

Parameters:

at - H-Sphere account authentication information

domainId - ResId of the SMTP Domain

Throws:

java.lang.Exception

java.rmi.RemoteException

resIdtoString

java.lang.String resIdtoString(com.psoft.hsphere.axis.ResId id)
                               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException