In the sections that follow, you will find a brief explanation of the available Web services, along with the paths to call
each one.
Specific details on how to call each function through SOAP or POST requests can be found by using your web browser to load
an individual web service URL directly, then browsing to the function you are interested in exploring.
Note that some Web service functions may have several numbered forms (ex. AddSite, AddSite2, AddSite3). These are so named
to ensure backwards compatibility with legacy systems. For new development, SmarterTools recommends using the highest numbered
version.
Available Services
- svcAliasAdmin
- This web service handles all functions dealing with user aliases.
- svcDomainAdmin
- This web service handles all functions dealing with domains.
- svcDomainAliasAdmin
- This web service handles all functions dealing with domain aliases.
- svcGlobalUpdate
- This web service allows for changing settings across all domains.
- svcMailListAdmin
- This web service handles all functions dealing with mailing lists.
- svcProductInfo
- This web service handles all functions dealing with product information and license activation. Typically, these functions would be used for automated deployment.
- svcServerAdmin
- This web service modifies global settings and control for the server
- svcSpamAdmin
- This web service contains functions that modify spam settings.
- svcUserAdmin
- This web service contains functions that add, modify, and delete users.
svcAliasAdmin
http://misterplywood.com.au/Services/svcAliasAdmin.asmx
This web service handles all functions dealing with user aliases.
AddAlias
Creates a new alias and adds it to the specified domain.
Returns: GenericResult
DeleteAlias
Deletes the specified alias.
Returns: GenericResult
GetAlias
Returns details about the specified alias.
Returns: AliasInfoResult
GetAliases
Returns all aliases that belong to the specified domain.
Returns: AliasInfoListResult
SetCatchAll
Sets the specified alias to be the catch-all, or clears the catch-all if a blank alias name is provided.
Returns: GenericResult
UpdateAlias
Updates the addresses of the specified alias.
Returns: GenericResult
svcDomainAdmin
http://misterplywood.com.au/Services/svcDomainAdmin.asmx
This web service handles all functions dealing with domains.
AddDomain
Creates a new domain on the server.
Returns: GenericResult
AddDomainEx
Creates a new domain using the system's default domain settings.
Returns: GenericResult
AddDomainForwardingBlock
Adds a domain forwarding block.
Returns: GenericResult
DeleteDomain
Deletes the specified domain, optionally removing data files.
Returns: GenericResult
DeleteDomainForwardBlockByTargetAddress
Deletes a domain forwarding block by the target IP Address.
Returns: GenericResult
DeleteDomainForwardingBlock
Deletes a domain forwarding block.
Returns: GenericResult
DisableDomain
Disables a specific domain in SmarterMail.
Returns: GenericResult
EnableDomain
Re-enables a specific domain in SmarterMail.
Returns: GenericResult
GenerateDomainKeysCert
Generates a DomainKeys certificate for a domain.
Returns: DomainKeyResult
GetAllDomainAliases
Returns all domain aliases.
Returns: DomainAliasInfoResult
GetAllDomains
Returns a list of all domain names.
Returns: DomainListResult
GetAllDomainStatistics
Returns the statistics for all domains over the specified period of time.
Returns: AllDomainStatResult
GetDomainCounts
Returns the usage counts for the specified domain.
Returns: DomainCountInfoResult
GetDomainDefaults
Returns the default domain settings in a DomainSettingsResult object.
Returns: DomainSettingsResult
GetDomainForwarding
Returns the domain forwarding configuration.
Returns: DomainForwardInfoResult
GetDomainForwardingBlock
Returns information about a specific domain forwarding block.
Returns: DomainForwardBlockInfoResult
GetDomainForwardingBlockByTargetAddress
Returns information about a specific domain forwarding block given a target IP.
Returns: DomainForwardBlockInfoResult
GetDomainInfo
Retrieves the name and path of a domain.
Returns: DomainInfoResult
GetDomainKeysCert
Retrieves the DomainKeys certificate for a domain.
Returns: DomainKeyResult
GetDomainSettings
Returns the settings for a specific domain.
Returns: DomainSettingsResult
GetDomainStatistics
Returns the statistics for the specified domain over a period of time.
Returns: StatInfoResult
GetDomainUsers
Returns all valid usernames for the domain, including users, aliases, and mailing lists.
Returns: DomainUserInfoResult
GetPrimaryDomainAdmin
Retrieves information about the primary domain administrator for the specified domain.
Returns: PrimaryDomainAdminResult
GetRequestedDomainDefaults
Returns the requested default domain settings.
Returns: SettingsRequestResult
GetRequestedDomainSettings
Gets the settings for the specified domain.
Returns: SettingsRequestResult
ReloadDomain
Reloads the settings for the specified domain from disk.
Returns: GenericResult
RenameDomain
Renames the specified domain in SmarterMail. Also updates the physical domain data path on the hard drive.
Returns: GenericResult
SetDomainArchiveRule
Adds a request item to be migrated to a specified mailbox.
Returns: SettingsRequestResult
SetDomainForwardingBlock
Updates the target address and domains in a specific domain forwarding block.
Returns: GenericResult
SetDomainForwardingBlockByTargetAddress
Updates the domains in a domain forwarding block forwarding to a specific target IP.
Returns: GenericResult
SetPrimaryDomainAdmin
Sets the specified user to be the primary domain admin of the specified domain.
Returns: GenericResult
SetRequestedDomainDefaults
Updates the default settings for domains.
Returns: GenericResult
SetRequestedDomainSettings
Updates the settings for a specified domain.
Returns: GenericResult
UpdateDomain
Updates the settings for the specified domain.
Returns: GenericResult
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.
Returns: GenericResult
svcDomainAliasAdmin
http://misterplywood.com.au/Services/svcDomainAliasAdmin.asmx
This web service handles all functions dealing with domain aliases.
AddDomainAlias
Creates a new domain alias and adds it to the specified domain.
Returns: GenericResult
AddDomainAliasWithoutMxCheck
Creates a new domain alias and adds it to the specified domain. This function bypasses the MX check that ensures that the proper DNS entries have been setup.
Returns: GenericResult
DeleteDomainAlias
Deletes the specified domain alias from SmarterMail.
Returns: GenericResult
GetAliases
Returns all domain aliases that point to the specified domain.
Returns: DomainAliasInfoListResult
svcGlobalUpdate
http://misterplywood.com.au/Services/svcGlobalUpdate.asmx
This web service allows for changing settings across all domains.
GetGlobalUpdateStatus
Gets the current status of the update, indicating how many domains have been updated so far.
Returns: GlobalUpdateStatusResult
ListGlobalUpdateFields
Lists all the fields that can be updated using UpdateAllDomainSettings.
Returns: GlobalUpdateFieldListResult
UpdateAllDomainSettings
Sets the supplied fields and values for all domains on the server.
Returns: GenericResult
svcMailListAdmin
http://misterplywood.com.au/Services/svcMailListAdmin.asmx
This web service handles all functions dealing with mailing lists.
AddDigestSubscriber
Adds a digest subscriber to the specified list.
Returns: GenericResult
AddList
Adds a mailing list to the specified domain.
Returns: GenericResult
AddSubscriber
Adds a subscriber to the specified list.
Returns: GenericResult
AddSubscriber2
Adds subscribers for the given list.
Returns: GenericResult
DeleteAllLists
Deletes all mailing lists that belong to the specified domain.
Returns: GenericResult
DeleteList
Deletes a specific mailing list that belongs to a domain.
Returns: GenericResult
GetDigestSubscriberList
Returns the digest subscribers for the given list.
Returns: SubscriberListResult
GetListCommandAddress
Gets the command list address for the specified domain.
Returns: ListCommandResult
GetMailingListsByDomain
Returns all mailing lists for the specified domain.
Returns: MailingListResult
GetPosterKillList
Returns the kill list (blocked posters) the given list.
Returns: SubscriberListResult
GetPosterWhiteList
Returns the poster whitelist for the given list.
Returns: SubscriberListResult
GetRequestedListSettings
Gets specific settings for the specified list.
Returns: SettingsRequestResult
GetSubscriberList
Returns the subscribers for the given list.
Returns: SubscriberListResult
RemoveDigestSubscriber
Removes a digest subscriber to the specified list.
Returns: GenericResult
RemoveSubscriber
Removes a subscriber to the specified list.
Returns: GenericResult
SetDigestSubscriberList
Sets the digest subscribers for the given list.
Returns: GenericResult
SetListCommandAddress
Sets the command list address for the specified domain.
Returns: GenericResult
SetPosterKillList
Sets the kill list (blocked posters) for the given list.
Returns: GenericResult
SetPosterWhiteList
Sets the poster whitelist for the given list.
Returns: GenericResult
SetRequestedListSettings
Sets specific settings for the specified list.
Returns: GenericResult
SetSubscriberList
Sets the subscribers for the given list.
Returns: GenericResult
SetSubscriberList2
Sets the subscribers for the given list.
Returns: GenericResult
svcProductInfo
http://misterplywood.com.au/Services/svcProductInfo.asmx
This web service handles all functions dealing with product information and license activation. Typically, these functions would be used for automated deployment.
ActivateLicenseKey
Activates the product with the license key set using SetLicenseKey previously.
Returns: GenericResult
GetLicenseInfo
Returns the license key for the installation.
Returns: LicenseInfoResult
GetProductInfo
Returns the product name and version for the installation.
Returns: ProductInfoResult
SetLicenseKey
Sets the product license key for the installation. Note that you will need to call ActivateLicenseKey afterwards to enable the licence.
Returns: GenericResult
svcServerAdmin
http://misterplywood.com.au/Services/svcServerAdmin.asmx
This web service modifies global settings and control for the server.
AddDOSAbuseDetectionRule
Adds a denial of service (DOS) abuse detection rule to the server.
Returns: GenericResult
AddFolderAutocleanRule
Adds a server level auto-clean rule to the server.
Returns: GenericResult
AddForwardingBlacklistEntry
Adds a forwarding blacklist entry to the server.
Returns: GenericResult
AddGateway
Adds a non-SmarterMail outgoing gateway to SmarterMail. If your gateway is running SmarterMail, use AddSmarterMailGateway instead.
Returns: GenericResult
AddGlobalTrustedSender
Adds a new globally trusted sender.
Returns: GenericResult
AddGreylistingFilter
Adds a new greylisting filter.
Returns: GenericResult
AddHarvestingAbuseDetectionRule
Adds a harvesting abuse detection rule to the server.
Returns: GenericResult
AddHostname
Adds a hostname to the server.
Returns: GenericResult
AddIncomingGateway
Adds a new incoming gateway configuration.
Returns: GenericResult
AddInternalSpammerNotificationAbuseDetectionRule
Adds an internal spammer notification abuse detection rule.
Returns: GenericResult
AddIPRestrictionToSystemAdmin
Adds an IP address or IP range restriction to a system administrator login.
Returns: GenericResult
AddServerPort
Adds a port to the server.
Returns: AddServerPortResult
AddSmarterMailGateway
Adds a SmarterMail outgoing gateway to SmarterMail. If your gateway is NOT running SmarterMail, use AddGateway instead.
Returns: GenericResult
AddSmtpAuthenticationBypass
Adds a new SMTP authentication bypass rule. Pass either an IP Address or a range, not both.
Returns: GenericResult
AddSMTPBlockedSender
Adds a new SMTP blocked sender.
Returns: GenericResult
AddSpamAssassinServer
Adds a remote SpamAssassin server configuration.
Returns: GenericResult
AddSystemAdmin
Adds a new system administrator.
Returns: GenericResult
AssignPortToIP
Assigns a port to an IP address.
Returns: GenericResult
DeleteAbuseDetectionRule
Deletes an abuse detection rule.
Returns: GenericResult
DeleteFolderAutoCleanRule
Removes a server level auto-clean rule from the server.
Returns: GenericResult
DeleteForwardingBlacklistEntry
Remove a forwarding blacklist entry from the server.
Returns: GenericResult
DeleteGlobalTrustedSender
Deletes a globally trusted sender.
Returns: GenericResult
DeleteGreylistingFilter
Removes a greylisting filter.
Returns: GenericResult
DeleteHostname
Removes a hostname from the server.
Returns: GenericResult
DeleteServerPort
Deletes a port from the server.
Returns: GenericResult
DeleteSmtpAuthenticationBypass
Deletes an SMTP authentication bypass rule. Pass either an IP Address or a range, not both.
Returns: GenericResult
DeleteSpamAssassinServer
Deletes a remote SpamAssassin server configuration.
Returns: GenericResult
DeleteSystemAdmin
Removes a system administrator.
Returns: GenericResult
GetBlacklistEntries
Returns the currently configured blacklist entries.
Returns: BlacklistListResult
GetDOSAbuseDetectionRules
Returns the current DOS detection rules on the server.
Returns: DOSAbuseDetectionRulesListResult
GetEdition
Returns the operational licensing mode that SmarterMail is running under.
Returns: EditionResult
GetGateway
Returns information about a particular outgoing gateway.
Returns: GatewayResult
GetGlobalTrustedSenders
Returns a list of all current globally trusted senders.
Returns: TrustedSenderListResult
GetHarvestingAbuseDetectionRules
Returns the current harvesting detection rules on the server.
Returns: HarvestingAbuseDetectionRulesListResult
GetIncomingGateway
Retrieves information about a specific incoming gateway.
Returns: IncomingGatewayResult
GetInternalSpammerNotificationAbuseDetectionRules
Returns the current internal spamer detection rules on the server.
Returns: InternalSpammerNotificationAbuseDetectionRulesListResult
GetRequestedSystemSettings
Retrieves the value of the requested system settings.
Returns: RequestSettingsResult
GetSmtpAuthenticationBypasses
Returns a list of the currently configured SMTP authentication bypass rules.
Returns: SMTPAuthBypassListResult
GetSMTPBlockedSenders
Returns a list of currently blocked SMTP senders.
Returns: SMTPBlockedSenderListResult
GetSpoolMessageCount
Returns the number of messages in the spool.
Returns: MessageCountResult
GetWhitelistEntries
Returns the currently configured whitelist entries.
Returns: WhitelistListResult
ListFolderAutoCleanRules
Returns a list of all server level auto-clean rules defined in SmarterMail.
Returns: FolderAutoCleanRuleListResult
ListForwardingBlacklistEntries
Returns all current forwarding blacklist entries.
Returns: ForwardingBlacklistRuleResult
ListGateways
Returns a list of all outgoing gateways for the server.
Returns: GatewayListResult
ListGreylistingFilters
Returns a list of all currently configured greylisting filters.
Returns: GreylistingFilterListResult
ListHostnames
Returns a list of all hostnames configured on the server.
Returns: HostnameListResult
ListIncomingGateways
Returns a list of all configured incoming gateways.
Returns: IncomingGatewayListResult
ListPortsAssignedToIP
Returns a list of ports currently bound to a specific IP Address.
Returns: ServerPortListResult
ListServerPorts
Lists all ports currently setup on the server.
Returns: ServerPortListResult
ListSpamAssassinServers
Returns a list of all currently configured remote SpamAssassin servers.
Returns: SpamAssassinServerListResult
ListSystemAdmins
Returns the current system administrators on the server.
Returns: SystemAdminListResult
RemoveGateway
Deletes an outgoing gateway from SmarterMail.
Returns: GenericResult
RemoveIncomingGateway
Deletes an incoming gateway configuration.
Returns: GenericResult
RemoveIPRestrictionFromSystemAdmin
Removes an IP address or IP range restriction from a system administrator login.
Returns: GenericResult
RemovePortFromIP
Removes a port assigned to an IP address.
Returns: GenericResult
RequestStatus
Returns information about the current status of the server.
Returns: RequestStatusResult
SetBlacklistEntry
Adds a new blacklist entry or edits an existing blacklist entry. Pass either an IP address or a range, not both.
Returns: GenericResult
SetRequestedSystemSettings
Sets the value of the requested system settings.
Returns: GenericResult
SetSystemAdminPassword
Sets the password of a system administrator.
Returns: GenericResult
SetWhitelistEntry
Adds a new whitelist entry or edits an existing whitelist entry. Pass either an IP address or a range, not both.
Returns: GenericResult
StartServices
Starts the specified services in SmarterMail.
Returns: GenericResult
StopServices
Stops the specified services in SmarterMail.
Returns: GenericResult
UpdateGateway
Updates the settings for a specific outgoing gateway.
Returns: GenericResult
UpdateIncomingGateway
Updates properties about a specific incoming gateway.
Returns: GenericResult
svcSpamAdmin
http://misterplywood.com.au/Services/svcSpamAdmin.asmx
This web service contains functions that modify spam settings.
AddRBL
Adds an RBL check.
Returns: GenericResult
EditRBL
Edits properties of an RBL check.
Returns: GenericResult
GetBayesianSettings
Returns settings for Bayesian Fitering.
Returns: GetBayesianSettingsResult
GetCommtouchSettings
Returns settings for Commtouch.
Returns: GetCommtouchSettingsResult
GetDecludeSettings
Returns settings for Declude integration.
Returns: GetDecludeSettingsResult
GetDKIMSettings
Returns settings for DKIM.
Returns: GetDomainKeysSettingsResult
GetDomainKeysSettings
Returns settings for DomainKeys.
Returns: GetDomainKeysSettingsResult
GetRBL
Returns details about an RBL check.
Returns: GetRBLResult
GetRemoteSASettings
Returns settings for Remote SpamAssassin.
Returns: GetRemoteSASettingsResult
GetReverseDNSSettings
Returns settings for Reverse DNS.
Returns: GetReverseDNSSettingsResult
GetSABPMSettings
Returns settings for SpamAssassin-based Pattern Matching.
Returns: GetSABPMSettingsResult
GetSPFSettings
Returns settings for SPF.
Returns: GetSPFSettingsResult
ListRBLs
Lists information about all RBL checks.
Returns: ListRBLsResult
ListSpamChecks
Lists information about all known spam checks, similar to the Antispam Administration page.
Returns: ListSpamChecksResult
RemoveRBL
Removes an RBL check.
Returns: GenericResult
SetBayesianSettings
Configures settings for Bayesian Filtering.
Returns: GenericResult
SetCommtouchSettings
Configures settings for Commtouch.
Returns: GenericResult
SetDecludeSettings
Configures settings for Declude integration.
Returns: GenericResult
SetDKIMSettings
Configures settings for DKIM.
Returns: GenericResult
SetDomainKeysSettings
Configures settings for DomainKeys.
Returns: GenericResult
SetRemoteSASettings
Configures settings for Remote SpamAssassin.
Returns: GenericResult
SetReverseDNSSettings
Configures settings for Reverse DNS.
Returns: GenericResult
SetSABPMSettings
Configures settings for SpamAssassin-based Pattern Matching.
Returns: GenericResult
SetSpamWizardLevel
Sets the spam checks and weights to predefined wizard levels.
Returns: GenericResult
SetSPFSettings
Configures settings for SPF.
Returns: GenericResult
svcUserAdmin
http://misterplywood.com.au/Services/svcUserAdmin.asmx
This web service contains functions that add, modify, and delete users.
AddRSSFeed
Add an RSS feed to the specified email address.
Returns: GenericResult
AddUser
OBSOLETE: AddUser2 should be used instead. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
AddUser2
Creates a new user and adds them to the specified domain.
Returns: GenericResult
AddUserGroup
Creates a new user group and adds it to the specified domain.
Returns: GenericResult
AuthenticateUser
Returns a true ResultCode if the user name, domain name, and password match.
Returns: GenericResult
DeleteRSSFeed
Deletes an RSS feed from the specified email address.
Returns: GenericResult
DeleteUser
Deletes the specified user from the specified domain.
Returns: GenericResult
GetInactiveUsers
Returns inactive users since the specified date.
Returns: InactiveUserResult
GetLastLoginTimes
Gets last login time.
Returns: LastLoginInfoResult
GetMigrationStatus
Returns the status of all migration requests.
Returns: StatusResults[]
GetRequestedUserSettings
Gets the specified user's settings.
Returns: SettingsRequestResult
GetUser
Returns attributes of the specified user.
Returns: UserInfoResult
GetUserAutoResponseInfo
Returns the forwarding info of the specified user.
Returns: UserAutoResponseResult
GetUserForwardingInfo
OBSOLETE: GetUserForwardingInfo2 should be used instead. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
GetUserForwardingInfo2
Returns the forwarding info of the specified user.
Returns: UserForwardingInfoResult2
GetUserGroup
Gets a user group in the specified domain with the given id.
Returns: UserGroupInfoResult
GetUserGroupsByDomain
Get all user groups in the specified domain.
Returns: UserGroupsResult
GetUserGroupsByUser
Get all user groups in the specified domain containing the give user.
Returns: UserGroupsResult
GetUserQuotas
Returns Current and Max disk space for each user of a domain.
Returns: QuotaInfoListResult
GetUsers
Returns attributes of each user in the specified domain.
Returns: UserInfoListResult
GetUserStats
Returns statistics of the specified user for the specified time period.
Returns: StatInfoResult
IsUserEnabledForActiveSync
Enables or disables ActiveSync for the specified user.
Returns: ActiveSyncEnabledResult
ListRSSFeeds
Lists all RSS feeds for the specified email address.
Returns: RSSFeedListResult
LoginValidated
Returns a LoginResult object with the LoginValidated field set to True if the specified username matches the specified password.
Returns: LoginResult
QueueMailBoxMigration
Adds a request item to be migrated to a specified mailbox.
Returns: RequestStatusResult
RemoveFromMigrationQueue
Removes an item by ID from the pending migration queue.
Returns: Void
RemoveUserGroup
Deletes a user group from the specified domain with the given id.
Returns: GenericResult
SetRequestedUserSettings
Updates the specified user's settings.
Returns: GenericResult
ToggleActiveSync
Enables or disables ActiveSync for the specified user.
Returns: GenericResult
UpdateUser
OBSOLETE: UpdateUser2 should be used instead. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
UpdateUser2
Updates the specified user's settings.
Returns: GenericResult
UpdateUserAutoResponseInfo
Updates the specified user's auto response settings.
Returns: GenericResult
UpdateUserForwardingInfo
OBSOLETE: UpdateUserForwardingInfo2 should be used instead. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
UpdateUserForwardingInfo2
Updates the specified user's forwarding settings (Multiple addresses).
Returns: GenericResult
UpdateUserGroup
Updates a user group in the specified domain with the given id.
Returns: GenericResult