svcDomainAdmin
This web service handles all functions dealing with domains.
The following operations are supported. For a formal definition, please review the Service Description.
-
AddDomain
Creates a new domain on the server. -
AddDomainEx
Creates a new domain using the system's default domain settings. -
AddDomainForwardingBlock
Adds a domain forwarding block. -
DeleteDomain
Deletes the specified domain, optionally removing data files. -
DeleteDomainForwardBlockByTargetAddress
Deletes a domain forwarding block by the target IP Address. -
DeleteDomainForwardingBlock
Deletes a domain forwarding block. -
DisableDomain
Disables a specific domain in SmarterMail. -
EnableDomain
Re-enables a specific domain in SmarterMail. -
GenerateDKIMCert
Generates a DKIM certificate for a domain. - GenerateDomainKeysCert
-
GetAllDomainAliases
Returns all domain aliases -
GetAllDomainAliasesWithProperties
Returns all domain aliases with specific properties -
GetAllDomainStatistics
Returns the statistics for all domains over the specified period of time. -
GetAllDomainUsersWithProperties
Returns all domain aliases with specific properties -
GetAllDomains
Returns a list of all domain names -
GetAllDomainsWithProperties
Returns a list of domains with property set -
GetDKIMCert
Retrieves the DKIM certificate for a domain. -
GetDomainCounts
Returns the usage counts for the specified domain. -
GetDomainDefaults
Returns the default domain settings in a DomainSettingsResult object -
GetDomainForwarding
Returns the domain forwarding configuration. -
GetDomainForwardingBlock
Returns information about a specific domain forwarding block. -
GetDomainForwardingBlockByTargetAddress
Returns information about a specific domain forwarding block given a target IP. -
GetDomainInfo
Retrieves the name and path of a domain. -
GetDomainInfo2
Retrieves the name and path of a domain. - GetDomainKeysCert
-
GetDomainSettings
Returns the settings for a specific domain. -
GetDomainStatistics
Returns the statistics for the specified domain over a period of time. -
GetDomainUsers
Returns all valid usernames for the domain, including users, aliases, and mailing lists. -
GetPrimaryDomainAdmin
Retrieves information about the primary domain administrator for the specified domain. -
GetRequestedDomainDefaults
Returns the requested default domain settings -
GetRequestedDomainSettings
Gets the settings for the specified domain. -
ReloadDomain
Reloads the settings for the specified domain from disk. -
RenameDomain
Renames the specified domain in SmarterMail. Also updates the physical domain data path on the hard drive. -
SetDomainArchiveRule
Adds a request item to be migrated to a specified mailbox. -
SetDomainForwardingBlock
Updates the target address and domains in a specific domain forwarding block. -
SetDomainForwardingBlockByTargetAddress
Updates the domains in a domain forwarding block forwarding to a specific target IP. -
SetPrimaryDomainAdmin
Sets the specified user to be the primary domain admin of the specified domain. -
SetRequestedDomainDefaults
Updates the default settings for domains. -
SetRequestedDomainSettings
Updates the settings for a specified domain. -
UpdateDomain
Updates the settings for the specified domain. -
UpdateDomainNameAndPath
Changes the specified domain's name and path. Data is not copied or moved. This must be done prior to calling this method. The recommendation is to disable the domain, copy the data, call this function, then re-enable the domain. Once it is confirmed that the domain is operating correctly, delete the old path.
This web service is using http://tempuri.org/ as its default namespace.
Recommendation: Change the default namespace before the XML Web service is made public.
Each XML Web service needs a unique namespace in order for client applications to distinguish it from other services on the Web. http://tempuri.org/ is available for XML Web services that are under development, but published XML Web services should use a more permanent namespace.
Your XML Web service should be identified by a namespace that you control. For example, you can use your company's Internet domain name as part of the namespace. Although many XML Web service namespaces look like URLs, they need not point to actual resources on the Web. (XML Web service namespaces are URIs.)
For XML Web services creating using ASP.NET, the default namespace can be changed using the WebService attribute's Namespace property. The WebService attribute is an attribute applied to the class that contains the XML Web service methods. Below is a code example that sets the namespace to "http://microsoft.com/webservices/":
C#
[WebService(Namespace="http://microsoft.com/webservices/")]
public class MyWebService {
// implementation
}
Visual Basic
<WebService(Namespace:="http://microsoft.com/webservices/")> Public Class MyWebService
' implementation
End Class
C++
[WebService(Namespace="http://microsoft.com/webservices/")]
public ref class MyWebService {
// implementation
};
For more details on XML namespaces, see the W3C recommendation on Namespaces in XML.
For more details on WSDL, see the WSDL Specification.
For more details on URIs, see RFC 2396.