Web Services Documentation

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://www.mpwkitchens.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.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe full name of the domain.
AliasNameStringThe name of the alias to add.
AddressesString[]A list of email addresses that this alias resolves to.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteAlias

Deletes the specified alias.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe full name of the domain.
AliasNameStringThe name of the alias.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetAlias

Returns details about the specified alias.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe full name of the domain.
AliasNameStringThe name of the alias.

Returns: AliasInfoResult

AliasInfoResultDescription
AliasInfoAliasInfoDetails about the alias, as defined in the AliasInfo class.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
AliasInfoDescription
AddressesString[]A list of email addresses that the alias resolves to.
NameStringThe name of the alias.

GetAliases

Returns all aliases that belong to the specified domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe full name of the domain.

Returns: AliasInfoListResult

AliasInfoListResultDescription
AliasInfosAliasInfo[]A list of alias details, as defined in the AliasInfo class.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
AliasInfoDescription
AddressesString[]A list of email addresses that the alias resolves to.
NameStringThe name of the alias.

SetCatchAll

Sets the specified alias to be the catch-all, or clears the catch-all if a blank alias name is provided.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe full name of the domain.
AliasNameStringThe name of the alias.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

UpdateAlias

Updates the addresses of the specified alias.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe full name of the domain.
AliasNameStringThe name of the alias to modify.
AddressesString[]The new list of email addresses that this alias resolves to.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

svcDomainAdmin

http://www.mpwkitchens.com.au/Services/svcDomainAdmin.asmx

This web service handles all functions dealing with domains.

AddDomain

Creates a new domain on the server.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain name to add, in the format 'example.com'.
PathStringThe full path of the location in which the domain data should be stored.
PrimaryDomainAdminUserNameStringThe username for the domain administrator.
PrimaryDomainAdminPasswordStringThe password for the domain administrator.
PrimaryDomainAdminFirstNameStringThe first name for the domain administrator.
PrimaryDomainAdminLastNameStringThe last name for the domain administrator.
IPStringThe IP Address on which the domain should listen.
ImapPortInt32The port number on which the domain should accept IMAP connections.
PopPortInt32The port number on which the domain should accept POP connections.
SmtpPortInt32The port number on which the domain should accept SMTP connections.
MaxAliasesInt32The maximum number of user aliases the domain is allowed to have. Pass 0 for unlimited.
MaxDomainSizeInMBInt32The maximum disk space the domain is allowed to occupy. Pass 0 for unlimited.
MaxDomainUsersInt32The maximum number of users the domain is allowed to have. Pass 0 for unlimited.
MaxMailboxSizeInMBInt32This parameter is no longer used.
MaxMessageSizeInt32The maximum size a message can be on the domain. Pass 0 for unlimited.
MaxRecipientsInt32The maximum number of recipients a message can contain on the domain. Pass 0 for unlimited.
MaxDomainAliasesInt32The maximum number of domain aliases that can be assigned to the domain. Pass 0 for unlimited.
MaxListsInt32The maximum number of mailing lists the domain is allowed to have. Pass 0 for unlimited.
ShowDomainAliasMenuBooleanTrue to allow domain administrators to modify domain aliases.
ShowContentFilteringMenuBooleanTrue to allow users to manage content filtering settings.
ShowSpamMenuBooleanTrue to allow users to manage their own spam settings.
ShowStatsMenuBooleanThis parameter is no longer used.
RequireSmtpAuthenticationBooleanTrue to require SMTP Authentication when relaying email.
ShowListMenuBooleanTrue to allow domain administrators to manage mailing lists.
ListCommandAddressStringThe username of the 'list command address.' This is usually a value such as stserv or listserv.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddDomainEx

Creates a new domain using the system's default domain settings.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain name to add, in the format 'example.com'.
PathStringThe full path of the location in which the domain data should be stored.
PrimaryDomainAdminUserNameStringThe username for the domain administrator.
PrimaryDomainAdminPasswordStringThe password for the domain administrator.
PrimaryDomainAdminFirstNameStringThe first name for the domain administrator.
PrimaryDomainAdminLastNameStringThe last name for the domain administrator.
IPStringThe IP Address on which the domain should listen.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddDomainForwardingBlock

Adds a domain forwarding block.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
targetAddressStringThe IP Address that will receive mail for the specified domains.
domainsString[]An array that specifies the domain names to forward.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteDomain

Deletes the specified domain, optionally removing data files.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain to delete.
DeleteFilesBooleanTrue to permanently delete all email and configuration data for the domain.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteDomainForwardBlockByTargetAddress

Deletes a domain forwarding block by the target IP Address.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
targetAddressStringThe IP Address of the target for the block you wish to delete.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteDomainForwardingBlock

Deletes a domain forwarding block.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
blockIDInt32The numeric ID of the forwarding block to delete.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DisableDomain

Disables a specific domain in SmarterMail.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
domainNameStringThe domain name to modify.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

EnableDomain

Re-enables a specific domain in SmarterMail.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
domainNameStringThe domain name to modify.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GenerateDomainKeysCert

Generates a DomainKeys certificate for a domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain.
KeySizeInt32Size of the certificate key, in bits. Possible values are:
  • 512
  • 768
  • 1024
  • 1536
  • 2048
selectorStringDomainKeys selector to use.

Returns: DomainKeyResult

DomainKeyResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
privateKeyStringThe private key.
publicKeyStringThe public key.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
selectorStringThe DomainKeys selector.

GetAllDomainAliases

Returns all domain aliases.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: DomainAliasInfoResult

DomainAliasInfoResultDescription
DomainAliasesDomainAliasInfo[]A list of domain alias info records, as defined in the DomainAliasInfo class.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
DomainAliasInfoDescription
DomainNameStringThe domain name to which the alias points.
NameStringThe name of the alias.

GetAllDomains

Returns a list of all domain names.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: DomainListResult

DomainListResultDescription
DomainNamesString[]An array of domain names.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetAllDomainStatistics

Returns the statistics for all domains over the specified period of time.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
StartDateDateTimeThe start point of the date range to return.
EndDateDateTimeThe end point of the date range to return.

Returns: AllDomainStatResult

AllDomainStatResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
StatsDomainStatInfo[]A list of statistic records for each domain, as defined in the the DomainStatInfo class.
DomainStatInfoDescription
BytesReceivedInt64The number of bytes received.
BytesSentInt64The number of bytes sent.
BytesSizeInt64The size of the domain on disk.
DomainNameStringThe name of the domain.
MessagesReceivedInt64The number of messages received.
MessagesSentInt64The number of messages sent.

GetDomainCounts

Returns the usage counts for the specified domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain for which counts should be received.

Returns: DomainCountInfoResult

DomainCountInfoResultDescription
AliasesInt32The number of user aliases.
MailingListsInt32The number of mailing lists.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
SizeInt64The disk size of the domain.
UsersInt32The number of users.

GetDomainDefaults

Returns the default domain settings in a DomainSettingsResult object.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: DomainSettingsResult

DomainSettingsResultDescription
ImapPortInt32The port on which the domain listens for IMAP connections.
ListCommandAddressStringThe username for mailing list commands.
MaxAliasesInt32The max number of user aliases for the domain (0=unlimited).
MaxDomainAliasesInt32The max number of domain aliases for the domain (0=unlimited).
MaxDomainSizeInMBInt32The max amount of disk space allowed to the domain (0=unlimited).
MaxDomainUsersInt32The max number of users for the domain (0=unlimited).
MaxListsInt32The max number of mailing lists for the domain (0=unlimited).
MaxMailboxSizeInMBInt32This value is no longer used.
MaxMessageSizeInt32The max size allowed per message (0=unlimited).
MaxRecipientsInt32The max number of receipients per message (0=unlimited).
MessageStringA text message explaining the results of the operation, including the reason for any failures.
PathStringThe physical path to the domain data files.
PopPortInt32The port on which the domain listens for POP connections.
RequireSmtpAuthenticationBooleanTrue if SMTP Authentication is required.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
ServerIPStringThe IP Address on which the domain listens.
ShowContentFilteringMenuBooleanTrue to allow domain users to set up content filters.
ShowDomainAliasMenuBooleanTrue to allow domain administrators to create domain aliases.
ShowListMenuBooleanTrue to allow domain administrators to modify mailing lists.
ShowSpamMenuBooleanTrue to allow domain users to modify spam settings.
ShowStatsMenuBooleanThis value is no longer used.
SmtpPortInt32The port on which the domain listens for SMTP connections.

GetDomainForwarding

Returns the domain forwarding configuration.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
includeDomainsBooleanTrue to include domains in the results. False to only include target addresses.

Returns: DomainForwardInfoResult

DomainForwardInfoResultDescription
blocksDomainForwardBlockInfo[]A list of details about the domain forward blocks, as defined in the DomainForwardBlockInfo class.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
DomainForwardBlockInfoDescription
blockIDInt32The numeric ID of the block.
domainsString[]A list of domain names that will forward to the address in targetAddress.
targetAddressStringThe IP Address of the server that will receive the forwarded email.

GetDomainForwardingBlock

Returns information about a specific domain forwarding block.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
blockIDInt32The numeric ID of the forwarding block.

Returns: DomainForwardBlockInfoResult

DomainForwardBlockInfoResultDescription
domainForwardBlockDomainForwardBlockInfoDetails about the domain forward block, as defined in the DomainForwardBlockInfo class.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
DomainForwardBlockInfoDescription
blockIDInt32The numeric ID of the block.
domainsString[]A list of domain names that will forward to the address in targetAddress.
targetAddressStringThe IP Address of the server that will receive the forwarded email.

GetDomainForwardingBlockByTargetAddress

Returns information about a specific domain forwarding block given a target IP.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
targetAddressStringThe IP Address of the target of the block.

Returns: DomainForwardBlockInfoResult

DomainForwardBlockInfoResultDescription
domainForwardBlockDomainForwardBlockInfoDetails about the domain forward block, as defined in the DomainForwardBlockInfo class.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
DomainForwardBlockInfoDescription
blockIDInt32The numeric ID of the block.
domainsString[]A list of domain names that will forward to the address in targetAddress.
targetAddressStringThe IP Address of the server that will receive the forwarded email.

GetDomainInfo

Retrieves the name and path of a domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
domainNameStringThe name of the domain.

Returns: DomainInfoResult

DomainInfoResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
PathStringThe physical path to the domain files.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetDomainKeysCert

Retrieves the DomainKeys certificate for a domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain.

Returns: DomainKeyResult

DomainKeyResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
privateKeyStringThe private key.
publicKeyStringThe public key.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
selectorStringThe DomainKeys selector.

GetDomainSettings

Returns the settings for a specific domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
domainNameStringThe name of the domain.

Returns: DomainSettingsResult

DomainSettingsResultDescription
ImapPortInt32The port on which the domain listens for IMAP connections.
ListCommandAddressStringThe username for mailing list commands.
MaxAliasesInt32The max number of user aliases for the domain (0=unlimited).
MaxDomainAliasesInt32The max number of domain aliases for the domain (0=unlimited).
MaxDomainSizeInMBInt32The max amount of disk space allowed to the domain (0=unlimited).
MaxDomainUsersInt32The max number of users for the domain (0=unlimited).
MaxListsInt32The max number of mailing lists for the domain (0=unlimited).
MaxMailboxSizeInMBInt32This value is no longer used.
MaxMessageSizeInt32The max size allowed per message (0=unlimited).
MaxRecipientsInt32The max number of receipients per message (0=unlimited).
MessageStringA text message explaining the results of the operation, including the reason for any failures.
PathStringThe physical path to the domain data files.
PopPortInt32The port on which the domain listens for POP connections.
RequireSmtpAuthenticationBooleanTrue if SMTP Authentication is required.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
ServerIPStringThe IP Address on which the domain listens.
ShowContentFilteringMenuBooleanTrue to allow domain users to set up content filters.
ShowDomainAliasMenuBooleanTrue to allow domain administrators to create domain aliases.
ShowListMenuBooleanTrue to allow domain administrators to modify mailing lists.
ShowSpamMenuBooleanTrue to allow domain users to modify spam settings.
ShowStatsMenuBooleanThis value is no longer used.
SmtpPortInt32The port on which the domain listens for SMTP connections.

GetDomainStatistics

Returns the statistics for the specified domain over a period of time.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain.
StartDateDateTimeThe start point of the date range to return.
EndDateDateTimeThe end point of the date range to return.

Returns: StatInfoResult

StatInfoResultDescription
BytesReceivedInt64The number of bytes received.
BytesSentInt64The number of bytes sent.
BytesSizeInt64The size of the item on disk.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
MessagesReceivedInt64The number of messages received.
MessagesSentInt64The number of messages sent.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetDomainUsers

Returns all valid usernames for the domain, including users, aliases, and mailing lists.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain.

Returns: DomainUserInfoResult

DomainUserInfoResultDescription
CatchAllBooleanTrue if the domain has a catch-all.
DomainAliasesString[]An array of domain aliases associated to the domain.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
UsersString[]An array of users for the domain.

GetPrimaryDomainAdmin

Retrieves information about the primary domain administrator for the specified domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain.

Returns: PrimaryDomainAdminResult

PrimaryDomainAdminResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
PrimaryAdminStringThe username of the primary domain administrator.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetRequestedDomainDefaults

Returns the requested default domain settings.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
requestedSettingsString[]An array of strings that identify the settings to return. Possible values are:
  • defaultaltsmtpport - Alternate SMTP Port
  • defaultaltsmtpportenabled - Enable Alternate SMTP Port
  • defaultaltsmtpportenabled - Enable Alternate SMTP Port
  • defaultautoresponderrestriction - Limit autresponders tonce per day per sender
  • defaultbypassgreylisting - Bypass greylisting
  • defaultenablecatchalls - Enable Catch-alls
  • defaultenabledomainkeys - Enable Domain Keys signing
  • defaultenableemailreports - Enable Email Reports
  • defaultenablefilestorage - Enable File Storage
  • defaultenableimapretrieval - Enable IMAP Retrieval
  • defaultenablepopretrieval - Enable POP Retrieval
  • defaultimapport - IMAP Port
  • defaultldapport - LDAP Port
  • defaultmaxaliases - Maximum aliases, 0=unlimited
  • defaultmaxdomainaliases - Maximum domain aliases, 0=unlimited
  • defaultmaxdomainsize - Maximum domain size, 0=unlimited
  • defaultmaxdomainusers - Maximum users, 0=unlimited
  • defaultmaximapretrievalaccounts - Maximum IMAP retrieval accounts, 0=unlimited
  • defaultmaxlists - Maximum mailing lists, 0=unlimited
  • defaultmaxmailboxsize - Maximum mailbox size, 0=unlimited
  • defaultmaxmessagesize - Maximum message size, 0=unlimited
  • defaultmaxbouncesreceivedperhour - Maximum bounces allowed per hour
  • defaultmaxbouncesreceivedperhourenabled - Enable Max Bounces Throttling
  • defaultmaxbouncesreceivedperhouraction - Max Bounces Throttle Action: none, delay, reject
  • defaultmaxmessagesperhour - Maximum messages allowed per hour
  • defaultmaxmessagesperhourenabled - Enable Max Messages Throttling
  • defaultmaxmessagesperhouraction - Max Messages Throttle Action: none, delay, reject
  • defaultmaxsmtpoutbandwidthperhour - Maximum bandwidth usage allowed per hour (MB)
  • defaultmaxsmtpoutbandwidthperhourenabled - Enable Max Bandwidth Throttling
  • defaultmaxsmtpoutbandwidthperhouraction - Max Bandwidth Throttle Action: none, delay, reject
  • defaultmaxpopretrievalaccounts - Maximum POP retrieval accounts, 0=unlimited
  • defaultmaxrecipients - Maximum recipients per message, 0=unlimited
  • defaultpopport - POP Port
  • defaultsharedcalendar - Enable Shared Calendars
  • defaultsharedcontact - Enable Shared Contacts
  • defaultsharedfolder - Enable Shared Folders
  • defaultsharedgal - Enable Global Address List
  • defaultsharednotes - Enable Shared Notes
  • defaultsharedtasks - Enable Shared Tasks
  • defaultshowcalendar - Enable Calendaring
  • defaultshowcontacts - Enable Contacts
  • defaultshowcontentfilteringmenu - Enable Content Filters
  • defaultshowdomainaliasmenu - Enable Domain Aliases
  • defaultshowdomainreports - Enable Domain Reports
  • defaultshowlistmenu - Enable Mailing Lists
  • defaultshownotes - Enable Notes
  • defaultshowspammenu - Enable Spam Options
  • defaultshowtasks - Enable Tasks
  • defaultshowuserreports - Enable User Reports
  • defaultskin - Default Skin name
  • defaultsmtpauthenticationrequired - Require SMTP Auth
  • defaultsmtpport - SMTP Port
  • defaultspamresponderoption - Auto-responder spam restriction: none, low, medium, high
  • defaultspamforwardoption - Forward spam restriction: none, low, medium, high

Returns: SettingsRequestResult

SettingsRequestResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
settingValuesString[]An array of 'key=value' pairs containing the setting values.

GetRequestedDomainSettings

Gets the settings for the specified domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain.
requestedSettingsString[]An array of strings that identify the settings to return. Possible values are:
  • altsmtpport - Alternate SMTP port
  • altsmtpportenabled - Enable alternate SMTP port
  • autoresponderrestriction - Limit auto-responders tonce per day per sender
  • bypassgreylisting - Bypass greylisting
  • catchall - Name of the catch-all alias
  • domainurl - Logout URL
  • enablecatchalls - Enable catch-alls
  • enabledomainkeys - Enable Domain Keys signing
  • enabledomainuserservicecontrol - Enables control of Service Access Control
  • enablemailsigning - Enables Domain Keys and DKIM signing
  • enableemailreports - Enable email reports
  • enablepopretrieval - Enable POP retrieval
  • enableimapretrieval - Enable IMAP retrieval
  • imapport - IMAP port
  • isenabled - Domain enabled
  • ldapport - LDAP port
  • listcommandaddress - Listserv command address
  • maxaliases - Maximum aliases, 0=unlimited
  • maxdomainaliases - Maximum domain aliases, 0=unlimited
  • maximapretrievalaccounts - Maximum IMAP retrieval accounts, 0=unlimited
  • maxlists - Maximum mailing lists, 0=unlimited
  • maxmessagesize - Maximum message size, 0=unlimited
  • maxbouncesreceivedperhour - Maximum bounce messages received per hour
  • maxbouncesreceivedperhourenabled - Enable max bounce messages throttling
  • maxbouncesreceivedperhouraction - Max bounce messages throttling action: none, delay, reject
  • maxmessagesperhour - Maximum outgoing messages allowed per hour
  • maxmessagesperhourenabled - Enable max outgoing messages throttling
  • maxmessagesperhouraction - Max outgoing messages throttling action: none, delay, reject
  • maxsmtpoutbandwidthperhour - Maximum SMTP out bandwidth allowed per hour (MB)
  • maxsmtpoutbandwidthperhourenabled - Enable max bandwidth throttling
  • maxsmtpoutbandwidthperhouraction - Max bandwidth throttling action: none, delay, reject
  • maxrecipients - Maximum recipients per message, 0=unlimited
  • maxsize - Maximum domain size (KB), 0=unlimited
  • maxusers - Maximum users, 0=unlimited
  • popport - POP port
  • requiresmtpauthentication - Require SMTP authentication
  • serverip - IP address
  • sharedcalendar - Enable shared calendars
  • sharedcontact - Enable shared contacts
  • sharedfolder - Enable shared folders
  • sharednotes - Enable shared notes
  • sharedtasks - Enable shared tasks
  • sharedgal - Enable Global Address List
  • showcalendar - Enable calendaring
  • showcontacts - Enable contacts
  • showcontentfilteringmenu - Enable content filters
  • showdomainaliasmenu - Enable domain aliases
  • showdomainreports - Enable domain reports
  • shownotes - Enable notes
  • showuserreports - Enable user reports
  • showtasks - Enable tasks
  • showlistmenu - Enable mailing lists
  • showspammenu - Enable spam options
  • smtpport - SMTP port
  • spamresponderoption - Auto-responder spam restriction: none, low, medium, high
  • spamforwardoption - Forward spam restriction: none, low, medium, high

Returns: SettingsRequestResult

SettingsRequestResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
settingValuesString[]An array of 'key=value' pairs containing the setting values.

ReloadDomain

Reloads the settings for the specified domain from disk.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain to reload.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

RenameDomain

Renames the specified domain in SmarterMail. Also updates the physical domain data path on the hard drive.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
OldDomainNameStringThe name of the domain to modify.
NewDomainNameStringThe new name for the domain.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetDomainArchiveRule

Adds a request item to be migrated to a specified mailbox.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
parametersString[]A list of 'key=value' pairs defining the import parameters. Possible values are:
  • DOMAIN - Name of target domain
  • PATH - Destination path of archive.
  • RULE - ALL, INCOMING, OUTGOING, NONE

Returns: SettingsRequestResult

SettingsRequestResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
settingValuesString[]An array of 'key=value' pairs containing the setting values.

SetDomainForwardingBlock

Updates the target address and domains in a specific domain forwarding block.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
blockIDInt32The numeric ID of the forwarding block.
targetAddressStringThe new IP Address of the target of the block.
domainsString[]The new array of domain names that forward to the address in targetAddress.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetDomainForwardingBlockByTargetAddress

Updates the domains in a domain forwarding block forwarding to a specific target IP.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
targetAddressStringThe IP Address of the target of the block.
domainsString[]The new array of domain names that forward to the address in targetAddress.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetPrimaryDomainAdmin

Sets the specified user to be the primary domain admin of the specified domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain.
AdminUserNameStringThe name of the user that will be the new primary domain administrator. This user must already exist.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetRequestedDomainDefaults

Updates the default settings for domains.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
newSettingsString[]An array of 'key=value' pairs of settings to change. Key can be any of the items defined in the GetRequestedDomainDefaults function.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetRequestedDomainSettings

Updates the settings for a specified domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain to modify.
newSettingsString[]An array of 'key=value' pairs of settings to change. Key can be any of the items defined in the GetRequestedDomainSettings function.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

UpdateDomain

Updates the settings for the specified domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain to modify.
ServerIPStringThe IP Address on which the domain should listen.
ImapPortInt32The port that this domain will use for incoming IMAP connections.
PopPortInt32The port that this domain will use for incoming POP connections.
SmtpPortInt32The port that this domain will use for incoming SMTP connections.
MaxAliasesInt32The maximum number of user aliases the domain is allowed to have. Pass 0 for unlimited.
MaxDomainSizeInMBInt32The maximum disk space the domain is allowed to occupy. Pass 0 for unlimited.
MaxDomainUsersInt32The maximum number of users the domain is allowed to have. Pass 0 for unlimited.
MaxMailboxSizeInMBInt32This parameter is no longer used.
MaxMessageSizeInt32The maximum size a message can be on the domain. Pass 0 for unlimited.
MaxRecipientsInt32The maximum number of recipients a message can contain on the domain. Pass 0 for unlimited.
MaxDomainAliasesInt32The maximum number of domain aliases that can be assigned to the domain. Pass 0 for unlimited.
MaxListsInt32The maximum number of mailing lists the domain is allowed to have. Pass 0 for unlimited.
ShowDomainAliasMenuBooleanTrue to allow domain administrators to modify domain aliases.
ShowContentFilteringMenuBooleanTrue to allow users to manage content filtering settings.
ShowSpamMenuBooleanTrue to allow users to manage their own spam settings.
ShowStatsMenuBooleanThis parameter is no longer used.
RequireSmtpAuthenticationBooleanTrue to require SMTP Authentication when relaying email.
ShowListMenuBooleanTrue to allow domain administrators to manage mailing lists.
ListCommandAddressStringThe username of the 'list command address.' This is usually a value such as stserv or listserv.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

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.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
OldDomainNameStringThe name of the domain to modify.
NewDomainNameStringThe new name for the domain.
NewDomainPathStringThe new path to the domain data.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

svcDomainAliasAdmin

http://www.mpwkitchens.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.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain.
DomainAliasNameStringThe name of the domain alias to create.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

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.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain.
DomainAliasNameStringThe name of the domain alias to create.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteDomainAlias

Deletes the specified domain alias from SmarterMail.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain.
DomainAliasNameStringThe name of the domain alias to remove.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetAliases

Returns all domain aliases that point to the specified domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain.

Returns: DomainAliasInfoListResult

DomainAliasInfoListResultDescription
DomainAliasNamesString[]A list of domain names.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

svcGlobalUpdate

http://www.mpwkitchens.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.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: GlobalUpdateStatusResult

GlobalUpdateStatusResultDescription
finishedCountInt32The number of domain updates that have been completed.
isRunningBooleanTrue if a global update operation is in progress.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
totalUpdateCountInt32The number of domains that are being updated.

ListGlobalUpdateFields

Lists all the fields that can be updated using UpdateAllDomainSettings.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: GlobalUpdateFieldListResult

GlobalUpdateFieldListResultDescription
fieldsGlobalUpdateFieldInfoResult[]A list of fields that can be updated with the web service, as defined in the GlobalUpdateFieldInfo class.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
GlobalUpdateFieldInfoResultDescription
defaultValueStringThe default value for the field.
descriptionStringA description of what the field controls.
nameStringThe name of the field.
typeStringThe data type for the field.

UpdateAllDomainSettings

Sets the supplied fields and values for all domains on the server.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
fieldsDomainSettingFieldStruct[]A list of structures defining the settings and values to change on the domains, as defined in the DomainSettingFieldStruct class. A list of valid setting keys can be obtained by calling the ListGlobalUpdateFields function.
DomainSettingFieldStructDescription
nameStringThe name of the field.
valStringThe value of the field.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

svcMailListAdmin

http://www.mpwkitchens.com.au/Services/svcMailListAdmin.asmx

This web service handles all functions dealing with mailing lists.

AddDigestSubscriber

Adds a digest subscriber to the specified list.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe domain that contains the list.
ListNameStringThe name of the mailing list.
SubscriberStringThe email address of the digest subscriber to add.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddList

Adds a mailing list to the specified domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe domain that contains the list.
ListNameStringThe name of the mailing list.
ModeratorStringThe domain user that is the moderator of the list.
DescriptionStringA textual description for the list.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddSubscriber

Adds a subscriber to the specified list.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe domain that contains the list.
ListNameStringThe name of the mailing list.
SubscriberStringThe email address of the subscriber to add.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddSubscriber2

Adds subscribers for the given list.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameString
ListNameString
SubscribersString[]

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteAllLists

Deletes all mailing lists that belong to the specified domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain to modify.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteList

Deletes a specific mailing list that belongs to a domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe domain that contains the list.
ListNameStringThe name of the mailing list to delete.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetDigestSubscriberList

Returns the digest subscribers for the given list.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe domain that contains the list.
ListNameStringThe name of the mailing list.

Returns: SubscriberListResult

SubscriberListResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
SubscribersString[]A list of email addresses.

GetListCommandAddress

Gets the command list address for the specified domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain.

Returns: ListCommandResult

ListCommandResultDescription
commandAddressStringThe name of the list command address.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetMailingListsByDomain

Returns all mailing lists for the specified domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain.

Returns: MailingListResult

MailingListResultDescription
listNamesString[]A list of mailing list names.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetPosterKillList

Returns the kill list (blocked posters) the given list.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe domain that contains the list.
ListNameStringThe name of the mailing list.

Returns: SubscriberListResult

SubscriberListResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
SubscribersString[]A list of email addresses.

GetPosterWhiteList

Returns the poster whitelist for the given list.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe domain that contains the list.
ListNameStringThe name of the mailing list.

Returns: SubscriberListResult

SubscriberListResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
SubscribersString[]A list of email addresses.

GetRequestedListSettings

Gets specific settings for the specified list.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe domain that contains the list.
ListNameStringThe name of the mailing list.
requestedSettingsString[]A list of settings to retrieve for the list. Possible values are:
  • description
  • disabled
  • moderator
  • password
  • whocanpost (anyone, subscribersonly, moderatoronly)
  • subject (text tadd tsubject)
  • prependsubject (true/false)
  • maxmessagesize (in KB)
  • replytolist (true/false)
  • digestmode (true/false)
  • sendsubscribe (true/false)
  • sendunsubscribe (true/false)
  • allowunsubscribe (true/false)
  • disablelistcommand (true/false)
  • disablesubscribecommand (true/false)

Returns: SettingsRequestResult

SettingsRequestResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
settingValuesString[]A list of 'key=value' pairs that contain the values of settings. For a list of possible key names, refer to the GetRequestedListSettings function description.

GetSubscriberList

Returns the subscribers for the given list.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe domain that contains the list.
ListNameStringThe name of the mailing list.

Returns: SubscriberListResult

SubscriberListResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
SubscribersString[]A list of email addresses.

RemoveDigestSubscriber

Removes a digest subscriber to the specified list.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe domain that contains the list.
ListNameStringThe name of the mailing list.
SubscriberStringThe email address of the digest subscriber to remove.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

RemoveSubscriber

Removes a subscriber to the specified list.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe domain that contains the list.
ListNameStringThe name of the mailing list.
SubscriberStringThe email address of the subscriber to remove.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetDigestSubscriberList

Sets the digest subscribers for the given list.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe domain that contains the list.
ListNameStringThe name of the mailing list.
SubscribersString[]A list of email addresses that will become the new digest subscriber list for the mailing list.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetListCommandAddress

Sets the command list address for the specified domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe name of the domain to modify.
commandAddressStringThe username for the command list address. This is typically stserv or listserv.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetPosterKillList

Sets the kill list (blocked posters) for the given list.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe domain that contains the list.
ListNameStringThe name of the mailing list.
SubscribersString[]A list of email addresses that will become the new kill list for the mailing list.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetPosterWhiteList

Sets the poster whitelist for the given list.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe domain that contains the list.
ListNameStringThe name of the mailing list.
SubscribersString[]A list of email addresses that will become the new poster whitelist for the mailing list.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetRequestedListSettings

Sets specific settings for the specified list.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe domain that contains the list.
ListNameStringThe name of the mailing list.
newSettingsString[]A list of 'key=value' pairs that define which settings to modify. Possible key names can be found in the GetRequestedListSettings function description.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetSubscriberList

Sets the subscribers for the given list.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe domain that contains the list.
ListNameStringThe name of the mailing list.
SubscribersString[]A list of email addresses that will become the new subscriber list for the mailing list.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetSubscriberList2

Sets the subscribers for the given list.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringThe domain that contains the list.
ListNameStringThe name of the mailing list.
SubscribersString[]A list of email addresses that will become the new subscriber list for the mailing list.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

svcProductInfo

http://www.mpwkitchens.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.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
AccountEmailAddressStringThe email address associated with the license key.
AccountPasswordStringThe password that should be used to activate the license.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetLicenseInfo

Returns the license key for the installation.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: LicenseInfoResult

LicenseInfoResultDescription
LicenseKeyStringThe license key for this installation.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetProductInfo

Returns the product name and version for the installation.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: ProductInfoResult

ProductInfoResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ProductNameStringThe name of the product.
ProductVersionStringThe version number of the product.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetLicenseKey

Sets the product license key for the installation. Note that you will need to call ActivateLicenseKey afterwards to enable the licence.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
KeyStringThe license key to set.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

svcServerAdmin

http://www.mpwkitchens.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.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
serviceStringThe service to which the rule applies. Possible values are:
  • IMAP
  • POP
  • SMTP
timeframeInt32The timeframe in minutes in which the rule can be triggered.
connectionsBeforeBlockInt32The number of connections the server will allow before blocking access.
timeToBlockInt32The period in minutes for which the server will block the offender.
descriptionStringA brief description of the rule for display purposes.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddFolderAutocleanRule

Adds a server level auto-clean rule to the server.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
folderStringFolder name to auto-clean.
enableRuleBooleanTrue to enable the rule immediately.
typeStringType of rule. Possible values are:
  • Date
  • Size
sizeBeforeAutoCleanInt32If type is Size, the size which a folder must reach before being auto-cleaned.
sizeAfterCleanInt32If type is Size, the size which a folder will be trimmed to after it's cleaned.
mailAgeInDaysInt32If type is Date, the age in days at which email gets deleted.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddForwardingBlacklistEntry

Adds a forwarding blacklist entry to the server.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
domainNameStringDomain name to blacklist.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddGateway

Adds a non-SmarterMail outgoing gateway to SmarterMail. If your gateway is running SmarterMail, use AddSmarterMailGateway instead.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
addressStringThe IP Address of the gateway.
enabledBooleanTrue if the gateway should be enabled immediately.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddGlobalTrustedSender

Adds a new globally trusted sender.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
addressOrDomainStringEmail address or domain name to trust.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddGreylistingFilter

Adds a new greylisting filter.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
filterTypeStringThe type of filter to add. Possible values are:
  • Country
  • IPAddress
  • IPRange
ipRangeStartStringStart of the IP range. Required only when filterType is IPRange.
ipRangeEndStringEnd of the IP range. Required only when filterType is IPRange.
ipAddressStringIP address to be filtered. Required only when filterType is IPAddress.
descriptionStringA brief description for display purposes.
countryCodeStringCountry code to be filtered. Required only when filterType is Country.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddHarvestingAbuseDetectionRule

Adds a harvesting abuse detection rule to the server.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
timeframeInt32The timeframe in minutes in which the rule can be triggered.
badSessionsBeforeBlockInt32The number of bad SMTP sessions to allow before blocking the offender.
timeToBlockInt32The period in minutes for which the server will block the offender.
descriptionStringA brief description of the rule for display purposes.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddHostname

Adds a hostname to the server.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
hostnameStringHostname to add.
ipAddressStringIP Address to which the hostname applies.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddIncomingGateway

Adds a new incoming gateway configuration.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
newIncomingGatewayIncomingGatewayAttributesAttributes for the gateway.
IncomingGatewayAttributesDescription
authSmarterMailPasswordStringPassword of the administrator (if smarterMailMode is true).
authSmarterMailUserNameStringUsername of the administrator (if smarterMailMode is true).
domainsToForwardString[]A list of domain names that should be forwarded.
domainVerifyTypeStringType of domain verification. Possible values are:
  • AllButSpecifiedDomains
  • SpecifiedDomains
  • WebService
enableSpamActionsBooleanTrue to enable spam check actions.
gatewayModeStringThe mode that the gateway is operating. Possible values are:
  • BackupMX
  • DomainForward
guidStringThe unique identifier of the incoming gateway.
IPAddressStringIP Address of the gateway.
IPEndRangeStringEnd of the IP Address range of the gateway.
IPStartRangeStringStart of the IP Address range of the gateway.
smarterMailModeBooleanTrue if the gateway is a SmarterMail server.
smarterMailURLStringURL to the SmarterMail web interface (if smarterMailMode is true).
spamHighActionStringAction to take on Spam-High. Possible values are:
  • Delete
  • Header
  • None
  • PassScore
  • Reroute
  • Subject
spamHighArgsStringArguments to use for the action.
spamLowActionStringAction to take on Spam-Low. Possible values are:
  • Delete
  • Header
  • None
  • PassScore
  • Reroute
  • Subject
spamLowArgsStringArguments to use for the action.
spamMedActionStringAction to take on Spam-Med. Possible values are:
  • Delete
  • Header
  • None
  • PassScore
  • Reroute
  • Subject
spamMedArgsStringArguments to use for the action.
userVerifyTypeStringThe type of user verification done by the gateway. Possible values are:
  • None
  • SMTP
  • WebService
webserviceURLStringThe URL of the web service.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddInternalSpammerNotificationAbuseDetectionRule

Adds an internal spammer notification abuse detection rule.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
timeframeInt32The timeframe in minutes in which the rule can be triggered.
messagesBeforeNotifyInt32The number of messages sent by the offender before the rule is triggered.
emailAddressToNotifyStringThe email address to notify when the rule is triggered.
descriptionStringA brief description of the rule for display purposes.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddIPRestrictionToSystemAdmin

Adds an IP address or IP range restriction to a system administrator login.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
adminUsernameStringUsername of the system administrator.
ipAddressOrRangeStringThe IP address or IP range (format: x.x.x.x-y.y.y.y).
restrictionDescriptionStringA brief description for display purposes.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddServerPort

Adds a port to the server.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
protocolStringThe protocol assigned to the port. Possible values are:
  • IMAP
  • LDAP
  • POP
  • SMTP
  • SubmissionPort
certificatePathStringIf the port uses SSL or TLS, the path to the certificate on the server.
encryptionStringOptional The encryption method to use. Possible values are:
  • SSL
  • TLS
nameStringA descriptive name for the port.
portInt32The port number.
descriptionStringA brief description of the port for display purposes.

Returns: AddServerPortResult

AddServerPortResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
NewIDStringUnique identifier of the newly added item.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddSmarterMailGateway

Adds a SmarterMail outgoing gateway to SmarterMail. If your gateway is NOT running SmarterMail, use AddGateway instead.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
addressStringThe IP Address of the gateway.
enabledBooleanTrue if the gateway should be enabled immediately.
smUrlStringUrl to the SmarterMail Web interface. For example, http://mail.example.com/.
smUserNameStringAdministrator username for the gateway.
smPasswordStringAdministrator password for the gateway.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddSmtpAuthenticationBypass

Adds a new SMTP authentication bypass rule. Pass either an IP Address or a range, not both.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
ipAddressStringIP address.
ipRangeStartStringStart of the IP range.
ipRangeEndStringEnd of the IP range.
descriptionStringA brief description for display purposes.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddSMTPBlockedSender

Adds a new SMTP blocked sender.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
blockedSenderStringEmail address of the blocked sender.
descriptionStringA brief description for display purposes.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddSpamAssassinServer

Adds a remote SpamAssassin server configuration.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
serverNameStringA descriptive name for the server.
ipAddressStringThe IP address of the server.
serverPortInt32The port number on which the SpamAssassin service is listening.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddSystemAdmin

Adds a new system administrator.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
newAdminUsernameStringUsername of the system administrator.
newAdminPasswordStringPassword to use.
newAdminDescriptionStringA brief description for display purposes.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AssignPortToIP

Assigns a port to an IP address.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
portIDStringThe unique identifier of the port.
ipAddressStringIP Address to which the port will be assigned.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteAbuseDetectionRule

Deletes an abuse detection rule.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
idStringThe unique identifier of the abuse detection rule.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteFolderAutoCleanRule

Removes a server level auto-clean rule from the server.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
idStringUnique identifier of the auto-clean rule.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteForwardingBlacklistEntry

Remove a forwarding blacklist entry from the server.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
domainNameStringDomain name to remove from blacklist.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteGlobalTrustedSender

Deletes a globally trusted sender.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
addressOrDomainStringEmail address or domain name to remove.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteGreylistingFilter

Removes a greylisting filter.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
filterTypeStringThe filter type of the greylisting filter to remove.
ipRangeStartStringOptional Start of the IP range used by the filter.
ipRangeEndStringOptional End of the IP range used by the filter.
ipAddressStringOptional IP address of the filter.
countryCodeStringOptional Country code of the filter.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteHostname

Removes a hostname from the server.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
ipAddressStringIP Address to remove hostname for.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteServerPort

Deletes a port from the server.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
portIdStringThe identifier of the port to delete. This can be obtained from the ListServerPorts function.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteSmtpAuthenticationBypass

Deletes an SMTP authentication bypass rule. Pass either an IP Address or a range, not both.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
ipAddressStringIP address.
ipRangeStartStringStart of the IP range.
ipRangeEndStringEnd of the IP range.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteSpamAssassinServer

Deletes a remote SpamAssassin server configuration.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
serverNameStringThe name of the server you wish to delete.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteSystemAdmin

Removes a system administrator.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
systemAdminUsernameStringUsername of the system administrator to delete.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetBlacklistEntries

Returns the currently configured blacklist entries.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.

Returns: BlacklistListResult

BlacklistListResultDescription
EntriesBlacklistResult[]A list of blacklist entries, as defined in the BlacklistResult class.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
BlacklistResultDescription
DescriptionStringA brief description for display purposes.
IMAPBlacklistedBooleanTrue if IMAP blacklisted.
IPAddressStringIP Address that is blacklisted.
IPRangeEndStringEnd of an IP Address range that is blacklisted.
IPRangeStartStringStart of an IP Address range that is blacklisted.
POPBlacklistedBooleanTrue if POP blacklisted.
SMTPBlacklistedBooleanTrue if SMTP blacklisted.

GetDOSAbuseDetectionRules

Returns the current DOS detection rules on the server.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.

Returns: DOSAbuseDetectionRulesListResult

DOSAbuseDetectionRulesListResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
RulesDOSAbuseDetectionRuleResult[]A list of rule details, as defined in the DOSAbuseDetectionRuleResult class.
DOSAbuseDetectionRuleResultDescription
ConnectionsBeforeBlockInt32Number of connections in the timeframe for the rule to trigger.
DescriptionStringA brief description for display purposes.
ServiceStringService to which the rule applies. Possible values are:
  • IMAP
  • POP
  • SMTP
TimeframeInt32Timeframe in which the connections must occur for the rule to trigger.
TimeToBlockInt32Period in minutes for which the server will block the offender.

GetEdition

Returns the operational licensing mode that SmarterMail is running under.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: EditionResult

EditionResultDescription
EditionStringThe licensed edition of SmarterMail. Possible values are:
  • ENT
  • FREE
  • LITE
  • PRO
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetGateway

Returns information about a particular outgoing gateway.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
guidStringUnique identifier for the gateway.

Returns: GatewayResult

GatewayResultDescription
enabledBooleanTrue if the gateway is enabled.
gatewayAddressStringIP Address of the gateway.
guidStringUnique identifier of the gateway.
isSmarterMailServerBooleanTrue if the gateway is a SmarterMail server.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
smPasswordStringPassword for the gateway (if isSmarterMailServer is true).
smUrlStringURL to the SmarterMail web interface of the gateway (if isSmarterMailServer is true).
smUserNameStringUsername for the gateway (if isSmarterMailServer is true).

GetGlobalTrustedSenders

Returns a list of all current globally trusted senders.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.

Returns: TrustedSenderListResult

TrustedSenderListResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
TrustedSendersString[]A list of email addresses or domains.

GetHarvestingAbuseDetectionRules

Returns the current harvesting detection rules on the server.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.

Returns: HarvestingAbuseDetectionRulesListResult

HarvestingAbuseDetectionRulesListResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
RulesHarvestingAbuseDetectionRuleResult[]A list of rule details, as defined in the HarvestingAbuseDetectionRuleResult class.
HarvestingAbuseDetectionRuleResultDescription
BadSessionsBeforeBlockInt32Number of bad sessions in the timeframe for the rule to trigger.
DescriptionStringA brief description for display purposes.
TimeframeInt32Timeframe in which the connections must occur for the rule to trigger.
TimeToBlockInt32Period in minutes for which the server will block the offender.

GetIncomingGateway

Retrieves information about a specific incoming gateway.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
guidStringThe unique ID that identifies the gateway.

Returns: IncomingGatewayResult

IncomingGatewayResultDescription
gatewayIncomingGatewayAttributesDetails about the incoming gateway, as defined in the IncomingGatewayAttributes class.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
IncomingGatewayAttributesDescription
authSmarterMailPasswordStringPassword of the administrator (if smarterMailMode is true).
authSmarterMailUserNameStringUsername of the administrator (if smarterMailMode is true).
domainsToForwardString[]A list of domain names that should be forwarded.
domainVerifyTypeStringType of domain verification. Possible values are:
  • AllButSpecifiedDomains
  • SpecifiedDomains
  • WebService
enableSpamActionsBooleanTrue to enable spam check actions.
gatewayModeStringThe mode that the gateway is operating. Possible values are:
  • BackupMX
  • DomainForward
guidStringThe unique identifier of the incoming gateway.
IPAddressStringIP Address of the gateway.
IPEndRangeStringEnd of the IP Address range of the gateway.
IPStartRangeStringStart of the IP Address range of the gateway.
smarterMailModeBooleanTrue if the gateway is a SmarterMail server.
smarterMailURLStringURL to the SmarterMail web interface (if smarterMailMode is true).
spamHighActionStringAction to take on Spam-High. Possible values are:
  • Delete
  • Header
  • None
  • PassScore
  • Reroute
  • Subject
spamHighArgsStringArguments to use for the action.
spamLowActionStringAction to take on Spam-Low. Possible values are:
  • Delete
  • Header
  • None
  • PassScore
  • Reroute
  • Subject
spamLowArgsStringArguments to use for the action.
spamMedActionStringAction to take on Spam-Med. Possible values are:
  • Delete
  • Header
  • None
  • PassScore
  • Reroute
  • Subject
spamMedArgsStringArguments to use for the action.
userVerifyTypeStringThe type of user verification done by the gateway. Possible values are:
  • None
  • SMTP
  • WebService
webserviceURLStringThe URL of the web service.

GetInternalSpammerNotificationAbuseDetectionRules

Returns the current internal spamer detection rules on the server.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.

Returns: InternalSpammerNotificationAbuseDetectionRulesListResult

InternalSpammerNotificationAbuseDetectionRulesListResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
RulesInternalSpammerNotificationAbuseDetectionRuleResult[]A list of rule details.
InternalSpammerNotificationAbuseDetectionRuleResultDescription
DescriptionStringA brief description for display purposes.
EmailAddressToNotifyStringEmail address tnotify once the rule is triggered.
MessagesBeforeNotifyInt32Number of messages in the timeframe for the rule to trigger.
TimeframeInt32Timeframe in which the messages must occur for the rule to trigger.

GetRequestedSystemSettings

Retrieves the value of the requested system settings.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
reqSettingsString[]A list of settings to return. Possible values are:
  • AdminPassword - System admin password
  • AdminUsername - System admin username
  • AllowRelay - Can be one of: noone, localusers, localhosts, anyone
  • Archive - Archive path for messages
  • ArchiveAllIncomingMessages - True to enable
  • ArchiveAllOutgoingMessages - True to enable
  • AttemptsBeforeBouncingDueToDnsErrors - After X failed attempts, bounce message
  • DeleteDomainStatsAfter - Delete after X months
  • DeleteDomainStatsAfterEnabled - True to enable
  • DeleteLogFilesAfter - Delete after X days
  • DeleteLogFilesAfterEnabled - True to enable
  • DeleteServerStatsAfter - Delete after X months
  • DeleteServerStatsAfterEnabled - True to enable
  • DeleteUserStatsAfter - Delete after X months
  • DeleteUserStatsAfterEnabled - True to enable
  • DeliveryDelay - Seconds to wait before message delivery
  • DeliveryThreads - Number of outbound threads
  • DisableAppendingOfReceivedLineForAuthenticatedMessages - True to not append 'received' header on authenticated SMTP sessions
  • DisableAuthLogin - Disables the SMTP AUTH LOGIN command
  • DisableReceivedAppend - True to not append 'received' header on authenticated SMTP sessions
  • DnsCachingEnabled - True to enable in-process DNS caching
  • DomainsCanOverrideAutoCleanSettings - True to allow domains to override auto-clean rules
  • EnableLiteMode - Enable lite mode (must meet licensing requirements)
  • EnforceSmtpAuthLocalDelivery - Require SMTP authentication for local deliveries
  • ExecuteCommandLine - Command line to execute on every spool message
  • ExecuteCommandLineEnabled - True to enable
  • ExecuteCommandLineTimeout - Abort command line after X seconds
  • FileStorageMaxFileSize - The maximum file size allowed to be stored in file storage
  • FileStorageMaxFileSizeEnabled - True to enable size limit
  • FooterAllowDomainOverride - Allows the domain to override footers
  • FooterAppliesToMailingLists - enables the footer to be applied to mailing list messages
  • FooterEnabledForAllOutgoingMessages - enables a footer for all outgoing messages
  • FooterText - Text appended to outgoing messages
  • GreylistIfTheCountryForTheIpAddressIsUnknown - Enables greylisting if the origin country of sender is unknown
  • GreylistingBlockPeriod - period of the initial blocking when greylisted in minutes
  • GreylistingEnabled - Enables greylisting on the server
  • GreylistingEnableUsersToOverride - Allows users to ovveride default greylist settings
  • GreylistingFilterOption - Select who greylisting applies to
  • GreylistingPassPeriod - period in which the sender's mail server has to retry sending the message
  • GreylistingRecordExpiration -The period of time(in days) that the sender will remain immune from greylisting once it has passed
  • Hostname - The hostname of the server
  • ImapBanner - the banner sent to connecting IMAP clients
  • ImapCommandTimeout - If the server receives a command that sends large amounts of data and the data stops coming in for this number of seconds, the command will be aborted
  • ImapIdleEnabled - Enable IMAP Idle
  • ImapMaxBadCommands - After this many unrecognized or improper commands, a connection will be automatically terminated
  • ImapMaxConnections - Maximum concurrent connections
  • imapRetrievalDownloadPath - Directory for imap retrieval downloads
  • imapRetrievalInterval - The frequency by which SmarterMail checks for new IMAP messages. By default, the IMAP retrieval interval is 10 minutes
  • imapRetrievalThreads - Maximum number of IMAP retrieval threads
  • IndexingItemsBeforeGarbageCollection - number of indexed items before a forced garbage collection occurs
  • IndexingItemsDeletedBeforeOptimizing - number of indexed items deleted before optimizing the index
  • IndexingItemsPerPass - number of items to index for a user before lowering their queue priority
  • IndexingMaxThreads - maximum number of threads the indexing engine is allowed to use
  • IndexingSecondsInQueueBeforeIndex - number of seconds a user must wait in queue before they are indexed
  • IndexingSegmentsBeforeOptimizing - number of index segment files that are allowed to be created before the index is optimized
  • LdapCommandTimeout - Time in seconds before a LDAP command times out due to inactivity
  • LdapSessionTimeout - Time in seconds until session is closed due to inactivty
  • LogoutUrl - URL to redirect to on logout
  • LogoutUrlEnabled - Enables URL redirection on logout
  • LogoutUrlOverrideEnabled - allow domains to override logout URL
  • LogPath - the path to which SmarterMail stores log files
  • MinimumPasswordLength - Minimum number of charactes a password must require
  • MinimumPasswordLengthEnabled - Enforce mimimum password length setting
  • OutboundIp - specifiedip for outbound connections
  • OutboundIpOption - domainsip, primaryip, specifiedip
  • PasswordMustNotMatchUsername - Password must differ from username
  • PasswordRequiresCapitalLetter - password requires at least one capital letter
  • PasswordRequiresLowercaseLetter - password requires at least one lowercase letter
  • PasswordRequiresNumber - Password requires at least one number
  • PasswordRequiresSymbol - password requires at least one symbol such as !, @, #, etc.
  • PasswordRetrievalEnabled - Password retrieval enabled on server
  • PasswordStrengthDisabledForExistingPasswords - disables password strength requirements for users who have passwords already setup
  • PopBanner - the banner sent to connecting POP clients
  • PopCommandTimeout - Command timeout after x seconds
  • PopMaxBadCommands - Disconnect if client issues x bad commands
  • PopMaxConnections - Maximum concurrent connections
  • PopRetrievalDownloadPath - Location of temporary POP retrieval files
  • PopRetrievalInterval - Retrieve POP every x minutes
  • PopRetrievalThreads - Maximum POP retrieval sessions
  • PostmasterMailbox - Postmaster mailbox
  • PrimaryDns - Primary dns server, leave blank for automatic
  • SecondaryDns - Secondary dns server, leave blank for automatic
  • SmtpAuthBypassRelay - Bypass relay settings when authenticated
  • SmtpBanner - the banner sent to connecting SMTP clients
  • SmtpCommandTimeout - enable EXPN command
  • SmtpExpn - Enable EXPN command
  • SmtpMaxBadCommands - disconnect if client issues x bad commands
  • SmtpMaxBadRecipients - Disconnect if client issues x bad recipients
  • SmtpMaxConnections - Maximum concurrent connections
  • SmtpMaxHopCount - Maximum hop count
  • SmtpMaxMessageSize - Maximum message size in MB
  • SmtpSessionTimeout - Disconnect if session exceeds x minutes
  • SmtpSessionTimeoutEnabled - Enable SMTP session timeouts
  • SmtpVrfy - Enable VRFY command
  • SpamBlockingEnable - Enforce spam block threshold
  • SpamBlockingThreshold - Threshold of spam weight before message is blocked
  • SpamCheckClamEnable - Enable clam on spam checks
  • SpamCheckThreads - Number of maximum spam check threads
  • SpamGreylistEnable - Spam threshold for greylisting enabled
  • SpamGreylistThreshold - Spam threshold for greylisting messages
  • SpamGreylistThresholdEnable - Greylisting spam threshold enabled
  • SpamOutgoingBlockingEnable - Check outgoing messages for spam enabled
  • SpamOutgoingBlockingThreshold - Spam threshold for outgoing messages
  • SpoolPath - Path of the spool
  • SubmissionPort - Port used for submission port
  • SubmissionPortEnabled - Enable submission port
  • SubmissionPortIp - IP used for submission port
  • SubSpools - number of subspools
  • TimeBetweenAttempts - comma separated list of retry times
  • UserDefaultAuthType - Default user auth type
  • UserDefaultAutoTrustRecipients - Default mark recipients as trusted senders
  • UserDefaultBlockImages - Enable/disable automatic image loading in preview pane
  • UserDefaultComposeFont - Default user compose font face
  • UserDefaultComposeFontSize - Default user compose font size
  • UserDefaultComposeMethod - Default user compose method
  • UserDefaultDeleteMailOnForward - Delete messages after autoforwarding
  • UserDefaultDeleteOption - Message delete actions
  • UserDefaultDisableGreylisting - Default greylisting enabled setting for a user
  • UserDefaultEmbedReplies - Default setting for embedding replies for a user
  • UserDefaultEnableDomainkeySigning - Default setting for enabling a user domain key signing
  • UserDefaultEnableImapRetrieval - Default setting for enabling a user for IMAP retrieval
  • UserDefaultEnablePopRetrieval - Default setting for enabling a user for POP retrieval
  • UserDefaultEnableSounds - Enable/disable chat sounds
  • UserDefaultForwardAs - Default forward as setting
  • UserDefaultForwardingAddress - Address to forward to
  • UserDefaultHeaderDisplay - Default header display for a user
  • UserDefaultHideFromLdap - Default setting for hiding user from LDAP
  • UserDefaultLockPassword - Enable/disable password changes
  • UserDefaultMailboxSize - Default mailbox size limit for a user
  • UserDefaultPlusAddressingEnable - Default user setting for enabling plus addressing
  • UserDefaultPlusAddressingFolder - Default action for plus addressing
  • UserDefaultReplyMessageIndicator - Default text indicator for a reply portion of a message
  • UserDefaultRequestReceipts - Default user setting for read receipt requests
  • UserDefaultSaveCopyAssent - Default setting for handling a user's sent messages
  • UserDefaultSortBy - Default sort by view for a user
  • UserDefaultSortDescending - Enable/disable descending sort order
  • UserDefaultStartupPage - Set the default start page of a user
  • UserDefaultTimeZoneIndex - Time zone index
  • UserDefaultViewMessagesAs - View messages as Html or Text
  • UsersCanAutoCleanInbox - allows users to auto clean their inbox
  • UseTlsIfSupportedByRemoteServer - enables SmarterMail attempt to use TLS for outgoing messages if the remote server supports it
  • WelcomeWizardDisabled Enable or disable the welcome wizard

Returns: RequestSettingsResult

RequestSettingsResultDescription
KeyValuePairsString[]A list of 'key=value' pairs with the requested setting values.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetSmtpAuthenticationBypasses

Returns a list of the currently configured SMTP authentication bypass rules.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.

Returns: SMTPAuthBypassListResult

SMTPAuthBypassListResultDescription
EntriesSMTPAuthBypassResult[]A list of SMTP Authentication bypass entries, as defined in the SMTPAuthBypassResult class.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
SMTPAuthBypassResultDescription
DescriptionStringA brief description for display purposes.
IPAddressStringIP Address that is bypassed.
IPRangeEndStringEnd of an IP Address range that is bypassed.
IPRangeStartStringStart of an IP Address range that is bypassed.

GetSMTPBlockedSenders

Returns a list of currently blocked SMTP senders.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.

Returns: SMTPBlockedSenderListResult

SMTPBlockedSenderListResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
SMTPBlockedSendersSMTPBlockedSenderResult[]A list of blocked senders, as defined in the SMTPBlockedSenderResult class.
SMTPBlockedSenderResultDescription
BlockedSenderStringEmail address or domain name of a blocked sender.
DescriptionStringA brief description for display purposes.

GetSpoolMessageCount

Returns the number of messages in the spool.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: MessageCountResult

MessageCountResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
messageCountInt32Number of messages in the spool.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetWhitelistEntries

Returns the currently configured whitelist entries.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.

Returns: WhitelistListResult

WhitelistListResultDescription
EntriesWhitelistResult[]A list of whitelists, as defined in the WhitelistResult class.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
WhitelistResultDescription
DescriptionStringA brief description for display purposes.
IMAPWhitelistedBooleanTrue if IMAP whitelisted.
IPAddressStringIP Address that is whitelisted.
IPRangeEndStringEnd of an IP Address range that is whitelisted.
IPRangeStartStringStart of an IP Address range that is whitelisted.
POPWhitelistedBooleanTrue if POP whitelisted.
SMTPWhitelistedBooleanTrue if SMTP whitelisted.

ListFolderAutoCleanRules

Returns a list of all server level auto-clean rules defined in SmarterMail.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.

Returns: FolderAutoCleanRuleListResult

FolderAutoCleanRuleListResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
RulesFolderAutoCleanRuleResult[]
FolderAutoCleanRuleResultDescription
EnabledBoolean
IDString
MailAgeInDaysInt32
SizeAfterCleanInMBInt32
SizeBeforeCleanInMBInt32
TypeString

ListForwardingBlacklistEntries

Returns all current forwarding blacklist entries.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.

Returns: ForwardingBlacklistRuleResult

ForwardingBlacklistRuleResultDescription
BlacklistedDomainsString[]
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

ListGateways

Returns a list of all outgoing gateways for the server.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: GatewayListResult

GatewayListResultDescription
gatewaysGatewayResult[]A list of gateways, as defined in the GatewayResult class.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
GatewayResultDescription
enabledBooleanTrue if the gateway is enabled.
gatewayAddressStringIP Address of the gateway.
guidStringUnique identifier of the gateway.
isSmarterMailServerBooleanTrue if the gateway is a SmarterMail server.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
smPasswordStringPassword for the gateway (if isSmarterMailServer is true).
smUrlStringURL to the SmarterMail web interface of the gateway (if isSmarterMailServer is true).
smUserNameStringUsername for the gateway (if isSmarterMailServer is true).

ListGreylistingFilters

Returns a list of all currently configured greylisting filters.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.

Returns: GreylistingFilterListResult

GreylistingFilterListResultDescription
FiltersGreylistingFilterResult[]A list of filter details, as defined in the GreylistingFilterResult class.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
GreylistingFilterResultDescription
CountryCodeStringIf FilterType is CountryCode, contains the country code.
DescriptionStringA brief description for display purposes.
FilterTypeStringThe type of filter. Possible values are:
  • Country
  • IPAddress
  • IPRange
IPAddressStringIf FilterType is IPAddress, contains the IP Address.
IPRangeEndStringIf FilterType is IPRange, contains the end of the IP Range.
IPRangeStartStringIf FilterType is IPRange, contains the start of the IP Range.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

ListHostnames

Returns a list of all hostnames configured on the server.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.

Returns: HostnameListResult

HostnameListResultDescription
HostnamesHostnameResult[]
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
HostnameResultDescription
HostnameString
IPAddressString

ListIncomingGateways

Returns a list of all configured incoming gateways.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: IncomingGatewayListResult

IncomingGatewayListResultDescription
incGatewaysIncomingGatewayAttributes[]A list of detals about the incoming gateways, as defined in the IncomingGatewayAttributes class.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
IncomingGatewayAttributesDescription
authSmarterMailPasswordStringPassword of the administrator (if smarterMailMode is true).
authSmarterMailUserNameStringUsername of the administrator (if smarterMailMode is true).
domainsToForwardString[]A list of domain names that should be forwarded.
domainVerifyTypeStringType of domain verification. Possible values are:
  • AllButSpecifiedDomains
  • SpecifiedDomains
  • WebService
enableSpamActionsBooleanTrue to enable spam check actions.
gatewayModeStringThe mode that the gateway is operating. Possible values are:
  • BackupMX
  • DomainForward
guidStringThe unique identifier of the incoming gateway.
IPAddressStringIP Address of the gateway.
IPEndRangeStringEnd of the IP Address range of the gateway.
IPStartRangeStringStart of the IP Address range of the gateway.
smarterMailModeBooleanTrue if the gateway is a SmarterMail server.
smarterMailURLStringURL to the SmarterMail web interface (if smarterMailMode is true).
spamHighActionStringAction to take on Spam-High. Possible values are:
  • Delete
  • Header
  • None
  • PassScore
  • Reroute
  • Subject
spamHighArgsStringArguments to use for the action.
spamLowActionStringAction to take on Spam-Low. Possible values are:
  • Delete
  • Header
  • None
  • PassScore
  • Reroute
  • Subject
spamLowArgsStringArguments to use for the action.
spamMedActionStringAction to take on Spam-Med. Possible values are:
  • Delete
  • Header
  • None
  • PassScore
  • Reroute
  • Subject
spamMedArgsStringArguments to use for the action.
userVerifyTypeStringThe type of user verification done by the gateway. Possible values are:
  • None
  • SMTP
  • WebService
webserviceURLStringThe URL of the web service.

ListPortsAssignedToIP

Returns a list of ports currently bound to a specific IP Address.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
ipAddressStringIP Address to check.

Returns: ServerPortListResult

ServerPortListResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
PortsServerPortResult[]A list of ports, as defined in the ServerPortResult class.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
ServerPortResultDescription
CertificatePathStringOptional The path to the certificate used for SSL and TLS connections.
DescriptionStringA brief description for display purposes.
EncryptionStringOptional Encryption method applied to the port. Possible values are:
  • SSL
  • TLS
IDStringUnique identifier of the item.
NameStringDisplay name for the port.
PortInt32The port number.
ProtocolStringProtocol to which the port applies. Possible values are:
  • IMAP
  • POP
  • SMTP
  • SubmissionPort

ListServerPorts

Lists all ports currently setup on the server.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.

Returns: ServerPortListResult

ServerPortListResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
PortsServerPortResult[]A list of ports, as defined in the ServerPortResult class.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
ServerPortResultDescription
CertificatePathStringOptional The path to the certificate used for SSL and TLS connections.
DescriptionStringA brief description for display purposes.
EncryptionStringOptional Encryption method applied to the port. Possible values are:
  • SSL
  • TLS
IDStringUnique identifier of the item.
NameStringDisplay name for the port.
PortInt32The port number.
ProtocolStringProtocol to which the port applies. Possible values are:
  • IMAP
  • POP
  • SMTP
  • SubmissionPort

ListSpamAssassinServers

Returns a list of all currently configured remote SpamAssassin servers.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.

Returns: SpamAssassinServerListResult

SpamAssassinServerListResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
ServersSpamAssassinServerResult[]A list of server details, as defined in the SpamAssassinServerResult class.
SpamAssassinServerResultDescription
ConsecutiveFailuresInt32The number of consecutive failures for this SpamAssassin server.
EnabledBooleanTrue if the SpamAssassin server is enabled.
IPAddressStringIP Address of the server.
NameStringName of the server.
PortInt32Port that SpamAssassin is listening on.
TotalConnectionsInt32The total number of connections made to this SpamAssassin Server.

ListSystemAdmins

Returns the current system administrators on the server.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.

Returns: SystemAdminListResult

SystemAdminListResultDescription
AdminsSystemAdminResult[]
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
SystemAdminResultDescription
DateCreatedDateTime
DescriptionString
IDString
IsPrimaryAdminBoolean
RestrictedByIpBoolean
UsernameString

RemoveGateway

Deletes an outgoing gateway from SmarterMail.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
guidStringUnique identifier of the gateway to remove.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

RemoveIncomingGateway

Deletes an incoming gateway configuration.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
guidStringThe unique ID that identifies the gateway.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

RemoveIPRestrictionFromSystemAdmin

Removes an IP address or IP range restriction from a system administrator login.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
adminUsernameStringUsername of the system administrator.
ipAddressOrRangeStringThe IP address or IP range (format: x.x.x.x-y.y.y.y).

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

RemovePortFromIP

Removes a port assigned to an IP address.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
portIDStringThe unique identifier of the port.
ipAddressStringIP Address from which the port will be removed.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

RequestStatus

Returns information about the current status of the server.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
reqStatsString[]A list of data items to retrieve. Possible values are:
  • imap_isrunning
  • imap_threadcount
  • pop_isrunning
  • pop_threadcount
  • server_uptime
  • smtp_isrunning
  • smtp_threadcount
  • spool_isrunning
  • spool_messagecount
  • spool_threadcount

Returns: RequestStatusResult

RequestStatusResultDescription
KeyValuePairsString[]A list of 'key=value' pairs with the requested status values.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetBlacklistEntry

Adds a new blacklist entry or edits an existing blacklist entry. Pass either an IP address or a range, not both.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
ipAddressStringIP address to be blacklisted.
ipRangeStartStringStart of the IP range to be blacklisted.
ipRangeEndStringEnd of the IP range to be blacklisted.
blacklistSMTPBooleanTrue to blacklist SMTP.
blacklistPOPBooleanTrue to blacklist POP.
blacklistIMAPBooleanTrue to blacklist IMAP.
descriptionStringA brief description for display purposes.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetRequestedSystemSettings

Sets the value of the requested system settings.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
newSettingsString[]A list of 'key=value' pairs that define what settings to change. Possible key names can be found in the GetRequestedSystemSettings function.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetSystemAdminPassword

Sets the password of a system administrator.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
systemAdminUsernameStringUsername of the system administrator to update.
newPasswordStringNew password to use.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetWhitelistEntry

Adds a new whitelist entry or edits an existing whitelist entry. Pass either an IP address or a range, not both.

Input ParametersDescription
authUsernameStringUsername with permissions to call this web service.
authPasswordStringPassword of the account used in authUserName parameter.
ipAddressStringIP address to be whitelisted.
ipRangeStartStringStart of the IP range to be whitelisted.
ipRangeEndStringEnd of the IP range to be whitelisted.
whitelistSMTPBooleanTrue to whitelist SMTP.
whitelistPOPBooleanTrue to whitelist POP.
whitelistIMAPBooleanTrue to whitelist IMAP.
descriptionStringA brief description for display purposes.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

StartServices

Starts the specified services in SmarterMail.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
ServicesToStartString[]A list of services to start. Possible values are:
  • all
  • imap
  • imapretrieval
  • indexing
  • ldap
  • pop
  • popretrieval
  • smtp
  • spool
  • xmpp

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

StopServices

Stops the specified services in SmarterMail.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
ServicesToStopString[]A list of services to stop. Possible values are:
  • all
  • imap
  • imapretrieval
  • indexing
  • ldap
  • pop
  • popretrieval
  • smtp
  • spool
  • xmpp

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

UpdateGateway

Updates the settings for a specific outgoing gateway.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
guidStringUnique identifier of the gateway.
addressStringThe IP Address of the gateway.
enabledBooleanTrue if the gateway should be enabled.
isSmarterMailServerBooleanTrue if the gateway is running SmarterMail.
smUrlStringOptional Url to the SmarterMail Web interface (if isSmarterMailServer is true).
smUserNameStringOptional Administrator username for the gateway (if isSmarterMailServer is true).
smPasswordStringOptional Administrator password for the gateway (if isSmarterMailServer is true).

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

UpdateIncomingGateway

Updates properties about a specific incoming gateway.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
guidStringThe unique ID that identifies the gateway.
updatedIncomingGatewayIncomingGatewayAttributesNew attributes for the gateway.
IncomingGatewayAttributesDescription
authSmarterMailPasswordStringPassword of the administrator (if smarterMailMode is true).
authSmarterMailUserNameStringUsername of the administrator (if smarterMailMode is true).
domainsToForwardString[]A list of domain names that should be forwarded.
domainVerifyTypeStringType of domain verification. Possible values are:
  • AllButSpecifiedDomains
  • SpecifiedDomains
  • WebService
enableSpamActionsBooleanTrue to enable spam check actions.
gatewayModeStringThe mode that the gateway is operating. Possible values are:
  • BackupMX
  • DomainForward
guidStringThe unique identifier of the incoming gateway.
IPAddressStringIP Address of the gateway.
IPEndRangeStringEnd of the IP Address range of the gateway.
IPStartRangeStringStart of the IP Address range of the gateway.
smarterMailModeBooleanTrue if the gateway is a SmarterMail server.
smarterMailURLStringURL to the SmarterMail web interface (if smarterMailMode is true).
spamHighActionStringAction to take on Spam-High. Possible values are:
  • Delete
  • Header
  • None
  • PassScore
  • Reroute
  • Subject
spamHighArgsStringArguments to use for the action.
spamLowActionStringAction to take on Spam-Low. Possible values are:
  • Delete
  • Header
  • None
  • PassScore
  • Reroute
  • Subject
spamLowArgsStringArguments to use for the action.
spamMedActionStringAction to take on Spam-Med. Possible values are:
  • Delete
  • Header
  • None
  • PassScore
  • Reroute
  • Subject
spamMedArgsStringArguments to use for the action.
userVerifyTypeStringThe type of user verification done by the gateway. Possible values are:
  • None
  • SMTP
  • WebService
webserviceURLStringThe URL of the web service.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

svcSpamAdmin

http://www.mpwkitchens.com.au/Services/svcSpamAdmin.asmx

This web service contains functions that modify spam settings.

AddRBL

Adds an RBL check.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
rblSettingRBLSettingNew settings to apply, as defined in the RBLSetting class.
RBLSettingDescription
DescriptionStringA short description for display purposes.
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
HostnameStringThe hostname of the RBL.
IsURIBLBooleanTrue if the RBL supports URIBL.
NameStringThe name of the RBL list.
RequiredIPStringRequired IP.
RequiredIPEnabledBooleanTrue if RequiredIP is enabled.
UseBitmapCheckingBooleanTrue to use bitmap checking.
WeightInt32Weight when item is in RBL list.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

EditRBL

Edits properties of an RBL check.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
NameOfRblToEditStringName of the RBL check.
rblSettingRBLSettingNew settings to apply, as defined in the RBLSetting class.
RBLSettingDescription
DescriptionStringA short description for display purposes.
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
HostnameStringThe hostname of the RBL.
IsURIBLBooleanTrue if the RBL supports URIBL.
NameStringThe name of the RBL list.
RequiredIPStringRequired IP.
RequiredIPEnabledBooleanTrue if RequiredIP is enabled.
UseBitmapCheckingBooleanTrue to use bitmap checking.
WeightInt32Weight when item is in RBL list.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetBayesianSettings

Returns settings for Bayesian Fitering.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: GetBayesianSettingsResult

GetBayesianSettingsResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
settingsBayesianFilterSettingsItem details, as defined in the BayesianFilterSettings class.
BayesianFilterSettingsDescription
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
MaxMemoryMBInt32Maximum memory to dedicate to Bayesian Filtering.
MessagesRequiredForUpdateInt32Number of messages that get processed before Bayesian Filters get updated.
WeightInt32Max weight to give Bayesian Filtering.

GetCommtouchSettings

Returns settings for Commtouch.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: GetCommtouchSettingsResult

GetCommtouchSettingsResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
settingsCommtouchSettingsItem details, as defined in the CommtouchSettings class.
CommtouchSettingsDescription
BulkWeightInt32Weight for bulk mail.
ConfirmedWeightInt32Weight for confirmed spam.
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
NoneWeightInt32Weight for none.
SuspectWeightInt32Weight for suspected spam.
UnknownWeightInt32Weight for unknown.

GetDecludeSettings

Returns settings for Declude integration.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: GetDecludeSettingsResult

GetDecludeSettingsResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
settingsDecludeSettingsItem details, as defined in the DecludeSettings class.
DecludeSettingsDescription
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
HighSpamWeightInt32Weight for High.
LowSpamWeightInt32Weight for Low.
MedSpamWeightInt32Weight for Medium.

GetDKIMSettings

Returns settings for DKIM.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: GetDomainKeysSettingsResult

GetDomainKeysSettingsResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
settingsDomainKeysSettingsItem details, as defined in the DomainKeysSettings class.
DomainKeysSettingsDescription
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
FailWeightInt32Weight for Fail.
MaxKeySizeDKKeySizeThe maximum key size.
MaxMessageSizeToSignMBInt32Maximum message size (in MB) that will be signed.
MaxMessageSizeToVerifyMBInt32Maximum message size (in MB) that will be verified.
NoneWeightInt32Weight for None.
PassWeightInt32Weight for Pass.
DKKeySize Enum
0_512
1_768
2_1024
3_1536
4_2048

GetDomainKeysSettings

Returns settings for DomainKeys.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: GetDomainKeysSettingsResult

GetDomainKeysSettingsResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
settingsDomainKeysSettingsItem details, as defined in the DomainKeysSettings class.
DomainKeysSettingsDescription
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
FailWeightInt32Weight for Fail.
MaxKeySizeDKKeySizeThe maximum key size.
MaxMessageSizeToSignMBInt32Maximum message size (in MB) that will be signed.
MaxMessageSizeToVerifyMBInt32Maximum message size (in MB) that will be verified.
NoneWeightInt32Weight for None.
PassWeightInt32Weight for Pass.
DKKeySize Enum
0_512
1_768
2_1024
3_1536
4_2048

GetRBL

Returns details about an RBL check.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
nameStringName of the RBL check.

Returns: GetRBLResult

GetRBLResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
settingsRBLSettingItem details, as defined in the RBLSetting class.
RBLSettingDescription
DescriptionStringA short description for display purposes.
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
HostnameStringThe hostname of the RBL.
IsURIBLBooleanTrue if the RBL supports URIBL.
NameStringThe name of the RBL list.
RequiredIPStringRequired IP.
RequiredIPEnabledBooleanTrue if RequiredIP is enabled.
UseBitmapCheckingBooleanTrue to use bitmap checking.
WeightInt32Weight when item is in RBL list.

GetRemoteSASettings

Returns settings for Remote SpamAssassin.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: GetRemoteSASettingsResult

GetRemoteSASettingsResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
settingsRemoteSASettingsItem details, as defined in the RemoteSASettings class.
RemoteSASettingsDescription
ClientTimeoutSecondsInt32Number of seconds to wait before check is considered timeout.
DisableTimeMinutesInt32The number of minutes to disable a remote SpamAssassin server if it is disabled automatically.
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
FailuresBeforeDisableInt32Number of failures before a remote SpamAssassin server is disabled automatically.
HighSpamWeightInt32Weight for High.
LogLevelSAHeaderLogLevelThe logging level.
LowSpamWeightInt32Weight for Low.
MaxAttemptsPerMessageInt32Maximum number of checks to make before skipping this check for a message.
MedSpamWeightInt32Weight for Medium.
SAHeaderLogLevel Enum
0ScoreOnly
1ScoreAndTestNames
2ScoreTestNamesAndDescription

GetReverseDNSSettings

Returns settings for Reverse DNS.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: GetReverseDNSSettingsResult

GetReverseDNSSettingsResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
settingsReverseDNSSettingsItem details, as defined in the ReverseDNSSettings class.
ReverseDNSSettingsDescription
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
WeightInt32Weight for reverse DNS failure.

GetSABPMSettings

Returns settings for SpamAssassin-based Pattern Matching.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: GetSABPMSettingsResult

GetSABPMSettingsResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
settingsSABPMSettingsItem details, as defined in the SABPMSettings class.
SABPMSettingsDescription
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
HighSpamWeightInt32Weight for High.
LogLevelSAHeaderLogLevelThe logging level.
LowSpamWeightInt32Weight for Low.
MedSpamWeightInt32Weight for Medium.
SAHeaderLogLevel Enum
0ScoreOnly
1ScoreAndTestNames
2ScoreTestNamesAndDescription

GetSPFSettings

Returns settings for SPF.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: GetSPFSettingsResult

GetSPFSettingsResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
settingsSPFSettingsItem details, as defined in the SPFSettings class.
SPFSettingsDescription
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
FailWeightInt32Weight for SPF Fail.
NeutralWeightInt32Weight for SPF Neutral.
NoneWeightInt32Weight for SPF None.
PassWeightInt32Weight for SPF Pass.
PermErrorWeightInt32Weight for SPF Perm Error.
SoftFailWeightInt32Weight for SPF Soft Fail.

ListRBLs

Lists information about all RBL checks.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: ListRBLsResult

ListRBLsResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
rblsRBLSetting[]A list of item details, as defined in the RBLSetting class.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
RBLSettingDescription
DescriptionStringA short description for display purposes.
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
HostnameStringThe hostname of the RBL.
IsURIBLBooleanTrue if the RBL supports URIBL.
NameStringThe name of the RBL list.
RequiredIPStringRequired IP.
RequiredIPEnabledBooleanTrue if RequiredIP is enabled.
UseBitmapCheckingBooleanTrue to use bitmap checking.
WeightInt32Weight when item is in RBL list.

ListSpamChecks

Lists information about all known spam checks, similar to the Antispam Administration page.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: ListSpamChecksResult

ListSpamChecksResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
spamChecksSpamCheckInfo[]A list of item details, as defined in the SpamCheckInfo class.
SpamCheckInfoDescription
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
MaxWeightInt32Maximum weight value.
MinWeightInt32Minimum weight value.
NameStringThe display name of the spam check.
UIDStringUnique identifier of the spam check.

RemoveRBL

Removes an RBL check.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
NameOfRblToRemoveStringName of the RBL check.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetBayesianSettings

Configures settings for Bayesian Filtering.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
bayesSettingsBayesianFilterSettingsNew settings to apply, as defined in the BayesianFilterSettings class.
BayesianFilterSettingsDescription
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
MaxMemoryMBInt32Maximum memory to dedicate to Bayesian Filtering.
MessagesRequiredForUpdateInt32Number of messages that get processed before Bayesian Filters get updated.
WeightInt32Max weight to give Bayesian Filtering.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetCommtouchSettings

Configures settings for Commtouch.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
commtouchSettingsCommtouchSettingsNew settings to apply, as defined in the CommtouchSettings class.
CommtouchSettingsDescription
BulkWeightInt32Weight for bulk mail.
ConfirmedWeightInt32Weight for confirmed spam.
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
NoneWeightInt32Weight for none.
SuspectWeightInt32Weight for suspected spam.
UnknownWeightInt32Weight for unknown.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetDecludeSettings

Configures settings for Declude integration.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
decludeSettingsDecludeSettingsNew settings to apply, as defined in the DecludeSettings class.
DecludeSettingsDescription
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
HighSpamWeightInt32Weight for High.
LowSpamWeightInt32Weight for Low.
MedSpamWeightInt32Weight for Medium.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetDKIMSettings

Configures settings for DKIM.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
dkSettingsDomainKeysSettingsNew settings to apply, as defined in the DomainKeysSettings class.
DomainKeysSettingsDescription
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
FailWeightInt32Weight for Fail.
MaxKeySizeDKKeySizeThe maximum key size.
MaxMessageSizeToSignMBInt32Maximum message size (in MB) that will be signed.
MaxMessageSizeToVerifyMBInt32Maximum message size (in MB) that will be verified.
NoneWeightInt32Weight for None.
PassWeightInt32Weight for Pass.
DKKeySize Enum
0_512
1_768
2_1024
3_1536
4_2048

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetDomainKeysSettings

Configures settings for DomainKeys.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
dkSettingsDomainKeysSettingsNew settings to apply, as defined in the DomainKeysSettings class.
DomainKeysSettingsDescription
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
FailWeightInt32Weight for Fail.
MaxKeySizeDKKeySizeThe maximum key size.
MaxMessageSizeToSignMBInt32Maximum message size (in MB) that will be signed.
MaxMessageSizeToVerifyMBInt32Maximum message size (in MB) that will be verified.
NoneWeightInt32Weight for None.
PassWeightInt32Weight for Pass.
DKKeySize Enum
0_512
1_768
2_1024
3_1536
4_2048

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetRemoteSASettings

Configures settings for Remote SpamAssassin.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
remoteSASettingsRemoteSASettingsNew settings to apply, as defined in the RemoteSASettings class.
RemoteSASettingsDescription
ClientTimeoutSecondsInt32Number of seconds to wait before check is considered timeout.
DisableTimeMinutesInt32The number of minutes to disable a remote SpamAssassin server if it is disabled automatically.
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
FailuresBeforeDisableInt32Number of failures before a remote SpamAssassin server is disabled automatically.
HighSpamWeightInt32Weight for High.
LogLevelSAHeaderLogLevelThe logging level.
LowSpamWeightInt32Weight for Low.
MaxAttemptsPerMessageInt32Maximum number of checks to make before skipping this check for a message.
MedSpamWeightInt32Weight for Medium.
SAHeaderLogLevel Enum
0ScoreOnly
1ScoreAndTestNames
2ScoreTestNamesAndDescription

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetReverseDNSSettings

Configures settings for Reverse DNS.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
rdnsSettingsReverseDNSSettingsNew settings to apply, as defined in the ReverseDNSSettings class.
ReverseDNSSettingsDescription
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
WeightInt32Weight for reverse DNS failure.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetSABPMSettings

Configures settings for SpamAssassin-based Pattern Matching.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
sabpmSettingsSABPMSettingsNew settings to apply, as defined in the SABPMSettings class.
SABPMSettingsDescription
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
HighSpamWeightInt32Weight for High.
LogLevelSAHeaderLogLevelThe logging level.
LowSpamWeightInt32Weight for Low.
MedSpamWeightInt32Weight for Medium.
SAHeaderLogLevel Enum
0ScoreOnly
1ScoreAndTestNames
2ScoreTestNamesAndDescription

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetSpamWizardLevel

Sets the spam checks and weights to predefined wizard levels.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
levelSpamWizardLevelNew spam wizard preset to apply.
SpamWizardLevel Enum
0DoNotChange
1Low
2Med
3High
4None

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetSPFSettings

Configures settings for SPF.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
spfSettingsSPFSettingsNew settings to apply, as defined in the SPFSettings class.
SPFSettingsDescription
EnabledFilteringBooleanTrue to enable filtering.
EnabledIncomingBlockingBooleanTrue to enable incoming SMTP blocking.
EnabledOutgoingBlockingBooleanTrue to enable outgoing SMTP blocking.
FailWeightInt32Weight for SPF Fail.
NeutralWeightInt32Weight for SPF Neutral.
NoneWeightInt32Weight for SPF None.
PassWeightInt32Weight for SPF Pass.
PermErrorWeightInt32Weight for SPF Perm Error.
SoftFailWeightInt32Weight for SPF Soft Fail.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

svcUserAdmin

http://www.mpwkitchens.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.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
EmailAddressStringFull email address of the user.
rssUrlStringURL of the RSS feed.
rssNameStringDisplay name of the RSS feed.
rssFolderStringFolder name.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

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.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
NewUsernameStringUsername for the user. Should not be a full email address.
NewPasswordStringPassword for the user.
DomainNameStringDomain to add the user.
FirstNameStringFirst name of the user.
LastNameStringLast name of the user.
IsDomainAdminBooleanTrue to make the user an administrator over the domain.
maxMailboxSizeInt32Maximum size for the user mailbox (in MB).

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AddUserGroup

Creates a new user group and adds it to the specified domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringName of the domain.
UserGroupNameStringName of the user group.
UserNamesString[]A list of users on the domain that should belong to the group.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

AuthenticateUser

Returns a true ResultCode if the user name, domain name, and password match.

Input ParametersDescription
UserNameStringUsername to authenticate.
DomainNameStringDomain that the user belongs to.
PasswordStringThe password to authenticate.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteRSSFeed

Deletes an RSS feed from the specified email address.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
EmailAddressStringFull email address of the user.
UIDStringUnique identifier of the RSS Feed.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

DeleteUser

Deletes the specified user from the specified domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
UsernameStringUsername of the user to delete.
DomainNameStringDomain on which the user exists.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetInactiveUsers

Returns inactive users since the specified date.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
dateDateTimeAll users that have not logged in since this date will be returned.

Returns: InactiveUserResult

InactiveUserResultDescription
EmailAddressString[]A list of email addresses in the result set.
LastLoginDateTime[]A list of last login times. Results in this array directly correspond to the results in the EmailAddresses array.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetLastLoginTimes

Gets last login time.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
EmailAddressStringFull email address of the user.
DateStartNullable<DateTime>If set, limits the results so that nothing will be returned before this date.
DateEndNullable<DateTime>If set, limits the results so that nothing will be returned after this date.

Returns: LastLoginInfoResult

LastLoginInfoResultDescription
lastLoginsString[]A list of the last login names.
lastUserLoginsUserLoginInfo[]A list of details about the last logins, as defined in the UserLoginInfo class.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
UserLoginInfoDescription
LoginTimeDateTimeLast login time for the user.
UserNameStringUsername for the user.

GetMigrationStatus

Returns the status of all migration requests.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.

Returns: StatusResults[]

StatusResultsDescription
emailAddressStringEmail address that is being migrated.
IDGuidUnique identifier of the migration.
statusStringStatus of the migration.

GetRequestedUserSettings

Gets the specified user's settings.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
EmailAddressStringFull email address of the user.
requestedSettingsString[]A list of keys to return settings for. Possible values are:
  • autocleanoverrideactive (Should user override domain settings)
  • autopopupreminders (Automatically popup reminders window)
  • autorespondondirectmailonly (Ignore emails sent through aliases)
  • autosavedrafttime(Save every x milliseconds)
  • composefont
  • composefontsize
  • composemethod (html, plain)
  • composerows (Delete messages after auto forwarding)
  • deleteoption (MoveToDeleteFolder, AutoPurge, MarkDeleted, MarkDeletedAndHide)
  • dictionarylanguag(en-US, etc)
  • disablegreylsting
  • displayname (Display name of the user)
  • embedreplies (Attach forwards)
  • enableanimations (obsolete)
  • enablesounds (Play sounds in the webmail interface)
  • forwardaddress (Address to forward to)
  • forwardas (attachment, normal, plain)
  • fullname (basic, full)
  • hidefromgal
  • isdomainadmin
  • isenabled
  • lockpassword
  • maxbouncesreceivedperhour
  • maxbouncesreceivedperhourenabled: (Enable/disable max bounces received per hour)
  • maxmessagesperhour
  • maxmessagesperhourenabled: (Enable/disable max messages per hour)
  • maxsize (Max mailbox size in MB)
  • maxsmtpoutbandwidthperhour
  • maxsmtpoutbandwidthperhourenabled: (Enable/disable max smtp bandwidth per hour)
  • password
  • passwordlocked
  • plusaddressingenabled
  • plusaddressingfolder
  • previewautomarkasread (Automatically mark messages as read after 5 seconds)
  • previewautopreview (Automatically preview messages)
  • previewusepreview (Use preview pane)
  • replymessageindicator (Plain text indicator, > by default)
  • replytoaddress
  • requestreceipts (Automatically request read receipts on new messages)
  • savecopyassent (Use Sent Items folder)
  • seenwelcome (Has the user seen the welcome page)
  • servicelevelmap (The enabled services for a user. This field is a bitmap composed of 1=POP, 2=IMAP, 4=INCOMING SMTP, 8=OUTGOING SMTP, 16=WEBMAIL)
  • showsusc (Show the synchronization center popup on login)
  • signature
  • skin
  • sortby (sorting of messages page)
  • sortdescending (sort in reverse order)
  • spamcheckoverrideactive (Should user override spam check settings from domain)
  • spamforwardoption (obsolete)
  • startuppage (today, messages)
  • syncpanels (not used)
  • textencoding
  • throttlingactionbandwidth: (Sets Bandwidth Throttling Action)
  • throttlingactionbounces: (Sets Bounces Throttling Action)
  • throttlingactionmessage: (Sets Message Throttling Action)
  • timezoneindex (time zone index)
  • viewmessagesas (html, plain)
  • welcomewizardprogress (progress of welcome page)

Returns: SettingsRequestResult

SettingsRequestResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
settingValuesString[]A list of setting values, in the form of 'key=value' pairs. Names of all possible settings can be found in the GetRequestedUserSettings function.

GetUser

Returns attributes of the specified user.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
EmailAddressStringFull email address of the user.

Returns: UserInfoResult

UserInfoResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
UserInfoUserInfoInformation about a user, as defined in the UserInfo class.
UserInfoDescription
FirstNameStringFirst name of the user.
IsDomainAdminBooleanTrue if the user is a domain administrator.
IsSystemAdminBooleanTrue if the user is a system administrator.
LastNameStringLast name of the user.
PasswordStringPassword for the user.
UserNameStringUsername for the user.

GetUserAutoResponseInfo

Returns the forwarding info of the specified user.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
EmailAddressStringFull email address of the user.

Returns: UserAutoResponseResult

UserAutoResponseResultDescription
BodyStringBody of auto-responses.
EnabledBooleanTrue if auto-responder is enabled.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
SubjectStringSubject of auto-responses.

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.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
EmailAddressStringFull email address of the user.

Returns: UserForwardingInfoResult2

UserForwardingInfoResult2Description
DeleteOnForwardBooleanTrue to delete emails when they are forwarded.
ForwardingAddressesString[]A list of email addresses to forward mail to.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

GetUserGroup

Gets a user group in the specified domain with the given id.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringName of the domain.
UserGroupIDStringUnique identifier of the user group.

Returns: UserGroupInfoResult

UserGroupInfoResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
UserGroupUserGroupInfoDetails of the user group, as defined in the UserGroupInfo class.
UserGroupInfoDescription
guidStringUnique identifier for the user group.
nameStringDisplay name for the user group.
userNamesString[]A list of usernames that belong to the group.

GetUserGroupsByDomain

Get all user groups in the specified domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringName of the domain.

Returns: UserGroupsResult

UserGroupsResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
UserGroupsUserGroupInfo[]A list of details about user groups, as defined in the UserGroupInfo class.
UserGroupInfoDescription
guidStringUnique identifier for the user group.
nameStringDisplay name for the user group.
userNamesString[]A list of usernames that belong to the group.

GetUserGroupsByUser

Get all user groups in the specified domain containing the give user.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringName of the domain.
UserNameStringName of user to search for.
IncludeUserNamesBooleanTrue to return other members of the groups.

Returns: UserGroupsResult

UserGroupsResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
UserGroupsUserGroupInfo[]A list of details about user groups, as defined in the UserGroupInfo class.
UserGroupInfoDescription
guidStringUnique identifier for the user group.
nameStringDisplay name for the user group.
userNamesString[]A list of usernames that belong to the group.

GetUserQuotas

Returns Current and Max disk space for each user of a domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringName of the domain.

Returns: QuotaInfoListResult

QuotaInfoListResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
UsersUserQuota[]A list of quota details, as defined in the UserQuota class.
UserQuotaDescription
CurrentSpaceInt64Current disk space used.
MaxSpaceInt64Max disk space allowed.
UserNameStringUsername for this record.

GetUsers

Returns attributes of each user in the specified domain.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringName of the domain.

Returns: UserInfoListResult

UserInfoListResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
UsersUserInfo[]A list of user details, as defined in the UserQuota class.
UserInfoDescription
FirstNameStringFirst name of the user.
IsDomainAdminBooleanTrue if the user is a domain administrator.
IsSystemAdminBooleanTrue if the user is a system administrator.
LastNameStringLast name of the user.
PasswordStringPassword for the user.
UserNameStringUsername for the user.

GetUserStats

Returns statistics of the specified user for the specified time period.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
EmailAddressStringFull email address of the user.
StartDateTimeStart date of the statistics range to retrieve.
EndDateTimeEnd date of the statistics range to retrieve.

Returns: StatInfoResult

StatInfoResultDescription
BytesReceivedInt64The number of bytes received.
BytesSentInt64The number of bytes sent.
BytesSizeInt64The size on disk.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
MessagesReceivedInt64Number of messages received.
MessagesSentInt64Number of messages sent.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

IsUserEnabledForActiveSync

Enables or disables ActiveSync for the specified user.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
EmailAddressStringFull email address of the user.
EnabledBooleanThis parameter is unused.

Returns: ActiveSyncEnabledResult

ActiveSyncEnabledResultDescription
EnabledBooleanTrue if ActiveSync is enabled.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

ListRSSFeeds

Lists all RSS feeds for the specified email address.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
EmailAddressStringFull email address of the user.

Returns: RSSFeedListResult

RSSFeedListResultDescription
FoldersString[]A list of folder names.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.
RSSFeedsRSSFeed[]A list of details about the feeds, as defined in the RSSFeed class.
RSSFeedDescription
folderStringFolder name that the feed belongs to.
nameStringDisplay name for the feed.
uidStringUnique identifier for the feed.
urlStringURL at which the feed is located.

LoginValidated

Returns a LoginResult object with the LoginValidated field set to True if the specified username matches the specified password.

Input ParametersDescription
UsernameStringUsername to check.
PasswordStringPassword to check.

Returns: LoginResult

LoginResultDescription
LoginValidatedBooleanTrue if the login is valid.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultCodeInt32A result code, which differs by function.

QueueMailBoxMigration

Adds a request item to be migrated to a specified mailbox.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
parametersString[]A list of 'key=value' pairs defining the import parameters. Possible values are:
  • ACCOUNTTYPE - POP,IMAP, EXCHANGE
  • DELETECURRENTMAILBOX - true/false, clear current mailbox before migration process
  • DESTINATION - Email address of destination mailbox on the server.
  • DOMAIN - Exchange 2007 or later target domain
  • IMPORTITEMS - Type of items to import, Possible values... email, contacts, calendar, tasks, notes
  • IMPORTTYPE - Type of import, Possible values... hotmail, yahoo, other, mailenable, imail, mdaemon, icewarp, communigate, kerio, openxchange, zimbra, exchangeother, gmail, exchange2007orlater
  • PASSWORD - Password of source mailbox
  • PORT - Connection port to target server
  • SERVERADDRESS - address of target server
  • USERNAME - Username of source mailbox
  • USESSL -use ssl during the migration, true/false

Returns: RequestStatusResult

RequestStatusResultDescription
KeyValuePairsString[]A list of 'key=value' pairs. A list of keys can be found in the QueueMailBoxMigration function.
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

RemoveFromMigrationQueue

Removes an item by ID from the pending migration queue.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
itemIDGuidUnique identifier of item to remove.

Returns: Void

RemoveUserGroup

Deletes a user group from the specified domain with the given id.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringName of the domain.
UserGroupIDStringUnique identifier of the user group to delete.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

SetRequestedUserSettings

Updates the specified user's settings.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
EmailAddressStringFull email address of the user.
newSettingsString[]A list of 'key=value' pairs of settings to modify. A full list of the keys can be found in the GetRequestedUserSettings function.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

ToggleActiveSync

Enables or disables ActiveSync for the specified user.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
EmailAddressStringFull email address of the user.
EnabledBooleanTrue to enable ActiveSync.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

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.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
EmailAddressStringFull email address of the user to update.
NewPasswordStringNew password for the user.
NewFirstNameStringNew first name of the user.
NewLastNameStringNew last name of the user.
IsDomainAdminBooleanTrue to make the user an administrator over the domain.
maxMailboxSizeInt32Maximum size for the user mailbox (in MB).

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

UpdateUserAutoResponseInfo

Updates the specified user's auto response settings.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
EmailAddressStringFull email address of the user to update.
EnabledBooleanTrue to enable the auto-responder.
SubjectStringSubject of the auto-response email.
BodyStringBody of the auto-response email.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

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).

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
EmailAddressStringFull email address of the user to update.
DeleteOnForwardBooleanTrue to delete emails that are forwarded.
ForwardingAddressesString[]A list of email addresses to forward to.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.

UpdateUserGroup

Updates a user group in the specified domain with the given id.

Input ParametersDescription
AuthUserNameStringUsername with permissions to call this web service.
AuthPasswordStringPassword of the account used in authUserName parameter.
DomainNameStringName of the domain.
UserGroupIDStringUnique identifier of the user group to update.
UserGroupNameStringNew name of the user group.
UserNamesString[]New list of users on the domain that should belong to the group.

Returns: GenericResult

GenericResultDescription
MessageStringA text message explaining the results of the operation, including the reason for any failures.
ResultBooleanReturns true if the function call was successful.
ResultCodeInt32A result code, which differs by function.