svcServerAdmin
This web service modifies global settings and control for the server
The following operations are supported. For a formal definition, please review the Service Description.
-
AddAbuseDetectionRule
Adds an abuse detection rule -
AddDOSAbuseDetectionRule
Adds a denial of service (DOS) abuse detection rule to the server -
AddFolderAutocleanRule
Adds a server level auto-clean rule to the server -
AddForwardingBlacklistEntry
Adds a forwarding blacklist entry to the server -
AddGateway
Adds a non-SmarterMail outgoing gateway to SmarterMail. If your gateway is running SmarterMail, use AddSmarterMailGateway instead. -
AddGlobalTrustedSender
Adds a new globally trusted sender -
AddGreylistingFilter
Adds a new greylisting filter -
AddHarvestingAbuseDetectionRule
Adds a harvesting abuse detection rule to the server -
AddHostname
Adds a hostname to the server -
AddIPRestrictionToSystemAdmin
Adds an IP address or IP range restriction to a system administrator login -
AddIncomingGateway
Adds a new incoming gateway configuration -
AddInternalSpammerNotificationAbuseDetectionRule
Adds an internal spammer notification abuse detection rule -
AddReservedDomainNames
Adds reserved domain names to the current list of reserved domain names -
AddSMTPBlockedSender
Adds a new SMTP blocked sender -
AddServerPort
Adds a port to the server -
AddSmarterMailGateway
Adds a SmarterMail outgoing gateway to SmarterMail. If your gateway is NOT running SmarterMail, use AddGateway instead. -
AddSmtpAuthenticationBypass
Adds a new SMTP authentication bypass rule. Pass either an IP Address or a range, not both. -
AddSpamAssassinServer
Adds a remote SpamAssassin server configuration. -
AddSystemAdmin
Adds a new system administrator -
AssignPortToIP
Assigns a port to an IP address -
DeleteAbuseDetectionRule
Deletes an abuse detection rule -
DeleteFolderAutoCleanRule
Removes a server level auto-clean rule from the server -
DeleteForwardingBlacklistEntry
Remove a forwarding blacklist entry from the server -
DeleteGlobalTrustedSender
Deletes a globally trusted sender -
DeleteGreylistingFilter
Removes a greylisting filter -
DeleteHostname
Removes a hostname from the server -
DeleteServerPort
Deletes a port from the server -
DeleteSmtpAuthenticationBypass
Deletes an SMTP authentication bypass rule. Pass either an IP Address or a range, not both. -
DeleteSpamAssassinServer
Deletes a remote SpamAssassin server configuration. -
DeleteSystemAdmin
Removes a system administrator -
GetAbuseDetectionRules
Return the current abuse detection rules on the server -
GetBlacklistEntries
Returns the currently configured blacklist entries -
GetBouncesAbuseDetectionRules
Returns the current bounce detection rules on the server -
GetBruteForceAbuseDetectionRules
Returns the current brute force rules on the server -
GetDOSAbuseDetectionRules
Returns the current DOS detection rules on the server -
GetEdition
Returns the operational licensing mode that SmarterMail is running under -
GetGateway
Returns information about a particular outgoing gateway -
GetGlobalTrustedSenders
Returns a list of all current globally trusted senders -
GetHarvestingAbuseDetectionRules
Returns the current harvesting detection rules on the server -
GetIncomingGateway
Retrieves information about a specific incoming gateway -
GetInternalSpammerNotificationAbuseDetectionRules
Returns the current internal spamer detection rules on the server -
GetRequestedSystemSettings
Retrieves the value of the requested system settings -
GetReservedDomainNames
Returns a list of reserved domain names -
GetSMTPBlockedSenders
Returns a list of currently blocked SMTP senders -
GetSmtpAuthenticationBypasses
Returns a list of the currently configured SMTP authentication bypass rules -
GetSpoolMessageCount
Returns the number of messages in the spool. -
GetWhitelistEntries
Returns the currently configured whitelist entries -
GetWhitelistEntries2
Returns the currently configured whitelist entries -
ListFolderAutoCleanRules
Returns a list of all server level auto-clean rules defined in SmarterMail -
ListForwardingBlacklistEntries
Returns all current forwarding blacklist entries -
ListGateways
Returns a list of all outgoing gateways for the server -
ListGreylistingFilters
Returns a list of all currently configured greylisting filters -
ListHostnames
Returns a list of all hostnames configured on the server -
ListIncomingGateways
Returns a list of all configured incoming gateways -
ListPortsAssignedToIP
Returns a list of ports currently bound to a specific IP Address. -
ListServerPorts
Lists all ports currently setup on the server -
ListSpamAssassinServers
Returns a list of all currently configured remote SpamAssassin servers. -
ListSystemAdmins
Returns the current system administrators on the server -
RemoveGateway
Deletes an outgoing gateway from SmarterMail -
RemoveIPRestrictionFromSystemAdmin
Removes an IP address or IP range restriction from a system administrator login -
RemoveIncomingGateway
Deletes an incoming gateway configuration -
RemovePortFromIP
Removes a port assigned to an IP address -
RemoveReservedDomainNames
Removes reserved domain names from the current list of reserved domain names -
RequestStatus
Returns information about the current status of the server -
SetBlacklistEntry
Adds a new blacklist entry or edits an existing blacklist entry. Pass either an IP address or a range, not both. To remove an entry set all protocols to false. -
SetRequestedSystemSettings
Sets the value of the requested system settings -
SetReservedDomainNames
Sets the list of reserved domain names -
SetSystemAdminPassword
Sets the password of a system administrator -
SetWhitelistEntry
Adds a new whitelist entry or edits an existing whitelist entry. Pass either an IP address or a range, not both. To remove an entry set all protocols to false. -
SetWhitelistEntry2
Adds a new whitelist entry or edits an existing whitelist entry. Pass either an IP address or a range, not both. To remove an entry set all protocols to false. -
StartServices
Starts the specified services in SmarterMail -
StopServices
Stops the specified services in SmarterMail -
UpdateAbuseDetectionRule
Updates an abuse detection rule -
UpdateGateway
Updates the settings for a specific outgoing gateway -
UpdateIncomingGateway
Updates properties about a specific incoming gateway
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.