SmarterMail Web Services

http://dgxdatacenter-001-site2.mysitepanel.net/Services/svcAliasAdmin.asmx

This web service handles all functions dealing with user aliases.

Functions
AddAlias	Creates a new alias and adds it to the specified domain.
DeleteAlias	Deletes the specified alias.
GetAlias	Returns details about the specified alias.
GetAliases	Returns all aliases that belong to the specified domain.
SetCatchAll	Sets the specified alias to be the catch-all, or clears the catch-all if a blank alias name is provided.
UpdateAlias	Updates the addresses of the specified alias.

AddAlias

Creates a new alias and adds it to the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The full name of the domain.
`AliasName`	String	The name of the alias to add.
`Addresses`	String[]	A list of email addresses that this alias resolves to.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteAlias

Deletes the specified alias. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The full name of the domain.
`AliasName`	String	The name of the alias.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetAlias

Returns details about the specified alias. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The full name of the domain.
`AliasName`	String	The name of the alias.

Returns AliasInfoResult

AliasInfoResult		Description
`AliasInfo`	AliasInfo	Details about the alias, as defined in the AliasInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AliasInfo		Description
`Addresses`	String[]	A list of email addresses that the alias resolves to.
`Name`	String	The name of the alias.

GetAliases

Returns all aliases that belong to the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The full name of the domain.

Returns AliasInfoListResult

AliasInfoListResult		Description
`AliasInfos`	AliasInfo[]	A list of alias details, as defined in the AliasInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AliasInfo		Description
`Addresses`	String[]	A list of email addresses that the alias resolves to.
`Name`	String	The 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. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The full name of the domain.
`AliasName`	String	The name of the alias.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

UpdateAlias

Updates the addresses of the specified alias. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The full name of the domain.
`AliasName`	String	The name of the alias to modify.
`Addresses`	String[]	The new list of email addresses that this alias resolves to.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

http://dgxdatacenter-001-site2.mysitepanel.net/Services/svcDomainAdmin.asmx

This web service handles all functions dealing with domains.

WSDL Definition

Functions
AddDomain	Creates a new domain on the server.
AddDomainEx	Creates a new domain using the system's default domain settings.
AddDomainForwardingBlock	Adds a domain forwarding block.
DeleteDomain	Deletes the specified domain, optionally removing data files.
DeleteDomainForwardBlockByTargetAddress	Deletes a domain forwarding block by the target IP Address.
DeleteDomainForwardingBlock	Deletes a domain forwarding block.
DisableDomain	Disables a specific domain in SmarterMail.
EnableDomain	Re-enables a specific domain in SmarterMail.
GenerateDomainKeysCert	Generates a DomainKeys certificate for a domain.
GetAllDomainAliases	Returns all domain aliases.
GetAllDomainAliasesWithProperties	Returns all domain aliases with specific properties.
GetAllDomains	Returns a list of all domain names.
GetAllDomainStatistics	Returns the statistics for all domains over the specified period of time.
GetAllDomainsWithProperties	Returns a list of domains with property set.
GetAllDomainUsersWithProperties	Returns all domain aliases with specific properties.
GetDomainCounts	Returns the usage counts for the specified domain.
GetDomainDefaults	Returns the default domain settings in a DomainSettingsResult object.
GetDomainForwarding	Returns the domain forwarding configuration.
GetDomainForwardingBlock	Returns information about a specific domain forwarding block.
GetDomainForwardingBlockByTargetAddress	Returns information about a specific domain forwarding block given a target IP.
GetDomainInfo	Retrieves the name and path of a domain.
GetDomainInfo2	Retrieves the name and path of a domain.
GetDomainKeysCert	Retrieves the DomainKeys certificate for a domain.
GetDomainSettings	Returns the settings for a specific domain.
GetDomainStatistics	Returns the statistics for the specified domain over a period of time.
GetDomainUsers	Returns all valid usernames for the domain, including users, aliases, and mailing lists.
GetPrimaryDomainAdmin	Retrieves information about the primary domain administrator for the specified domain.
GetRequestedDomainDefaults	Returns the requested default domain settings.
GetRequestedDomainSettings	Gets the settings for the specified domain.
ReloadDomain	Reloads the settings for the specified domain from disk.
RenameDomain	Renames the specified domain in SmarterMail. Also updates the physical domain data path on the hard drive.
SetDomainArchiveRule	Adds a request item to be migrated to a specified mailbox.
SetDomainForwardingBlock	Updates the target address and domains in a specific domain forwarding block.
SetDomainForwardingBlockByTargetAddress	Updates the domains in a domain forwarding block forwarding to a specific target IP.
SetPrimaryDomainAdmin	Sets the specified user to be the primary domain admin of the specified domain.
SetRequestedDomainDefaults	Updates the default settings for domains.
SetRequestedDomainSettings	Updates the settings for a specified domain.
UpdateDomain	Updates the settings for the specified domain.
UpdateDomainNameAndPath	Changes the specified domain's name and path. Data is not copied or moved. This must be done prior to calling this method. The recommendation is to disable the domain, copy the data, call this function, then re-enable the domain. Once it is confirmed that the domain is operating correctly, delete the old path.

AddDomain

Creates a new domain on the server. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain name to add, in the format 'example.com'.
`Path`	String	The full path of the location in which the domain data should be stored.
`PrimaryDomainAdminUserName`	String	The username for the domain administrator.
`PrimaryDomainAdminPassword`	String	The password for the domain administrator.
`PrimaryDomainAdminFirstName`	String	The first name for the domain administrator.
`PrimaryDomainAdminLastName`	String	The last name for the domain administrator.
`IP`	String	The IP Address on which the domain should listen.
`ImapPort`	Int32	The port number on which the domain should accept IMAP connections.
`PopPort`	Int32	The port number on which the domain should accept POP connections.
`SmtpPort`	Int32	The port number on which the domain should accept SMTP connections.
`MaxAliases`	Int32	The maximum number of user aliases the domain is allowed to have. Pass 0 for unlimited.
`MaxDomainSizeInMB`	Int64	The maximum disk space the domain is allowed to occupy. Pass 0 for unlimited.
`MaxDomainUsers`	Int32	The maximum number of users the domain is allowed to have. Pass 0 for unlimited.
`MaxMailboxSizeInMB`	Int32	This parameter is no longer used.
`MaxMessageSize`	Int32	The maximum size a message can be on the domain. Pass 0 for unlimited.
`MaxRecipients`	Int32	The maximum number of recipients a message can contain on the domain. Pass 0 for unlimited.
`MaxDomainAliases`	Int32	The maximum number of domain aliases that can be assigned to the domain. Pass 0 for unlimited.
`MaxLists`	Int32	The maximum number of mailing lists the domain is allowed to have. Pass 0 for unlimited.
`ShowDomainAliasMenu`	Boolean	True to allow domain administrators to modify domain aliases.
`ShowContentFilteringMenu`	Boolean	True to allow users to manage content filtering settings.
`ShowSpamMenu`	Boolean	True to allow users to manage their own spam settings.
`ShowStatsMenu`	Boolean	This parameter is no longer used.
`RequireSmtpAuthentication`	Boolean	True to require SMTP Authentication when relaying email.
`ShowListMenu`	Boolean	True to allow domain administrators to manage mailing lists.
`ListCommandAddress`	String	The username of the 'list command address.' This is usually a value such as stserv or listserv.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddDomainEx

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

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain name to add, in the format 'example.com'.
`Path`	String	The full path of the location in which the domain data should be stored.
`PrimaryDomainAdminUserName`	String	The username for the domain administrator.
`PrimaryDomainAdminPassword`	String	The password for the domain administrator.
`PrimaryDomainAdminFirstName`	String	The first name for the domain administrator.
`PrimaryDomainAdminLastName`	String	The last name for the domain administrator.
`IP`	String	The IP Address on which the domain should listen.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddDomainForwardingBlock

Adds a domain forwarding block. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`targetAddress`	String	The IP Address that will receive mail for the specified domains.
`domains`	String[]	An array that specifies the domain names to forward.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteDomain

Deletes the specified domain, optionally removing data files. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain to delete.
`DeleteFiles`	Boolean	True to permanently delete all email and configuration data for the domain.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteDomainForwardBlockByTargetAddress

Deletes a domain forwarding block by the target IP Address. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`targetAddress`	String	The IP Address of the target for the block you wish to delete.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteDomainForwardingBlock

Deletes a domain forwarding block. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`blockID`	Int32	The numeric ID of the forwarding block to delete.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DisableDomain

Disables a specific domain in SmarterMail. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`domainName`	String	The domain name to modify.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

EnableDomain

Re-enables a specific domain in SmarterMail. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`domainName`	String	The domain name to modify.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GenerateDomainKeysCert

Generates a DomainKeys certificate for a domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain.
`KeySize`	Int32	Size of the certificate key, in bits. Possible values are: 512 768 1024 1536 2048
`selector`	String	DomainKeys selector to use.

Returns DomainKeyResult

DomainKeyResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`privateKey`	String	The private key.
`publicKey`	String	The public key.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`selector`	String	The DomainKeys selector.

GetAllDomainAliases

Returns all domain aliases. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns DomainAliasInfoResult

DomainAliasInfoResult		Description
`DomainAliases`	DomainAliasInfo[]	A list of domain alias info records, as defined in the DomainAliasInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DomainAliasInfo		Description
`DomainName`	String	The domain name to which the alias points.
`Name`	String	The name of the alias.

GetAllDomainAliasesWithProperties

Returns all domain aliases with specific properties. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`PropertyKeys`	String[]	List of 'keys' for property return set.

Returns GenericPropertyResult

GenericPropertyResult		Description
`Data`	PropertyResultData[]
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

PropertyResultData		Description
`Name`	String
`Properties`	String[]

GetAllDomains

Returns a list of all domain names. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns DomainListResult

DomainListResult		Description
`DomainNames`	String[]	An array of domain names.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetAllDomainStatistics

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

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`StartDate`	DateTime	The start point of the date range to return.
`EndDate`	DateTime	The end point of the date range to return.

Returns AllDomainStatResult

AllDomainStatResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Stats`	DomainStatInfo[]	A list of statistic records for each domain, as defined in the the DomainStatInfo class.

DomainStatInfo		Description
`BytesReceived`	Int64	The number of bytes received.
`BytesSent`	Int64	The number of bytes sent.
`BytesSize`	Int64	The size of the domain on disk.
`DomainName`	String	The name of the domain.
`MessagesReceived`	Int64	The number of messages received.
`MessagesSent`	Int64	The number of messages sent.

GetAllDomainsWithProperties

Returns a list of domains with property set. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`PropertyKeys`	String[]	An array of 'keys' of settings to retrieve. 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 enablemailsigning - Enables mailing signing (Domain Keys and DKIM) enabledomainkeysigning - Enable Domain Keys signing enabledkimsigning - Enable DKIM signing enabledomainuserservicecontrol - Enables control of Service Access Control enableemailreports - Enable email reports enablepopretrieval - Enable POP retrieval enableimapretrieval - Enable IMAP retrieval enablesmtpaccounts - Enable SMTP accounts enablexmpp - Enable XMPP communication enableactivesyncaccountmanagement - Enable domain-level ActiveSync management maxactivesyncaccounts - Max ActiveSync accounts. This limit is enforced only when adding new accounts. Before lowering limit through the API, check that the domain isn't over the limit already using functions in svcUserAdmin.asmx. enablechathistory - Enable domain chat history imapport - IMAP port acceptmail - Does the domain accept mail isenabled - Domain enabled ldapport - LDAP port listcommandaddress - Listserv command address locationtype - Server location type: local, externalmx, externalhostaddress locationhostaddress - External server host address (IP or FQDN) locationdeliverlocally - Enable local message delivery if user exists 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 serveripv6 - IPv6 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 GenericPropertyResult

GenericPropertyResult		Description
`Data`	PropertyResultData[]
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

PropertyResultData		Description
`Name`	String
`Properties`	String[]

GetAllDomainUsersWithProperties

Returns all domain aliases with specific properties. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the target domain to retrieve information from.
`PropertyKeys`	String[]	List of 'keys' for property return set.

Returns DomainUserInfoWithPropertiesResult

DomainUserInfoWithPropertiesResult		Description
`CatchAll`	Boolean
`DomainAliases`	PropertyResultData[]
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Users`	PropertyResultData[]

PropertyResultData		Description
`Name`	String
`Properties`	String[]

GetDomainCounts

Returns the usage counts for the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain for which counts should be received.

Returns DomainCountInfoResult

DomainCountInfoResult		Description
`Aliases`	Int32	The number of user aliases.
`MailingLists`	Int32	The number of mailing lists.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Size`	Int64	The disk size of the domain.
`Users`	Int32	The number of users.

GetDomainDefaults

Returns the default domain settings in a DomainSettingsResult object. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns DomainSettingsResult

DomainSettingsResult		Description
`ImapPort`	Int32	The port on which the domain listens for IMAP connections.
`ListCommandAddress`	String	The username for mailing list commands.
`MaxAliases`	Int32	The max number of user aliases for the domain (0=unlimited).
`MaxDomainAliases`	Int32	The max number of domain aliases for the domain (0=unlimited).
`MaxDomainSizeInMB`	Int64	The max amount of disk space allowed to the domain (0=unlimited).
`MaxDomainUsers`	Int32	The max number of users for the domain (0=unlimited).
`MaxLists`	Int32	The max number of mailing lists for the domain (0=unlimited).
`MaxMailboxSizeInMB`	Int32	This value is no longer used.
`MaxMessageSize`	Int32	The max size allowed per message (0=unlimited).
`MaxRecipients`	Int32	The max number of receipients per message (0=unlimited).
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Path`	String	The physical path to the domain data files.
`PopPort`	Int32	The port on which the domain listens for POP connections.
`RequireSmtpAuthentication`	Boolean	True if SMTP Authentication is required.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`ServerIP`	String	The IP Address on which the domain listens.
`ShowContentFilteringMenu`	Boolean	True to allow domain users to set up content filters.
`ShowDomainAliasMenu`	Boolean	True to allow domain administrators to create domain aliases.
`ShowListMenu`	Boolean	True to allow domain administrators to modify mailing lists.
`ShowSpamMenu`	Boolean	True to allow domain users to modify spam settings.
`ShowStatsMenu`	Boolean	This value is no longer used.
`SmtpPort`	Int32	The port on which the domain listens for SMTP connections.

GetDomainForwarding

Returns the domain forwarding configuration. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`includeDomains`	Boolean	True to include domains in the results. False to only include target addresses.

Returns DomainForwardInfoResult

DomainForwardInfoResult		Description
`blocks`	DomainForwardBlockInfo[]	A list of details about the domain forward blocks, as defined in the DomainForwardBlockInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DomainForwardBlockInfo		Description
`blockID`	Int32	The numeric ID of the block.
`domains`	String[]	A list of domain names that will forward to the address in targetAddress.
`targetAddress`	String	The IP Address of the server that will receive the forwarded email.

GetDomainForwardingBlock

Returns information about a specific domain forwarding block. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`blockID`	Int32	The numeric ID of the forwarding block.

Returns DomainForwardBlockInfoResult

DomainForwardBlockInfoResult		Description
`domainForwardBlock`	DomainForwardBlockInfo	Details about the domain forward block, as defined in the DomainForwardBlockInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DomainForwardBlockInfo		Description
`blockID`	Int32	The numeric ID of the block.
`domains`	String[]	A list of domain names that will forward to the address in targetAddress.
`targetAddress`	String	The IP Address of the server that will receive the forwarded email.

GetDomainForwardingBlockByTargetAddress

Returns information about a specific domain forwarding block given a target IP. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`targetAddress`	String	The IP Address of the target of the block.

Returns DomainForwardBlockInfoResult

DomainForwardBlockInfoResult		Description
`domainForwardBlock`	DomainForwardBlockInfo	Details about the domain forward block, as defined in the DomainForwardBlockInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DomainForwardBlockInfo		Description
`blockID`	Int32	The numeric ID of the block.
`domains`	String[]	A list of domain names that will forward to the address in targetAddress.
`targetAddress`	String	The IP Address of the server that will receive the forwarded email.

GetDomainInfo

Retrieves the name and path of a domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`domainName`	String	The name of the domain.

Returns DomainInfoResult

DomainInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Path`	String	The physical path to the domain files.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetDomainInfo2

Retrieves the name and path of a domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`domainName`	String	The name of the domain.

Returns DomainInfoResult2

DomainInfoResult2		Description
`AliasCount`	Int32
`DomainAliasCount`	Int32
`FileStorageSizeMb`	Int64
`IsEnabled`	Boolean
`LastChanged`	DateTime
`ListCount`	Int32
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Name`	String
`Path`	String	The physical path to the domain files.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`SizeMb`	Int64
`Status`	String
`UserCount`	Int32

GetDomainKeysCert

Retrieves the DomainKeys certificate for a domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain.

Returns DomainKeyResult

DomainKeyResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`privateKey`	String	The private key.
`publicKey`	String	The public key.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`selector`	String	The DomainKeys selector.

GetDomainSettings

Returns the settings for a specific domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`domainName`	String	The name of the domain.

Returns DomainSettingsResult

DomainSettingsResult		Description
`ImapPort`	Int32	The port on which the domain listens for IMAP connections.
`ListCommandAddress`	String	The username for mailing list commands.
`MaxAliases`	Int32	The max number of user aliases for the domain (0=unlimited).
`MaxDomainAliases`	Int32	The max number of domain aliases for the domain (0=unlimited).
`MaxDomainSizeInMB`	Int64	The max amount of disk space allowed to the domain (0=unlimited).
`MaxDomainUsers`	Int32	The max number of users for the domain (0=unlimited).
`MaxLists`	Int32	The max number of mailing lists for the domain (0=unlimited).
`MaxMailboxSizeInMB`	Int32	This value is no longer used.
`MaxMessageSize`	Int32	The max size allowed per message (0=unlimited).
`MaxRecipients`	Int32	The max number of receipients per message (0=unlimited).
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Path`	String	The physical path to the domain data files.
`PopPort`	Int32	The port on which the domain listens for POP connections.
`RequireSmtpAuthentication`	Boolean	True if SMTP Authentication is required.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`ServerIP`	String	The IP Address on which the domain listens.
`ShowContentFilteringMenu`	Boolean	True to allow domain users to set up content filters.
`ShowDomainAliasMenu`	Boolean	True to allow domain administrators to create domain aliases.
`ShowListMenu`	Boolean	True to allow domain administrators to modify mailing lists.
`ShowSpamMenu`	Boolean	True to allow domain users to modify spam settings.
`ShowStatsMenu`	Boolean	This value is no longer used.
`SmtpPort`	Int32	The port on which the domain listens for SMTP connections.

GetDomainStatistics

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

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain.
`StartDate`	DateTime	The start point of the date range to return.
`EndDate`	DateTime	The end point of the date range to return.

Returns StatInfoResult

StatInfoResult		Description
`BytesReceived`	Int64	The number of bytes received.
`BytesSent`	Int64	The number of bytes sent.
`BytesSize`	Int64	The size of the item on disk.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`MessagesReceived`	Int64	The number of messages received.
`MessagesSent`	Int64	The number of messages sent.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetDomainUsers

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

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain.

Returns DomainUserInfoResult

DomainUserInfoResult		Description
`CatchAll`	Boolean	True if the domain has a catch-all.
`DomainAliases`	String[]	An array of domain aliases associated to the domain.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Users`	String[]	An array of users for the domain.

GetPrimaryDomainAdmin

Retrieves information about the primary domain administrator for the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain.

Returns PrimaryDomainAdminResult

PrimaryDomainAdminResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`PrimaryAdmin`	String	The username of the primary domain administrator.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetRequestedDomainDefaults

Returns the requested default domain settings. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`requestedSettings`	String[]	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 to once per day per sender defaultbypassgreylisting - Bypass greylisting defaultenablecatchalls - Enable Catch-alls defaultdeliverpostmastertodomainadmin - Use primary domain admin as postmaster address if there is no postmaster account defaultlocationtype - Domain Location defaultlocationdeliverlocally - Deliver locally, if the user exists defaultenablemailsigning - Enable mail signing (Domain Keys and DKIM) defaultenableemailreports - Enable Email Reports defaultenablefilestorage - Enable File Storage defaultenableimapretrieval - Enable IMAP Retrieval defaultenablepopretrieval - Enable POP Retrieval defaultenablesmtpaccounts - Enable SMTP Accounts defaultenablexmpp - Enable XMPP communication defaultenableactivesyncaccountmanagement - Enable domain-level ActiveSync management defaultmaxactivesyncaccounts - Max ActiveSync accounts. This limit is enforced only when adding new accounts. Before lowering limit through the API, check that the domain isn't over the limit already using functions in svcUserAdmin.asmx. 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 defaultenablechathistory - Chat history viewing enabled on domain 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

SettingsRequestResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settingValues`	String[]	An array of 'key=value' pairs containing the setting values.

GetRequestedDomainSettings

Gets the settings for the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain.
`requestedSettings`	String[]	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 deliverpostmastertodomainadmin - User primary domain admin as postmaster if there is no postmaster account domainurl - Logout URL enablecatchalls - Enable catch-alls enablemailsigning - Enables mailing signing (Domain Keys and DKIM) enabledomainkeysigning - Enable Domain Keys signing enabledkimsigning - Enable DKIM signing enabledomainuserservicecontrol - Enables control of Service Access Control enableemailreports - Enable email reports enablepopretrieval - Enable POP retrieval enableimapretrieval - Enable IMAP retrieval enablesmtpaccounts - Enable SMTP accounts enablexmpp - Enable XMPP communication enableactivesyncaccountmanagement - Enable domain-level ActiveSync management maxactivesyncaccounts - Max ActiveSync accounts. This limit is enforced only when adding new accounts. Before lowering limit through the API, check that the domain isn't over the limit already using functions in svcUserAdmin.asmx. enablechathistory - Enable domain chat history imapport - IMAP port acceptmail - Does the domain accept mail isenabled - Domain enabled ldapport - LDAP port listcommandaddress - Listserv command address locationtype - Server location type: local, externalmx, externalhostaddress locationhostaddress - External server host address (IP or FQDN) locationdeliverlocally - Enable local message delivery if user exists 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 serveripv6 - IPv6 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

SettingsRequestResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settingValues`	String[]	An array of 'key=value' pairs containing the setting values.

ReloadDomain

Reloads the settings for the specified domain from disk. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain to reload.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

RenameDomain

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

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`OldDomainName`	String	The name of the domain to modify.
`NewDomainName`	String	The new name for the domain.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetDomainArchiveRule

Adds a request item to be migrated to a specified mailbox. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`parameters`	String[]	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

SettingsRequestResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settingValues`	String[]	An array of 'key=value' pairs containing the setting values.

SetDomainForwardingBlock

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

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`blockID`	Int32	The numeric ID of the forwarding block.
`targetAddress`	String	The new IP Address of the target of the block.
`domains`	String[]	The new array of domain names that forward to the address in targetAddress.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetDomainForwardingBlockByTargetAddress

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

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`targetAddress`	String	The IP Address of the target of the block.
`domains`	String[]	The new array of domain names that forward to the address in targetAddress.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetPrimaryDomainAdmin

Sets the specified user to be the primary domain admin of the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain.
`AdminUserName`	String	The name of the user that will be the new primary domain administrator. This user must already exist.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetRequestedDomainDefaults

Updates the default settings for domains. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`newSettings`	String[]	An array of 'key=value' pairs of settings to change. Key can be any of the items defined in the GetRequestedDomainDefaults function.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetRequestedDomainSettings

Updates the settings for a specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain to modify.
`newSettings`	String[]	An array of 'key=value' pairs of settings to change. Key can be any of the items defined in the GetRequestedDomainSettings function.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

UpdateDomain

Updates the settings for the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain to modify.
`ServerIP`	String	The IP Address on which the domain should listen.
`ImapPort`	Int32	The port that this domain will use for incoming IMAP connections.
`PopPort`	Int32	The port that this domain will use for incoming POP connections.
`SmtpPort`	Int32	The port that this domain will use for incoming SMTP connections.
`MaxAliases`	Int32	The maximum number of user aliases the domain is allowed to have. Pass 0 for unlimited.
`MaxDomainSizeInMB`	Int64	The maximum disk space the domain is allowed to occupy. Pass 0 for unlimited.
`MaxDomainUsers`	Int32	The maximum number of users the domain is allowed to have. Pass 0 for unlimited.
`MaxMailboxSizeInMB`	Int32	This parameter is no longer used.
`MaxMessageSize`	Int32	The maximum size a message can be on the domain. Pass 0 for unlimited.
`MaxRecipients`	Int32	The maximum number of recipients a message can contain on the domain. Pass 0 for unlimited.
`MaxDomainAliases`	Int32	The maximum number of domain aliases that can be assigned to the domain. Pass 0 for unlimited.
`MaxLists`	Int32	The maximum number of mailing lists the domain is allowed to have. Pass 0 for unlimited.
`ShowDomainAliasMenu`	Boolean	True to allow domain administrators to modify domain aliases.
`ShowContentFilteringMenu`	Boolean	True to allow users to manage content filtering settings.
`ShowSpamMenu`	Boolean	True to allow users to manage their own spam settings.
`ShowStatsMenu`	Boolean	This parameter is no longer used.
`RequireSmtpAuthentication`	Boolean	True to require SMTP Authentication when relaying email.
`ShowListMenu`	Boolean	True to allow domain administrators to manage mailing lists.
`ListCommandAddress`	String	The username of the 'list command address.' This is usually a value such as stserv or listserv.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A 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. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`OldDomainName`	String	The name of the domain to modify.
`NewDomainName`	String	The new name for the domain.
`NewDomainPath`	String	The new path to the domain data.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

http://dgxdatacenter-001-site2.mysitepanel.net/Services/svcDomainAliasAdmin.asmx

This web service handles all functions dealing with domain aliases.

WSDL Definition

Functions
AddDomainAlias	Creates a new domain alias and adds it to the specified domain.
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. This function can not be called by domain administrators to avoid a domain such as gmail.com being added as an alias.
DeleteDomainAlias	Deletes the specified domain alias from SmarterMail.
GetAliases	Returns all domain aliases that point to the specified domain.

AddDomainAlias

Creates a new domain alias and adds it to the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain.
`DomainAliasName`	String	The name of the domain alias to create.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A 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. This function can not be called by domain administrators to avoid a domain such as gmail.com being added as an alias. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain.
`DomainAliasName`	String	The name of the domain alias to create.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteDomainAlias

Deletes the specified domain alias from SmarterMail. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain.
`DomainAliasName`	String	The name of the domain alias to remove.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetAliases

Returns all domain aliases that point to the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain.

Returns DomainAliasInfoListResult

DomainAliasInfoListResult		Description
`DomainAliasNames`	String[]	A list of domain names.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

http://dgxdatacenter-001-site2.mysitepanel.net/Services/svcGlobalUpdate.asmx

This web service allows for changing settings across all domains.

WSDL Definition

Functions
GetGlobalUpdateStatus	Gets the current status of the update, indicating how many domains have been updated so far.
ListGlobalUpdateFields	Lists all the fields that can be updated using UpdateAllDomainSettings.
UpdateAllDomainSettings	Sets the supplied fields and values for all domains on the server.

GetGlobalUpdateStatus

Gets the current status of the update, indicating how many domains have been updated so far. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns GlobalUpdateStatusResult

GlobalUpdateStatusResult		Description
`finishedCount`	Int32	The number of domain updates that have been completed.
`isRunning`	Boolean	True if a global update operation is in progress.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`totalUpdateCount`	Int32	The number of domains that are being updated.

ListGlobalUpdateFields

Lists all the fields that can be updated using UpdateAllDomainSettings. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns GlobalUpdateFieldListResult

GlobalUpdateFieldListResult		Description
`fields`	GlobalUpdateFieldInfoResult[]	A list of fields that can be updated with the web service, as defined in the GlobalUpdateFieldInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GlobalUpdateFieldInfoResult		Description
`defaultValue`	String	The default value for the field.
`description`	String	A description of what the field controls.
`name`	String	The name of the field.
`type`	String	The data type for the field.

UpdateAllDomainSettings

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

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`fields`	DomainSettingFieldStruct[]	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.

DomainSettingFieldStruct		Description
`name`	String	The name of the field.
`val`	String	The value of the field.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

http://dgxdatacenter-001-site2.mysitepanel.net/Services/svcMailListAdmin.asmx

This web service handles all functions dealing with mailing lists.

WSDL Definition

Functions
AddDefaultSubscriberField	Adds a default subscriber field to the specified domain.
AddDigestSubscriber	Adds a digest subscriber to the specified list.
AddList	Adds a mailing list to the specified domain.
AddSubscriber	Adds a subscriber to the specified list.
AddSubscriber2	Adds subscribers for the given list.
DeleteAllLists	Deletes all mailing lists that belong to the specified domain.
DeleteDefaultSubscriberField	Deletes a subscriber field from the specified domain.
DeleteList	Deletes a specific mailing list that belongs to a domain.
GetDefaultSubscriberFields	Gets the default subscriber fields for the specified domain.
GetDigestSubscriberList	Returns the digest subscribers for the given list.
GetListCommandAddress	Gets the command list address for the specified domain.
GetMailingListsByDomain	Returns all mailing lists for the specified domain.
GetPosterKillList	Returns the kill list (blocked posters) the given list.
GetPosterWhiteList	Returns the poster whitelist for the given list.
GetRequestedListSettings	Gets specific settings for the specified list.
GetSubscriberFields	Gets the subscriber fields for the specified user.
GetSubscriberList	Returns the subscribers for the given list.
RemoveDigestSubscriber	Removes a digest subscriber to the specified list.
RemoveSubscriber	Removes a subscriber to the specified list.
SetDigestSubscriberList	Sets the digest subscribers for the given list.
SetListCommandAddress	Sets the command list address for the specified domain.
SetPosterKillList	Sets the kill list (blocked posters) for the given list.
SetPosterWhiteList	Sets the poster whitelist for the given list.
SetRequestedListSettings	Sets specific settings for the specified list.
SetSubscriberList	Sets the subscribers for the given list.
SetSubscriberList2	Sets the subscribers for the given list.
UpdateDefaultSubscriberField	Updates a default subscriber field for the specified domain.
UpdateSubscriberField	Updates the subscriber field for the specified subscriber.

AddDefaultSubscriberField

Adds a default subscriber field to the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`SubscriberFieldName`	String	The name of the new subscriber field.
`SubscriberFieldValue`	String	The value of the new subscriber field.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddDigestSubscriber

Adds a digest subscriber to the specified list. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`ListName`	String	The name of the mailing list.
`Subscriber`	String	The email address of the digest subscriber to add.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddList

Adds a mailing list to the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`ListName`	String	The name of the mailing list.
`Moderator`	String	The domain user that is the moderator of the list.
`Description`	String	A textual description for the list.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddSubscriber

Adds a subscriber to the specified list. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`ListName`	String	The name of the mailing list.
`Subscriber`	String	The email address of the subscriber to add.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddSubscriber2

Adds subscribers for the given list. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String
`ListName`	String
`Subscribers`	String[]

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteAllLists

Deletes all mailing lists that belong to the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain to modify.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteDefaultSubscriberField

Deletes a subscriber field from the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`SubscriberFieldName`	String	The name of the new subscriber field.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteList

Deletes a specific mailing list that belongs to a domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`ListName`	String	The name of the mailing list to delete.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetDefaultSubscriberFields

Gets the default subscriber fields for the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.

Returns SubscriberFieldListResult

SubscriberFieldListResult		Description
`Count`	Int32	The count of subscriber fields.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`SubscriberFields`	SubscriberFieldType[]	A list of SubscriberFieldType values.

SubscriberFieldType		Description
`Name`	String	Subscriber field name
`Value`	String	Subscriber field value

GetDigestSubscriberList

Returns the digest subscribers for the given list. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`ListName`	String	The name of the mailing list.

Returns SubscriberListResult

SubscriberListResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Subscribers`	String[]	A list of email addresses.

GetListCommandAddress

Gets the command list address for the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain.

Returns ListCommandResult

ListCommandResult		Description
`commandAddress`	String	The name of the list command address.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetMailingListsByDomain

Returns all mailing lists for the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain.

Returns MailingListResult

MailingListResult		Description
`listNames`	String[]	A list of mailing list names.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetPosterKillList

Returns the kill list (blocked posters) the given list. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`ListName`	String	The name of the mailing list.

Returns SubscriberListResult

SubscriberListResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Subscribers`	String[]	A list of email addresses.

GetPosterWhiteList

Returns the poster whitelist for the given list. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`ListName`	String	The name of the mailing list.

Returns SubscriberListResult

SubscriberListResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Subscribers`	String[]	A list of email addresses.

GetRequestedListSettings

Gets specific settings for the specified list. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`ListName`	String	The name of the mailing list.
`requestedSettings`	String[]	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) [DEPRECATED] replytolist (true/false) - Use listreplytoaddress setting instead digestmode (true/false) sendsubscribe (true/false) sendunsubscribe (true/false) allowunsubscribe (true/false) disablelistcommand (true/false) disablesubscribecommand (true/false) enableheader (true/false) enablefooter (true/false) enableposterwhitelist (true/false) enabledoubleoptin (true/false) disablelisterrorreplies (true/false) listtoaddress listfromaddress listreplytoaddress

Returns SettingsRequestResult

SettingsRequestResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settingValues`	String[]	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.

GetSubscriberFields

Gets the subscriber fields for the specified user. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`SubscriberEmail`	String	The subscriber's email address.

Returns SubscriberFieldListResult

SubscriberFieldListResult		Description
`Count`	Int32	The count of subscriber fields.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`SubscriberFields`	SubscriberFieldType[]	A list of SubscriberFieldType values.

SubscriberFieldType		Description
`Name`	String	Subscriber field name
`Value`	String	Subscriber field value

GetSubscriberList

Returns the subscribers for the given list. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`ListName`	String	The name of the mailing list.

Returns SubscriberListResult

SubscriberListResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Subscribers`	String[]	A list of email addresses.

RemoveDigestSubscriber

Removes a digest subscriber to the specified list. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`ListName`	String	The name of the mailing list.
`Subscriber`	String	The email address of the digest subscriber to remove.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

RemoveSubscriber

Removes a subscriber to the specified list. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`ListName`	String	The name of the mailing list.
`Subscriber`	String	The email address of the subscriber to remove.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetDigestSubscriberList

Sets the digest subscribers for the given list. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`ListName`	String	The name of the mailing list.
`Subscribers`	String[]	A list of email addresses that will become the new digest subscriber list for the mailing list.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetListCommandAddress

Sets the command list address for the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The name of the domain to modify.
`commandAddress`	String	The username for the command list address. This is typically stserv or listserv.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetPosterKillList

Sets the kill list (blocked posters) for the given list. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`ListName`	String	The name of the mailing list.
`Subscribers`	String[]	A list of email addresses that will become the new kill list for the mailing list.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetPosterWhiteList

Sets the poster whitelist for the given list. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`ListName`	String	The name of the mailing list.
`Subscribers`	String[]	A list of email addresses that will become the new poster whitelist for the mailing list.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetRequestedListSettings

Sets specific settings for the specified list. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`ListName`	String	The name of the mailing list.
`newSettings`	String[]	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

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetSubscriberList

Sets the subscribers for the given list. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`ListName`	String	The name of the mailing list.
`Subscribers`	String[]	A list of email addresses that will become the new subscriber list for the mailing list.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetSubscriberList2

Sets the subscribers for the given list. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`ListName`	String	The name of the mailing list.
`Subscribers`	String[]	A list of email addresses that will become the new subscriber list for the mailing list.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

UpdateDefaultSubscriberField

Updates a default subscriber field for the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`SubscriberFieldName`	String	The name of the new subscriber field.
`SubscriberFieldValue`	String	The value of the new subscriber field.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

UpdateSubscriberField

Updates the subscriber field for the specified subscriber. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	The domain that contains the list.
`SubscriberEmail`	String	The subscriber's email address.
`SubscriberFieldName`	String	The name of the new subscriber field.
`SubscriberFieldValue`	String	The value of the new subscriber field.
`SubscriberType`	String	The mailing list subscriber type. Possible values: all, subscriber, or digest.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

http://dgxdatacenter-001-site2.mysitepanel.net/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.

WSDL Definition

Functions
ActivateLicenseKey	Activates the product with the license key set using SetLicenseKey previously.
GetLicenseInfo	Returns the license key for the installation.
GetProductInfo	Returns the product name and version for the installation.
SetLicenseKey	Sets the product license key for the installation. Note that you will need to call ActivateLicenseKey afterwards to enable the licence.

ActivateLicenseKey

Activates the product with the license key set using SetLicenseKey previously. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`AccountEmailAddress`	String	The email address associated with the license key.
`AccountPassword`	String	The password that should be used to activate the license.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetLicenseInfo

Returns the license key for the installation. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns LicenseInfoResult

LicenseInfoResult		Description
`LicenseKey`	String	The license key for this installation.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetProductInfo

Returns the product name and version for the installation. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns ProductInfoResult

ProductInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`ProductName`	String	The name of the product.
`ProductVersion`	String	The version number of the product.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A 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. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`Key`	String	The license key to set.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

http://dgxdatacenter-001-site2.mysitepanel.net/Services/svcServerAdmin.asmx

This web service modifies global settings and control for the server.

WSDL Definition

Functions
AddAbuseDetectionRule	Adds an abuse detection rule.
AddFolderAutocleanRule	Adds a server level auto-clean rule to the server.
AddForwardingBlacklistEntry	Adds a forwarding blacklist entry to the server.
AddGateway	Adds a non-SmarterMail outgoing gateway to SmarterMail. If your gateway is running SmarterMail, use AddSmarterMailGateway instead.
AddGlobalTrustedSender	Adds a new globally trusted sender.
AddGreylistingFilter	Adds a new greylisting filter.
AddHostname	Adds a hostname to the server.
AddIncomingGateway	Adds a new incoming gateway configuration.
AddIPRestrictionToSystemAdmin	Adds an IP address or IP range restriction to a system administrator login.
AddReservedDomainNames	Adds reserved domain names to the current list of reserved domain names.
AddServerPort	Adds a port to the server.
AddSmarterMailGateway	Adds a SmarterMail outgoing gateway to SmarterMail. If your gateway is NOT running SmarterMail, use AddGateway instead.
AddSmtpAuthenticationBypass	Adds a new SMTP authentication bypass rule. Pass either an IP Address or a range, not both.
AddSMTPBlockedSender	Adds a new SMTP blocked sender.
AddSpamAssassinServer	Adds a remote SpamAssassin server configuration.
AddSystemAdmin	Adds a new system administrator.
AssignPortToIP	Assigns a port to an IP address.
DeleteAbuseDetectionRule	Deletes an abuse detection rule.
DeleteFolderAutoCleanRule	Removes a server level auto-clean rule from the server.
DeleteForwardingBlacklistEntry	Remove a forwarding blacklist entry from the server.
DeleteGlobalTrustedSender	Deletes a globally trusted sender.
DeleteGreylistingFilter	Removes a greylisting filter.
DeleteHostname	Removes a hostname from the server.
DeleteServerPort	Deletes a port from the server.
DeleteSmtpAuthenticationBypass	Deletes an SMTP authentication bypass rule. Pass either an IP Address or a range, not both.
DeleteSpamAssassinServer	Deletes a remote SpamAssassin server configuration.
DeleteSystemAdmin	Removes a system administrator.
GetAbuseDetectionRules	Return the current abuse detection rules on the server.
GetBlacklistEntries	Returns the currently configured blacklist entries.
GetEdition	Returns the operational licensing mode that SmarterMail is running under.
GetGateway	Returns information about a particular outgoing gateway.
GetGlobalTrustedSenders	Returns a list of all current globally trusted senders.
GetIncomingGateway	Retrieves information about a specific incoming gateway.
GetRequestedSystemSettings	Retrieves the value of the requested system settings.
GetReservedDomainNames	Returns a list of reserved domain names.
GetSmtpAuthenticationBypasses	Returns a list of the currently configured SMTP authentication bypass rules.
GetSMTPBlockedSenders	Returns a list of currently blocked SMTP senders.
GetSpoolMessageCount	Returns the number of messages in the spool.
GetWhitelistEntries2	Returns the currently configured whitelist entries.
ListFolderAutoCleanRules	Returns a list of all server level auto-clean rules defined in SmarterMail.
ListForwardingBlacklistEntries	Returns all current forwarding blacklist entries.
ListGateways	Returns a list of all outgoing gateways for the server.
ListGreylistingFilters	Returns a list of all currently configured greylisting filters.
ListHostnames	Returns a list of all hostnames configured on the server.
ListIncomingGateways	Returns a list of all configured incoming gateways.
ListPortsAssignedToIP	Returns a list of ports currently bound to a specific IP Address.
ListServerPorts	Lists all ports currently setup on the server.
ListSpamAssassinServers	Returns a list of all currently configured remote SpamAssassin servers.
ListSystemAdmins	Returns the current system administrators on the server.
RemoveGateway	Deletes an outgoing gateway from SmarterMail.
RemoveIncomingGateway	Deletes an incoming gateway configuration.
RemoveIPRestrictionFromSystemAdmin	Removes an IP address or IP range restriction from a system administrator login.
RemovePortFromIP	Removes a port assigned to an IP address.
RemoveReservedDomainNames	Removes reserved domain names from the current list of reserved domain names.
RequestStatus	Returns information about the current status of the server.
SetBlacklistEntry	Adds a new blacklist entry or edits an existing blacklist entry. Pass either an IP address or a range, not both. To remove an entry set all protocols to false.
SetRequestedSystemSettings	Sets the value of the requested system settings.
SetReservedDomainNames	Sets the list of reserved domain names.
SetSystemAdminPassword	Sets the password of a system administrator.
SetWhitelistEntry2	Adds a new whitelist entry or edits an existing whitelist entry. Pass either an IP address or a range, not both. To remove an entry set all protocols to false.
StartServices	Starts the specified services in SmarterMail.
StopServices	Stops the specified services in SmarterMail.
UpdateAbuseDetectionRule	Updates an abuse detection rule.
UpdateGateway	Updates the settings for a specific outgoing gateway.
UpdateIncomingGateway	Updates properties about a specific incoming gateway.

Depricated: AddDOSAbuseDetectionRule, AddHarvestingAbuseDetectionRule, AddInternalSpammerNotificationAbuseDetectionRule, GetBouncesAbuseDetectionRules, GetBruteForceAbuseDetectionRules, GetDOSAbuseDetectionRules, GetHarvestingAbuseDetectionRules, GetInternalSpammerNotificationAbuseDetectionRules, GetWhitelistEntries, SetWhitelistEntry

AddAbuseDetectionRule

Adds an abuse detection rule. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`abuseDetectionType`	String	The abuse detection rule type. Possible values are: BOUNCES BRUTEFORCE DOS HARVESTING INTERNALSPAMMER
`service`	String	The service to which the rule applies (used by DOS and brute force only). Possible values are: IMAP LDAP POP SMTP XMPP
`action`	String	The action to take when rule is triggered (used by internal spammer and bounces only). Possible values are: BLOCK NOTIFY QUARANTINE
`timeFrame`	Int32	The timeframe in minutes in which the rule can be triggered.
`occurencesBeforeTrigger`	Int32	The number of occurrences before the rule is triggered.
`timeToBlock`	Int32	The period in minutes for which the server will block the offender.
`emailAddressToNotify`	String	The email address to notify when the rule is triggered (used by internal spammer and bounces only).
`description`	String	A brief description of the rule for display purposes.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddDOSAbuseDetectionRule

Adds a denial of service (DOS) abuse detection rule to the server. View the full specification

OBSOLETE: AddAbuseDetectionRule should be used instead. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.

AddFolderAutocleanRule

Adds a server level auto-clean rule to the server. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`folder`	String	Folder name to auto-clean.
`enableRule`	Boolean	True to enable the rule immediately.
`type`	String	Type of rule. Possible values are: Date Size
`sizeBeforeAutoClean`	Int32	If type is Size, the size which a folder must reach before being auto-cleaned.
`sizeAfterClean`	Int32	If type is Size, the size which a folder will be trimmed to after it's cleaned.
`mailAgeInDays`	Int32	If type is Date, the age in days at which email gets deleted.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddForwardingBlacklistEntry

Adds a forwarding blacklist entry to the server. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`domainName`	String	Domain name to blacklist.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddGateway

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

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`address`	String	The IP Address of the gateway.
`enabled`	Boolean	True if the gateway should be enabled immediately.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddGlobalTrustedSender

Adds a new globally trusted sender. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`addressOrDomain`	String	Email address or domain name to trust.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddGreylistingFilter

Adds a new greylisting filter. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`filterType`	String	The type of filter to add. Possible values are: Country IPAddress IPRange
`ipRangeStart`	String	Start of the IP range. Required only when filterType is IPRange.
`ipRangeEnd`	String	End of the IP range. Required only when filterType is IPRange.
`ipAddress`	String	IP address to be filtered. Required only when filterType is IPAddress.
`description`	String	A brief description for display purposes.
`countryCode`	String	Country code to be filtered. Required only when filterType is Country.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddHarvestingAbuseDetectionRule

Adds a harvesting abuse detection rule to the server. View the full specification

OBSOLETE: AddAbuseDetectionRule should be used instead. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.

AddHostname

Adds a hostname to the server. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`hostname`	String	Hostname to add.
`ipAddress`	String	IP Address to which the hostname applies.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddIncomingGateway

Adds a new incoming gateway configuration. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`newIncomingGateway`	IncomingGatewayAttributes	Attributes for the gateway.

IncomingGatewayAttributes		Description
`authSmarterMailPassword`	String	Password of the administrator (if smarterMailMode is true).
`authSmarterMailUserName`	String	Username of the administrator (if smarterMailMode is true).
`domainsToForward`	String[]	A list of domain names that should be forwarded.
`domainVerifyType`	String	Type of domain verification. Possible values are: AllButSpecifiedDomains SpecifiedDomains WebService
`enableSpamActions`	Boolean	True to enable spam check actions.
`gatewayMode`	String	The mode that the gateway is operating. Possible values are: BackupMX DomainForward
`guid`	String	The unique identifier of the incoming gateway.
`IPAddress`	String	IP Address of the gateway.
`IPEndRange`	String	End of the IP Address range of the gateway.
`IPStartRange`	String	Start of the IP Address range of the gateway.
`notSpamAction`	String	Action to take on Not Spam. Possible values are: Delete Header None PassScore Reroute Subject
`notSpamArgs`	String	Arguments to use for the action.
`smarterMailMode`	Boolean	True if the gateway is a SmarterMail server.
`smarterMailURL`	String	URL to the SmarterMail web interface (if smarterMailMode is true).
`spamHighAction`	String	Action to take on Spam-High. Possible values are: Delete Header None PassScore Reroute Subject
`spamHighArgs`	String	Arguments to use for the action.
`spamLowAction`	String	Action to take on Spam-Low. Possible values are: Delete Header None PassScore Reroute Subject
`spamLowArgs`	String	Arguments to use for the action.
`spamMedAction`	String	Action to take on Spam-Med. Possible values are: Delete Header None PassScore Reroute Subject
`spamMedArgs`	String	Arguments to use for the action.
`userVerifyType`	String	The type of user verification done by the gateway. Possible values are: None SMTP WebService
`webserviceURL`	String	The URL of the web service.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddInternalSpammerNotificationAbuseDetectionRule

Adds an internal spammer notification abuse detection rule. View the full specification

OBSOLETE: AddAbuseDetectionRule should be used instead. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.

AddIPRestrictionToSystemAdmin

Adds an IP address or IP range restriction to a system administrator login. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`adminUsername`	String	Username of the system administrator.
`ipAddressOrRange`	String	The IP address or IP range (format: x.x.x.x-y.y.y.y).
`restrictionDescription`	String	A brief description for display purposes.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddReservedDomainNames

Adds reserved domain names to the current list of reserved domain names. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`reservedDomainNames`	String[]

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddServerPort

Adds a port to the server. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`protocol`	String	The protocol assigned to the port. Possible values are: IMAP LDAP POP SMTP SubmissionPort
`certificatePath`	String	If the port uses SSL or TLS, the path to the certificate on the server.
`encryption`	String	Optional The encryption method to use. Possible values are: SSL TLS
`name`	String	A descriptive name for the port.
`port`	Int32	The port number.
`description`	String	A brief description of the port for display purposes.

Returns AddServerPortResult

AddServerPortResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`NewID`	String	Unique identifier of the newly added item.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddSmarterMailGateway

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

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`address`	String	The IP Address of the gateway.
`enabled`	Boolean	True if the gateway should be enabled immediately.
`smUrl`	String	Url to the SmarterMail Web interface. For example, http://mail.example.com/.
`smUserName`	String	Administrator username for the gateway.
`smPassword`	String	Administrator password for the gateway.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddSmtpAuthenticationBypass

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

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ipAddress`	String	IP address.
`ipRangeStart`	String	Start of the IP range.
`ipRangeEnd`	String	End of the IP range.
`description`	String	A brief description for display purposes.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddSMTPBlockedSender

Adds a new SMTP blocked sender. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`blockedSender`	String	Email address of the blocked sender.
`description`	String	A brief description for display purposes.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddSpamAssassinServer

Adds a remote SpamAssassin server configuration. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`serverName`	String	A descriptive name for the server.
`ipAddress`	String	The IP address of the server.
`serverPort`	Int32	The port number on which the SpamAssassin service is listening.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddSystemAdmin

Adds a new system administrator. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`newAdminUsername`	String	Username of the system administrator.
`newAdminPassword`	String	Password to use.
`newAdminDescription`	String	A brief description for display purposes.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AssignPortToIP

Assigns a port to an IP address. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`portID`	String	The unique identifier of the port.
`ipAddress`	String	IP Address to which the port will be assigned.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteAbuseDetectionRule

Deletes an abuse detection rule. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`id`	String	The unique identifier of the abuse detection rule.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteFolderAutoCleanRule

Removes a server level auto-clean rule from the server. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`id`	String	Unique identifier of the auto-clean rule.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteForwardingBlacklistEntry

Remove a forwarding blacklist entry from the server. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`domainName`	String	Domain name to remove from blacklist.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteGlobalTrustedSender

Deletes a globally trusted sender. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`addressOrDomain`	String	Email address or domain name to remove.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteGreylistingFilter

Removes a greylisting filter. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`filterType`	String	The filter type of the greylisting filter to remove.
`ipRangeStart`	String	Optional Start of the IP range used by the filter.
`ipRangeEnd`	String	Optional End of the IP range used by the filter.
`ipAddress`	String	Optional IP address of the filter.
`countryCode`	String	Optional Country code of the filter.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteHostname

Removes a hostname from the server. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ipAddress`	String	IP Address to remove hostname for.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteServerPort

Deletes a port from the server. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`portId`	String	The identifier of the port to delete. This can be obtained from the ListServerPorts function.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteSmtpAuthenticationBypass

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

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ipAddress`	String	IP address.
`ipRangeStart`	String	Start of the IP range.
`ipRangeEnd`	String	End of the IP range.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteSpamAssassinServer

Deletes a remote SpamAssassin server configuration. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`serverName`	String	The name of the server you wish to delete.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteSystemAdmin

Removes a system administrator. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`systemAdminUsername`	String	Username of the system administrator to delete.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetAbuseDetectionRules

Return the current abuse detection rules on the server. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`filter`	String	Abuse detection rule type filter. Possible values are: ALL BOUNCES BRUTEFORCE DOS HARVESTING INTERNALSPAMMER

Returns AbuseDetectionRulesListResult

AbuseDetectionRulesListResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Rules`	AbuseDetectionRuleResult[]	A list of rules details, as defined in the AbuseDetectionRuleResult class (not all fields are used).

AbuseDetectionRuleResult		Description
`Action`	String	The action to take when rule is triggered (used by internal spammer and bounces only). Possible values are: BLOCK NOTIFY QUARANTINE
`Description`	String	A brief description of the rule for display purposes.
`EmailAddressToNotify`	String	The email address to notify when the rule is triggered (used by internal spammer and bounces only).
`OccurencesBeforeTrigger`	Int32	The number of occurrences before the rule is triggered.
`Service`	String	The service to which the rule applies (used by DOS and brute force only). Possible values are: IMAP LDAP POP SMTP XMPP
`TimeFrame`	Int32	The timeframe in minutes in which the rule can be triggered.
`TimeToBlock`	Int32	The period in minutes for which the server will block the offender.
`UniqueID`	String	Unique id.

GetBlacklistEntries

Returns the currently configured blacklist entries. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns BlacklistListResult

BlacklistListResult		Description
`Entries`	BlacklistResult[]	A list of blacklist entries, as defined in the BlacklistResult class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

BlacklistResult		Description
`Description`	String	A brief description for display purposes.
`IMAPBlacklisted`	Boolean	True if IMAP blacklisted.
`IPAddress`	String	IP Address that is blacklisted.
`IPRangeEnd`	String	End of an IP Address range that is blacklisted.
`IPRangeStart`	String	Start of an IP Address range that is blacklisted.
`POPBlacklisted`	Boolean	True if POP blacklisted.
`SMTPBlacklisted`	Boolean	True if SMTP blacklisted.
`XMPPBlacklisted`	Boolean	True if XMPP blacklisted.

GetBouncesAbuseDetectionRules

Returns the current bounce detection rules on the server. View the full specification

OBSOLETE: GetAbuseDetectionRules should be used instead. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.

GetBruteForceAbuseDetectionRules

Returns the current brute force rules on the server. View the full specification

OBSOLETE: GetAbuseDetectionRules should be used instead. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.

GetDOSAbuseDetectionRules

Returns the current DOS detection rules on the server. View the full specification

OBSOLETE: GetAbuseDetectionRules should be used instead. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.

GetEdition

Returns the operational licensing mode that SmarterMail is running under. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns EditionResult

EditionResult		Description
`Edition`	String	The licensed edition of SmarterMail. Possible values are: ENT FREE LITE PRO
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetGateway

Returns information about a particular outgoing gateway. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`guid`	String	Unique identifier for the gateway.

Returns GatewayResult

GatewayResult		Description
`enabled`	Boolean	True if the gateway is enabled.
`gatewayAddress`	String	IP Address of the gateway.
`guid`	String	Unique identifier of the gateway.
`isSmarterMailServer`	Boolean	True if the gateway is a SmarterMail server.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`smPassword`	String	Password for the gateway (if isSmarterMailServer is true).
`smUrl`	String	URL to the SmarterMail web interface of the gateway (if isSmarterMailServer is true).
`smUserName`	String	Username for the gateway (if isSmarterMailServer is true).

GetGlobalTrustedSenders

Returns a list of all current globally trusted senders. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns TrustedSenderListResult

TrustedSenderListResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`TrustedSenders`	String[]	A list of email addresses or domains.

GetHarvestingAbuseDetectionRules

Returns the current harvesting detection rules on the server. View the full specification

OBSOLETE: GetAbuseDetectionRules should be used instead. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.

GetIncomingGateway

Retrieves information about a specific incoming gateway. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`guid`	String	The unique ID that identifies the gateway.

Returns IncomingGatewayResult

IncomingGatewayResult		Description
`gateway`	IncomingGatewayAttributes	Details about the incoming gateway, as defined in the IncomingGatewayAttributes class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

IncomingGatewayAttributes		Description
`authSmarterMailPassword`	String	Password of the administrator (if smarterMailMode is true).
`authSmarterMailUserName`	String	Username of the administrator (if smarterMailMode is true).
`domainsToForward`	String[]	A list of domain names that should be forwarded.
`domainVerifyType`	String	Type of domain verification. Possible values are: AllButSpecifiedDomains SpecifiedDomains WebService
`enableSpamActions`	Boolean	True to enable spam check actions.
`gatewayMode`	String	The mode that the gateway is operating. Possible values are: BackupMX DomainForward
`guid`	String	The unique identifier of the incoming gateway.
`IPAddress`	String	IP Address of the gateway.
`IPEndRange`	String	End of the IP Address range of the gateway.
`IPStartRange`	String	Start of the IP Address range of the gateway.
`notSpamAction`	String	Action to take on Not Spam. Possible values are: Delete Header None PassScore Reroute Subject
`notSpamArgs`	String	Arguments to use for the action.
`smarterMailMode`	Boolean	True if the gateway is a SmarterMail server.
`smarterMailURL`	String	URL to the SmarterMail web interface (if smarterMailMode is true).
`spamHighAction`	String	Action to take on Spam-High. Possible values are: Delete Header None PassScore Reroute Subject
`spamHighArgs`	String	Arguments to use for the action.
`spamLowAction`	String	Action to take on Spam-Low. Possible values are: Delete Header None PassScore Reroute Subject
`spamLowArgs`	String	Arguments to use for the action.
`spamMedAction`	String	Action to take on Spam-Med. Possible values are: Delete Header None PassScore Reroute Subject
`spamMedArgs`	String	Arguments to use for the action.
`userVerifyType`	String	The type of user verification done by the gateway. Possible values are: None SMTP WebService
`webserviceURL`	String	The URL of the web service.

GetInternalSpammerNotificationAbuseDetectionRules

Returns the current internal spamer detection rules on the server. View the full specification

OBSOLETE: GetAbuseDetectionRules should be used instead. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.

GetRequestedSystemSettings

Retrieves the value of the requested system settings. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`reqSettings`	String[]	A list of settings to return. Possible values are: ActiveSyncLogLevel - (Exceptions Only\|Normal\|Detailed) AdministrativeLogLevel (None\|Normal\|Detailed) 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 DeliverPostmasterToDomainOnly - Send to global postmaster address only if not delivered to a domain postmaster account DeliveryDelay - Milliseconds to wait before message delivery DeliveryLogLevel - (Exceptions Only\|Normal\|Detailed) 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 EnforceSmtpAuthLocalDelivery - Require SMTP authentication for local deliveries EventLogLevel - (Exceptions Only\|Normal\|Detailed) EWSLogLevel - (None\|Normal\|Detailed) 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 IMAPLogLevel - (Exceptions Only\|Normal\|Detailed) 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 IMAPRetrievalLogLevel - (Exceptions Only\|Normal\|Detailed) 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 IndexingLogLevel - (Exceptions Only\|Normal\|Detailed) 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 LDAPLogLevel - (Exceptions Only\|Normal\|Detailed) 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 MailboxImportLogLevel - (Exceptions Only\|Normal\|Detailed) MaintenanceLogLevel - (None\|Normal\|Detailed) MessageIDLogLevel - (None\|Detailed) MinimumPasswordLength - Minimum number of charactes a password must require MinimumPasswordLengthEnabled - Enforce mimimum password length setting NotifyOfDelayAfterXAttempts - number of failed message delivery attempts before a delay notification message is sent to the message sender OutboundIp - specified ipv4 for outbound connections OutboundIpOption - domains ipv4, primary ipv4, specified ipv4 OutboundIpv6 - specified ipv6 for outbound connections OutboundIpv6Option - domains ipv6, primary ipv6, disable, specified ipv6 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 PopLogLevel - (Exceptions Only\|Normal\|Detailed) 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 PopRetrievalLogLevel - (Exceptions Only\|Normal\|Detailed) PopRetrievalThreads - Maximum POP retrieval sessions PostmasterMailbox - Postmaster mailbox PreventCommonPasswords - prevent commonly used passwords 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 SMTPLogLevel - (Exceptions Only\|Normal\|Detailed) 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 SyncMLLogLevel - (Exceptions Only\|Normal\|Detailed) 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 font for email messages UserDefaultComposeFontSize - Default user font size (ex '12px') for email messages 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 UserDefaultEnableSmtpAccounts - Default setting for enabling a user for SMTP accounts 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 UserDefaultMarkPOP3DownloadsAsRead - Enable/disable marking POP3 downloads as read 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 WebDAVLogLevel - (Exceptions Only\|Normal\|Detailed) WelcomeWizardDisabled Enable or disable the welcome wizard

Returns RequestSettingsResult

RequestSettingsResult		Description
`KeyValuePairs`	String[]	A list of 'key=value' pairs with the requested setting values.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetReservedDomainNames

Returns a list of reserved domain names. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns StringArrayResult

StringArrayResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`StringArray`	String[]

GetSmtpAuthenticationBypasses

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

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns SMTPAuthBypassListResult

SMTPAuthBypassListResult		Description
`Entries`	SMTPAuthBypassResult[]	A list of SMTP Authentication bypass entries, as defined in the SMTPAuthBypassResult class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SMTPAuthBypassResult		Description
`Description`	String	A brief description for display purposes.
`IPAddress`	String	IP Address that is bypassed.
`IPRangeEnd`	String	End of an IP Address range that is bypassed.
`IPRangeStart`	String	Start of an IP Address range that is bypassed.

GetSMTPBlockedSenders

Returns a list of currently blocked SMTP senders. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns SMTPBlockedSenderListResult

SMTPBlockedSenderListResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`SMTPBlockedSenders`	SMTPBlockedSenderResult[]	A list of blocked senders, as defined in the SMTPBlockedSenderResult class.

SMTPBlockedSenderResult		Description
`BlockedSender`	String	Email address or domain name of a blocked sender.
`Description`	String	A brief description for display purposes.

GetSpoolMessageCount

Returns the number of messages in the spool. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns MessageCountResult

MessageCountResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`messageCount`	Int32	Number of messages in the spool.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetWhitelistEntries

Returns the currently configured whitelist entries. View the full specification

OBSOLETE: GetWhitelistEntries2 should be used instead. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.

GetWhitelistEntries2

Returns the currently configured whitelist entries. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns WhitelistListResult2

WhitelistListResult2		Description
`Entries`	WhitelistResult2[]	A list of whitelists, as defined in the WhitelistResult2 class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

WhitelistResult2		Description
`Description`	String	A brief description for display purposes.
`GreylistingDisabled`	Boolean	True if greylisting is disabled.
`IMAPWhitelisted`	Boolean	True if IMAP whitelisted.
`IPAddress`	String	IP Address that is whitelisted.
`IPRangeEnd`	String	End of an IP Address range that is whitelisted.
`IPRangeStart`	String	Start of an IP Address range that is whitelisted.
`POPWhitelisted`	Boolean	True if POP whitelisted.
`SMTPWhitelisted`	Boolean	True if SMTP whitelisted.
`XMPPWhitelisted`	Boolean	True if XMPP whitelisted.

ListFolderAutoCleanRules

Returns a list of all server level auto-clean rules defined in SmarterMail. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns FolderAutoCleanRuleListResult

FolderAutoCleanRuleListResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Rules`	FolderAutoCleanRuleResult[]

FolderAutoCleanRuleResult		Description
`Enabled`	Boolean
`ID`	String
`MailAgeInDays`	Int32
`SizeAfterCleanInMB`	Int32
`SizeBeforeCleanInMB`	Int32
`Type`	String

ListForwardingBlacklistEntries

Returns all current forwarding blacklist entries. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns ForwardingBlacklistRuleResult

ForwardingBlacklistRuleResult		Description
`BlacklistedDomains`	String[]
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ListGateways

Returns a list of all outgoing gateways for the server. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns GatewayListResult

GatewayListResult		Description
`gateways`	GatewayResult[]	A list of gateways, as defined in the GatewayResult class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GatewayResult		Description
`enabled`	Boolean	True if the gateway is enabled.
`gatewayAddress`	String	IP Address of the gateway.
`guid`	String	Unique identifier of the gateway.
`isSmarterMailServer`	Boolean	True if the gateway is a SmarterMail server.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`smPassword`	String	Password for the gateway (if isSmarterMailServer is true).
`smUrl`	String	URL to the SmarterMail web interface of the gateway (if isSmarterMailServer is true).
`smUserName`	String	Username for the gateway (if isSmarterMailServer is true).

ListGreylistingFilters

Returns a list of all currently configured greylisting filters. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns GreylistingFilterListResult

GreylistingFilterListResult		Description
`Filters`	GreylistingFilterResult[]	A list of filter details, as defined in the GreylistingFilterResult class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GreylistingFilterResult		Description
`CountryCode`	String	If FilterType is CountryCode, contains the country code.
`Description`	String	A brief description for display purposes.
`FilterType`	String	The type of filter. Possible values are: Country IPAddress IPRange
`IPAddress`	String	If FilterType is IPAddress, contains the IP Address.
`IPRangeEnd`	String	If FilterType is IPRange, contains the end of the IP Range.
`IPRangeStart`	String	If FilterType is IPRange, contains the start of the IP Range.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ListHostnames

Returns a list of all hostnames configured on the server. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns HostnameListResult

HostnameListResult		Description
`Hostnames`	HostnameResult[]
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

HostnameResult		Description
`Hostname`	String
`IPAddress`	String

ListIncomingGateways

Returns a list of all configured incoming gateways. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns IncomingGatewayListResult

IncomingGatewayListResult		Description
`incGateways`	IncomingGatewayAttributes[]	A list of detals about the incoming gateways, as defined in the IncomingGatewayAttributes class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

IncomingGatewayAttributes		Description
`authSmarterMailPassword`	String	Password of the administrator (if smarterMailMode is true).
`authSmarterMailUserName`	String	Username of the administrator (if smarterMailMode is true).
`domainsToForward`	String[]	A list of domain names that should be forwarded.
`domainVerifyType`	String	Type of domain verification. Possible values are: AllButSpecifiedDomains SpecifiedDomains WebService
`enableSpamActions`	Boolean	True to enable spam check actions.
`gatewayMode`	String	The mode that the gateway is operating. Possible values are: BackupMX DomainForward
`guid`	String	The unique identifier of the incoming gateway.
`IPAddress`	String	IP Address of the gateway.
`IPEndRange`	String	End of the IP Address range of the gateway.
`IPStartRange`	String	Start of the IP Address range of the gateway.
`notSpamAction`	String	Action to take on Not Spam. Possible values are: Delete Header None PassScore Reroute Subject
`notSpamArgs`	String	Arguments to use for the action.
`smarterMailMode`	Boolean	True if the gateway is a SmarterMail server.
`smarterMailURL`	String	URL to the SmarterMail web interface (if smarterMailMode is true).
`spamHighAction`	String	Action to take on Spam-High. Possible values are: Delete Header None PassScore Reroute Subject
`spamHighArgs`	String	Arguments to use for the action.
`spamLowAction`	String	Action to take on Spam-Low. Possible values are: Delete Header None PassScore Reroute Subject
`spamLowArgs`	String	Arguments to use for the action.
`spamMedAction`	String	Action to take on Spam-Med. Possible values are: Delete Header None PassScore Reroute Subject
`spamMedArgs`	String	Arguments to use for the action.
`userVerifyType`	String	The type of user verification done by the gateway. Possible values are: None SMTP WebService
`webserviceURL`	String	The URL of the web service.

ListPortsAssignedToIP

Returns a list of ports currently bound to a specific IP Address. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ipAddress`	String	IP Address to check.

Returns ServerPortListResult

ServerPortListResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Ports`	ServerPortResult[]	A list of ports, as defined in the ServerPortResult class.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ServerPortResult		Description
`CertificatePath`	String	Optional The path to the certificate used for SSL and TLS connections.
`Description`	String	A brief description for display purposes.
`Encryption`	String	Optional Encryption method applied to the port. Possible values are: SSL TLS
`ID`	String	Unique identifier of the item.
`Name`	String	Display name for the port.
`Port`	Int32	The port number.
`Protocol`	String	Protocol to which the port applies. Possible values are: IMAP POP SMTP SubmissionPort

ListServerPorts

Lists all ports currently setup on the server. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns ServerPortListResult

ServerPortListResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Ports`	ServerPortResult[]	A list of ports, as defined in the ServerPortResult class.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ServerPortResult		Description
`CertificatePath`	String	Optional The path to the certificate used for SSL and TLS connections.
`Description`	String	A brief description for display purposes.
`Encryption`	String	Optional Encryption method applied to the port. Possible values are: SSL TLS
`ID`	String	Unique identifier of the item.
`Name`	String	Display name for the port.
`Port`	Int32	The port number.
`Protocol`	String	Protocol to which the port applies. Possible values are: IMAP POP SMTP SubmissionPort

ListSpamAssassinServers

Returns a list of all currently configured remote SpamAssassin servers. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns SpamAssassinServerListResult

SpamAssassinServerListResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Servers`	SpamAssassinServerResult[]	A list of server details, as defined in the SpamAssassinServerResult class.

SpamAssassinServerResult		Description
`ConsecutiveFailures`	Int32	The number of consecutive failures for this SpamAssassin server.
`Enabled`	Boolean	True if the SpamAssassin server is enabled.
`IPAddress`	String	IP Address of the server.
`Name`	String	Name of the server.
`Port`	Int32	Port that SpamAssassin is listening on.
`TotalConnections`	Int32	The total number of connections made to this SpamAssassin Server.

ListSystemAdmins

Returns the current system administrators on the server. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.

Returns SystemAdminListResult

SystemAdminListResult		Description
`Admins`	SystemAdminResult[]
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SystemAdminResult		Description
`DateCreated`	DateTime
`Description`	String
`ID`	String
`IsPrimaryAdmin`	Boolean
`RestrictedByIp`	Boolean
`Username`	String

RemoveGateway

Deletes an outgoing gateway from SmarterMail. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`guid`	String	Unique identifier of the gateway to remove.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

RemoveIncomingGateway

Deletes an incoming gateway configuration. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`guid`	String	The unique ID that identifies the gateway.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

RemoveIPRestrictionFromSystemAdmin

Removes an IP address or IP range restriction from a system administrator login. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`adminUsername`	String	Username of the system administrator.
`ipAddressOrRange`	String	The IP address or IP range (format: x.x.x.x-y.y.y.y).

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

RemovePortFromIP

Removes a port assigned to an IP address. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`portID`	String	The unique identifier of the port.
`ipAddress`	String	IP Address from which the port will be removed.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

RemoveReservedDomainNames

Removes reserved domain names from the current list of reserved domain names. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`reservedDomainNames`	String[]

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

RequestStatus

Returns information about the current status of the server. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`reqStats`	String[]	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

RequestStatusResult		Description
`KeyValuePairs`	String[]	A list of 'key=value' pairs with the requested status values.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A 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. To remove an entry set all protocols to false. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ipAddress`	String	IP address to be blacklisted.
`ipRangeStart`	String	Start of the IP range to be blacklisted.
`ipRangeEnd`	String	End of the IP range to be blacklisted.
`blacklistSMTP`	Boolean	True to blacklist SMTP.
`blacklistPOP`	Boolean	True to blacklist POP.
`blacklistIMAP`	Boolean	True to blacklist IMAP.
`blacklistXMPP`	Boolean	True to blacklist XMPP.
`description`	String	A brief description for display purposes.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetRequestedSystemSettings

Sets the value of the requested system settings. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`newSettings`	String[]	A list of 'key=value' pairs that define what settings to change. Possible key names can be found in the GetRequestedSystemSettings function.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetReservedDomainNames

Sets the list of reserved domain names. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`reservedDomainNames`	String[]

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetSystemAdminPassword

Sets the password of a system administrator. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`systemAdminUsername`	String	Username of the system administrator to update.
`newPassword`	String	New password to use.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A 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. To remove an entry set all protocols to false. View the full specification

OBSOLETE: SetWhitelistEntry2 should be used instead. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.

SetWhitelistEntry2

Adds a new whitelist entry or edits an existing whitelist entry. Pass either an IP address or a range, not both. To remove an entry set all protocols to false. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`ipAddress`	String	IP address to be whitelisted.
`ipRangeStart`	String	Start of the IP range to be whitelisted.
`ipRangeEnd`	String	End of the IP range to be whitelisted.
`whitelistSMTP`	Boolean	True to whitelist SMTP.
`whitelistPOP`	Boolean	True to whitelist POP.
`whitelistIMAP`	Boolean	True to whitelist IMAP.
`whitelistXMPP`	Boolean	True to whitelist XMPP.
`disableGreylisting`	Boolean	True to disable greylisting.
`description`	String	A brief description for display purposes.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

StartServices

Starts the specified services in SmarterMail. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`ServicesToStart`	String[]	A list of services to start. Possible values are: all imap imapretrieval indexing ldap pop popretrieval smtp spool xmpp

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

StopServices

Stops the specified services in SmarterMail. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`ServicesToStop`	String[]	A list of services to stop. Possible values are: all imap imapretrieval indexing ldap pop popretrieval smtp spool xmpp

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

UpdateAbuseDetectionRule

Updates an abuse detection rule. View the full specification

Inputs

Input Parameters		Description
`authUsername`	String	Username with permissions to call this web service.
`authPassword`	String	Password of the account used in authUserName parameter.
`id`	String	The unique identifier of the abuse detection rule.
`action`	String	The action to take when rule is triggered (used by internal spammer and bounces only). Possible values are: BLOCK NOTIFY QUARANTINE
`timeFrame`	Int32	The timeframe in minutes in which the rule can be triggered.
`occurencesBeforeTrigger`	Int32	The number of occurrences before the rule is triggered.
`timeToBlock`	Int32	The period in minutes for which the server will block the offender.
`emailAddressToNotify`	String	The email address to notify when the rule is triggered (used by internal spammer and bounces only).
`description`	String	A brief description of the rule for display purposes.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

UpdateGateway

Updates the settings for a specific outgoing gateway. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`guid`	String	Unique identifier of the gateway.
`address`	String	The IP Address of the gateway.
`enabled`	Boolean	True if the gateway should be enabled.
`isSmarterMailServer`	Boolean	True if the gateway is running SmarterMail.
`smUrl`	String	Optional Url to the SmarterMail Web interface (if isSmarterMailServer is true).
`smUserName`	String	Optional Administrator username for the gateway (if isSmarterMailServer is true).
`smPassword`	String	Optional Administrator password for the gateway (if isSmarterMailServer is true).

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

UpdateIncomingGateway

Updates properties about a specific incoming gateway. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`guid`	String	The unique ID that identifies the gateway.
`updatedIncomingGateway`	IncomingGatewayAttributes	New attributes for the gateway.

IncomingGatewayAttributes		Description
`authSmarterMailPassword`	String	Password of the administrator (if smarterMailMode is true).
`authSmarterMailUserName`	String	Username of the administrator (if smarterMailMode is true).
`domainsToForward`	String[]	A list of domain names that should be forwarded.
`domainVerifyType`	String	Type of domain verification. Possible values are: AllButSpecifiedDomains SpecifiedDomains WebService
`enableSpamActions`	Boolean	True to enable spam check actions.
`gatewayMode`	String	The mode that the gateway is operating. Possible values are: BackupMX DomainForward
`guid`	String	The unique identifier of the incoming gateway.
`IPAddress`	String	IP Address of the gateway.
`IPEndRange`	String	End of the IP Address range of the gateway.
`IPStartRange`	String	Start of the IP Address range of the gateway.
`notSpamAction`	String	Action to take on Not Spam. Possible values are: Delete Header None PassScore Reroute Subject
`notSpamArgs`	String	Arguments to use for the action.
`smarterMailMode`	Boolean	True if the gateway is a SmarterMail server.
`smarterMailURL`	String	URL to the SmarterMail web interface (if smarterMailMode is true).
`spamHighAction`	String	Action to take on Spam-High. Possible values are: Delete Header None PassScore Reroute Subject
`spamHighArgs`	String	Arguments to use for the action.
`spamLowAction`	String	Action to take on Spam-Low. Possible values are: Delete Header None PassScore Reroute Subject
`spamLowArgs`	String	Arguments to use for the action.
`spamMedAction`	String	Action to take on Spam-Med. Possible values are: Delete Header None PassScore Reroute Subject
`spamMedArgs`	String	Arguments to use for the action.
`userVerifyType`	String	The type of user verification done by the gateway. Possible values are: None SMTP WebService
`webserviceURL`	String	The URL of the web service.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

http://dgxdatacenter-001-site2.mysitepanel.net/Services/svcSpamAdmin.asmx

This web service contains functions that modify spam settings.

WSDL Definition

Functions
AddRBL	Adds an RBL check.
EditRBL	Edits properties of an RBL check.
GetBayesianSettings	Returns settings for Bayesian Fitering.
GetCommtouchSettings	Returns settings for Commtouch.
GetDecludeSettings	Returns settings for Declude integration.
GetDKIMSettings	Returns settings for DKIM.
GetDomainKeysSettings	Returns settings for DomainKeys.
GetMessageSnifferSettings	Returns settings for MessageSniffer.
GetRBL	Returns details about an RBL check.
GetRemoteSASettings	Returns settings for Remote SpamAssassin.
GetReverseDNSSettings	Returns settings for Reverse DNS.
GetSABPMSettings	Returns settings for SpamAssassin-based Pattern Matching.
GetSpamFilteringSettings	Get spam filtering options within Antispam administration.
GetSPFSettings	Returns settings for SPF.
ListRBLs	Lists information about all RBL checks.
ListSpamChecks	Lists information about all known spam checks, similar to the Antispam Administration page.
RemoveRBL	Removes an RBL check.
SetAntispamOptions	Configure options for Antispam Administration.
SetBayesianSettings	Configures settings for Bayesian Filtering.
SetCommtouchSettings	Configures settings for Commtouch.
SetDecludeSettings	Configures settings for Declude integration.
SetDKIMSettings	Configures settings for DKIM.
SetDomainKeysSettings	Configures settings for DomainKeys.
SetMessageSnifferSettings	Configures settings for MessageSniffer.
SetRemoteSASettings	Configures settings for Remote SpamAssassin.
SetReverseDNSSettings	Configures settings for Reverse DNS.
SetSABPMSettings	Configures settings for SpamAssassin-based Pattern Matching.
SetSpamFilteringSettings	Set spam filtering options within Antispam administration.
SetSpamWizardLevel	Sets the spam checks and weights to predefined wizard levels.
SetSPFSettings	Configures settings for SPF.

AddRBL

Adds an RBL check. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`rblSetting`	RBLSetting	New settings to apply, as defined in the RBLSetting class.

RBLSetting		Description
`Description`	String	A short description for display purposes.
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`Hostname`	String	The hostname of the RBL.
`IsURIBL`	Boolean	True if the RBL supports URIBL.
`Name`	String	The name of the RBL list.
`RequiredIP`	String	Required IP.
`RequiredIPEnabled`	Boolean	True if RequiredIP is enabled.
`UseBitmapChecking`	Boolean	True to use bitmap checking.
`Weight`	Int32	Weight when item is in RBL list.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

EditRBL

Edits properties of an RBL check. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`NameOfRblToEdit`	String	Name of the RBL check.
`rblSetting`	RBLSetting	New settings to apply, as defined in the RBLSetting class.

RBLSetting		Description
`Description`	String	A short description for display purposes.
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`Hostname`	String	The hostname of the RBL.
`IsURIBL`	Boolean	True if the RBL supports URIBL.
`Name`	String	The name of the RBL list.
`RequiredIP`	String	Required IP.
`RequiredIPEnabled`	Boolean	True if RequiredIP is enabled.
`UseBitmapChecking`	Boolean	True to use bitmap checking.
`Weight`	Int32	Weight when item is in RBL list.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetBayesianSettings

Returns settings for Bayesian Fitering. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns GetBayesianSettingsResult

GetBayesianSettingsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settings`	BayesianFilterSettings	Item details, as defined in the BayesianFilterSettings class.

BayesianFilterSettings		Description
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`MaxMemoryMB`	Int32	Maximum memory to dedicate to Bayesian Filtering.
`MessagesRequiredForUpdate`	Int32	Number of messages that get processed before Bayesian Filters get updated.
`Weight`	Int32	Max weight to give Bayesian Filtering.

GetCommtouchSettings

Returns settings for Commtouch. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns GetCommtouchSettingsResult

GetCommtouchSettingsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settings`	CommtouchSettings	Item details, as defined in the CommtouchSettings class.

CommtouchSettings		Description
`BulkWeight`	Int32	Weight for bulk mail.
`ConfirmedWeight`	Int32	Weight for confirmed spam.
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`NoneWeight`	Int32	Weight for none.
`SuspectWeight`	Int32	Weight for suspected spam.
`UnknownWeight`	Int32	Weight for unknown.

GetDecludeSettings

Returns settings for Declude integration. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns GetDecludeSettingsResult

GetDecludeSettingsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settings`	DecludeSettings	Item details, as defined in the DecludeSettings class.

DecludeSettings		Description
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`HighSpamWeight`	Int32	Weight for High.
`LowSpamWeight`	Int32	Weight for Low.
`MedSpamWeight`	Int32	Weight for Medium.

GetDKIMSettings

Returns settings for DKIM. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns GetDomainKeysSettingsResult

GetDomainKeysSettingsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settings`	DomainKeysSettings	Item details, as defined in the DomainKeysSettings class.

DomainKeysSettings		Description
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`FailWeight`	Int32	Weight for Fail.
`MaxKeySize`	DKKeySize	The maximum key size.
`MaxMessageSizeToSignMB`	Int32	Maximum message size (in MB) that will be signed.
`MaxMessageSizeToVerifyMB`	Int32	Maximum message size (in MB) that will be verified.
`NoneWeight`	Int32	Weight for None.
`PassWeight`	Int32	Weight for Pass.

DKKeySize Enum
0	_512
1	_768
2	_1024
3	_1536
4	_2048

GetDomainKeysSettings

Returns settings for DomainKeys. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns GetDomainKeysSettingsResult

GetDomainKeysSettingsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settings`	DomainKeysSettings	Item details, as defined in the DomainKeysSettings class.

DomainKeysSettings		Description
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`FailWeight`	Int32	Weight for Fail.
`MaxKeySize`	DKKeySize	The maximum key size.
`MaxMessageSizeToSignMB`	Int32	Maximum message size (in MB) that will be signed.
`MaxMessageSizeToVerifyMB`	Int32	Maximum message size (in MB) that will be verified.
`NoneWeight`	Int32	Weight for None.
`PassWeight`	Int32	Weight for Pass.

DKKeySize Enum
0	_512
1	_768
2	_1024
3	_1536
4	_2048

GetMessageSnifferSettings

Returns settings for MessageSniffer. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns GetMessageSnifferSettingsResult

GetMessageSnifferSettingsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settings`	MessageSnifferSettings	Item details, as defined in the MessageSnifferSettings class.

MessageSnifferSettings		Description
`ConfirmedWeight`	Int32	Weight for confirmed spam.
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`NoneWeight`	Int32	Weight for none.

GetRBL

Returns details about an RBL check. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`name`	String	Name of the RBL check.

Returns GetRBLResult

GetRBLResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settings`	RBLSetting	Item details, as defined in the RBLSetting class.

RBLSetting		Description
`Description`	String	A short description for display purposes.
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`Hostname`	String	The hostname of the RBL.
`IsURIBL`	Boolean	True if the RBL supports URIBL.
`Name`	String	The name of the RBL list.
`RequiredIP`	String	Required IP.
`RequiredIPEnabled`	Boolean	True if RequiredIP is enabled.
`UseBitmapChecking`	Boolean	True to use bitmap checking.
`Weight`	Int32	Weight when item is in RBL list.

GetRemoteSASettings

Returns settings for Remote SpamAssassin. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns GetRemoteSASettingsResult

GetRemoteSASettingsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settings`	RemoteSASettings	Item details, as defined in the RemoteSASettings class.

RemoteSASettings		Description
`ClientTimeoutSeconds`	Int32	Number of seconds to wait before check is considered timeout.
`DisableTimeMinutes`	Int32	The number of minutes to disable a remote SpamAssassin server if it is disabled automatically.
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`FailuresBeforeDisable`	Int32	Number of failures before a remote SpamAssassin server is disabled automatically.
`HighSpamWeight`	Int32	Weight for High.
`LogLevel`	SAHeaderLogLevel	The logging level.
`LowSpamWeight`	Int32	Weight for Low.
`MaxAttemptsPerMessage`	Int32	Maximum number of checks to make before skipping this check for a message.
`MedSpamWeight`	Int32	Weight for Medium.

SAHeaderLogLevel Enum
0	ScoreOnly
1	ScoreAndTestNames
2	ScoreTestNamesAndDescription

GetReverseDNSSettings

Returns settings for Reverse DNS. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns GetReverseDNSSettingsResult

GetReverseDNSSettingsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settings`	ReverseDNSSettings	Item details, as defined in the ReverseDNSSettings class.

ReverseDNSSettings		Description
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`Weight`	Int32	Weight for reverse DNS failure.

GetSABPMSettings

Returns settings for SpamAssassin-based Pattern Matching. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns GetSABPMSettingsResult

GetSABPMSettingsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settings`	SABPMSettings	Item details, as defined in the SABPMSettings class.

SABPMSettings		Description
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`HighSpamWeight`	Int32	Weight for High.
`LogLevel`	SAHeaderLogLevel	The logging level.
`LowSpamWeight`	Int32	Weight for Low.
`MedSpamWeight`	Int32	Weight for Medium.

SAHeaderLogLevel Enum
0	ScoreOnly
1	ScoreAndTestNames
2	ScoreTestNamesAndDescription

GetSpamFilteringSettings

Get spam filtering options within Antispam administration. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns AntispamFilteringSettingsResult

AntispamFilteringSettingsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settings`	AntispamFilteringSettings	Item details, as defined in the AntispamFilterSettings class.

AntispamFilteringSettings		Description
`HighSpamAction`	SpamAction	High spam action.
`HighSpamPrefix`	String	OPTIONAL: High spam prefix text.
`HighWeightThreshold`	Int32	High spam weight threshold.
`LowSpamAction`	SpamAction	Low spam action.
`LowSpamPrefix`	String	OPTIONAL: low spam prefix text.
`LowWeightThreshold`	Int32	Low spam weight threshold.
`MediumSpamAction`	SpamAction	Medium spam action.
`MediumSpamPrefix`	String	OPTIONAL: Medium spam prefix text.
`MediumWeightThreshold`	Int32	Medium spam weight threshold.

SpamAction Enum
0	None
1	Delete
2	MoveToJunkFolder
3	PrefixSubject

GetSPFSettings

Returns settings for SPF. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns GetSPFSettingsResult

GetSPFSettingsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settings`	SPFSettings	Item details, as defined in the SPFSettings class.

SPFSettings		Description
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`FailWeight`	Int32	Weight for SPF Fail.
`NeutralWeight`	Int32	Weight for SPF Neutral.
`NoneWeight`	Int32	Weight for SPF None.
`PassWeight`	Int32	Weight for SPF Pass.
`PermErrorWeight`	Int32	Weight for SPF Perm Error.
`SoftFailWeight`	Int32	Weight for SPF Soft Fail.

ListRBLs

Lists information about all RBL checks. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns ListRBLsResult

ListRBLsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`rbls`	RBLSetting[]	A list of item details, as defined in the RBLSetting class.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

RBLSetting		Description
`Description`	String	A short description for display purposes.
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`Hostname`	String	The hostname of the RBL.
`IsURIBL`	Boolean	True if the RBL supports URIBL.
`Name`	String	The name of the RBL list.
`RequiredIP`	String	Required IP.
`RequiredIPEnabled`	Boolean	True if RequiredIP is enabled.
`UseBitmapChecking`	Boolean	True to use bitmap checking.
`Weight`	Int32	Weight when item is in RBL list.

ListSpamChecks

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

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns ListSpamChecksResult

ListSpamChecksResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`spamChecks`	SpamCheckInfo[]	A list of item details, as defined in the SpamCheckInfo class.

SpamCheckInfo		Description
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`MaxWeight`	Int32	Maximum weight value.
`MinWeight`	Int32	Minimum weight value.
`Name`	String	The display name of the spam check.
`UID`	String	Unique identifier of the spam check.

RemoveRBL

Removes an RBL check. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`NameOfRblToRemove`	String	Name of the RBL check.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetAntispamOptions

Configure options for Antispam Administration. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`optionsSettings`	AntispamOptionsSettings	New settings to apply, as defined in the AntispamOptionsSettings class.

AntispamOptionsSettings		Description
`AutoRespondersLevel`	AutoResponseRestrictionLevel	Auto-reponders level.
`CatchallToSendBounces`	Boolean	True to enable catch-all accounts to send auto-responders and bounce messages.
`ContentFilterBounceLevel`	ContentFilterBounceRestrictionLevel	Content Filter Bouncing level.
`DisableFitleringOnWhitelistedIp`	Boolean	True to disable spam filtering on SMTP whitlisted IP addresses.
`EnableBouncesForOutgoingSmtpBlocking`	Boolean	True to enable bounces for SMTP blocking.
`EnableDmarc`	Boolean	True to enable DMARC policy compliance check.
`EnableSpoolProcFolder`	Boolean	True to enable spool proc folder.
`EnableSrs`	Boolean	True to enable SRS when forwarding messages.
`MaxMessageScanSize`	Int32	Max message size in KB to content scan.
`OverrideFilterActions`	Boolean	True to enable domains to override filter weights and actions.

AutoResponseRestrictionLevel Enum
1	Enabled
2	Disabled
3	RequireSpfPass
4	RequireSpfNotFail

ContentFilterBounceRestrictionLevel Enum
1	Enabled
2	Disabled
3	RequireSpfPass
4	RequireSpfNotFail

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetBayesianSettings

Configures settings for Bayesian Filtering. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`bayesSettings`	BayesianFilterSettings	New settings to apply, as defined in the BayesianFilterSettings class.

BayesianFilterSettings		Description
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`MaxMemoryMB`	Int32	Maximum memory to dedicate to Bayesian Filtering.
`MessagesRequiredForUpdate`	Int32	Number of messages that get processed before Bayesian Filters get updated.
`Weight`	Int32	Max weight to give Bayesian Filtering.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetCommtouchSettings

Configures settings for Commtouch. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`commtouchSettings`	CommtouchSettings	New settings to apply, as defined in the CommtouchSettings class.

CommtouchSettings		Description
`BulkWeight`	Int32	Weight for bulk mail.
`ConfirmedWeight`	Int32	Weight for confirmed spam.
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`NoneWeight`	Int32	Weight for none.
`SuspectWeight`	Int32	Weight for suspected spam.
`UnknownWeight`	Int32	Weight for unknown.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetDecludeSettings

Configures settings for Declude integration. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`decludeSettings`	DecludeSettings	New settings to apply, as defined in the DecludeSettings class.

DecludeSettings		Description
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`HighSpamWeight`	Int32	Weight for High.
`LowSpamWeight`	Int32	Weight for Low.
`MedSpamWeight`	Int32	Weight for Medium.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetDKIMSettings

Configures settings for DKIM. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`dkSettings`	DomainKeysSettings	New settings to apply, as defined in the DomainKeysSettings class.

DomainKeysSettings		Description
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`FailWeight`	Int32	Weight for Fail.
`MaxKeySize`	DKKeySize	The maximum key size.
`MaxMessageSizeToSignMB`	Int32	Maximum message size (in MB) that will be signed.
`MaxMessageSizeToVerifyMB`	Int32	Maximum message size (in MB) that will be verified.
`NoneWeight`	Int32	Weight for None.
`PassWeight`	Int32	Weight for Pass.

DKKeySize Enum
0	_512
1	_768
2	_1024
3	_1536
4	_2048

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetDomainKeysSettings

Configures settings for DomainKeys. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`dkSettings`	DomainKeysSettings	New settings to apply, as defined in the DomainKeysSettings class.

DomainKeysSettings		Description
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`FailWeight`	Int32	Weight for Fail.
`MaxKeySize`	DKKeySize	The maximum key size.
`MaxMessageSizeToSignMB`	Int32	Maximum message size (in MB) that will be signed.
`MaxMessageSizeToVerifyMB`	Int32	Maximum message size (in MB) that will be verified.
`NoneWeight`	Int32	Weight for None.
`PassWeight`	Int32	Weight for Pass.

DKKeySize Enum
0	_512
1	_768
2	_1024
3	_1536
4	_2048

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetMessageSnifferSettings

Configures settings for MessageSniffer. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`MessageSnifferSettings`	MessageSnifferSettings	New settings to apply, as defined in the MessageSnifferSettings class.

MessageSnifferSettings		Description
`ConfirmedWeight`	Int32	Weight for confirmed spam.
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`NoneWeight`	Int32	Weight for none.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetRemoteSASettings

Configures settings for Remote SpamAssassin. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`remoteSASettings`	RemoteSASettings	New settings to apply, as defined in the RemoteSASettings class.

RemoteSASettings		Description
`ClientTimeoutSeconds`	Int32	Number of seconds to wait before check is considered timeout.
`DisableTimeMinutes`	Int32	The number of minutes to disable a remote SpamAssassin server if it is disabled automatically.
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`FailuresBeforeDisable`	Int32	Number of failures before a remote SpamAssassin server is disabled automatically.
`HighSpamWeight`	Int32	Weight for High.
`LogLevel`	SAHeaderLogLevel	The logging level.
`LowSpamWeight`	Int32	Weight for Low.
`MaxAttemptsPerMessage`	Int32	Maximum number of checks to make before skipping this check for a message.
`MedSpamWeight`	Int32	Weight for Medium.

SAHeaderLogLevel Enum
0	ScoreOnly
1	ScoreAndTestNames
2	ScoreTestNamesAndDescription

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetReverseDNSSettings

Configures settings for Reverse DNS. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`rdnsSettings`	ReverseDNSSettings	New settings to apply, as defined in the ReverseDNSSettings class.

ReverseDNSSettings		Description
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`Weight`	Int32	Weight for reverse DNS failure.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetSABPMSettings

Configures settings for SpamAssassin-based Pattern Matching. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`sabpmSettings`	SABPMSettings	New settings to apply, as defined in the SABPMSettings class.

SABPMSettings		Description
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`HighSpamWeight`	Int32	Weight for High.
`LogLevel`	SAHeaderLogLevel	The logging level.
`LowSpamWeight`	Int32	Weight for Low.
`MedSpamWeight`	Int32	Weight for Medium.

SAHeaderLogLevel Enum
0	ScoreOnly
1	ScoreAndTestNames
2	ScoreTestNamesAndDescription

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetSpamFilteringSettings

Set spam filtering options within Antispam administration. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`filterSettings`	AntispamFilteringSettings	new settings to apply, as defined in the AntispamFilteringSettings class.

AntispamFilteringSettings		Description
`HighSpamAction`	SpamAction	High spam action.
`HighSpamPrefix`	String	OPTIONAL: High spam prefix text.
`HighWeightThreshold`	Int32	High spam weight threshold.
`LowSpamAction`	SpamAction	Low spam action.
`LowSpamPrefix`	String	OPTIONAL: low spam prefix text.
`LowWeightThreshold`	Int32	Low spam weight threshold.
`MediumSpamAction`	SpamAction	Medium spam action.
`MediumSpamPrefix`	String	OPTIONAL: Medium spam prefix text.
`MediumWeightThreshold`	Int32	Medium spam weight threshold.

SpamAction Enum
0	None
1	Delete
2	MoveToJunkFolder
3	PrefixSubject

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetSpamWizardLevel

Sets the spam checks and weights to predefined wizard levels. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`level`	SpamWizardLevel	New spam wizard preset to apply.

SpamWizardLevel Enum
0	DoNotChange
1	Low
2	Med
3	High
4	None

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetSPFSettings

Configures settings for SPF. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`spfSettings`	SPFSettings	New settings to apply, as defined in the SPFSettings class.

SPFSettings		Description
`EnabledFiltering`	Boolean	True to enable filtering.
`EnabledIncomingBlocking`	Boolean	True to enable incoming SMTP blocking.
`EnabledOutgoingBlocking`	Boolean	True to enable outgoing SMTP blocking.
`FailWeight`	Int32	Weight for SPF Fail.
`NeutralWeight`	Int32	Weight for SPF Neutral.
`NoneWeight`	Int32	Weight for SPF None.
`PassWeight`	Int32	Weight for SPF Pass.
`PermErrorWeight`	Int32	Weight for SPF Perm Error.
`SoftFailWeight`	Int32	Weight for SPF Soft Fail.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

http://dgxdatacenter-001-site2.mysitepanel.net/Services/svcUserAdmin.asmx

This web service contains functions that add, modify, and delete users.

WSDL Definition

Functions
AddRSSFeed	Add an RSS feed to the specified email address.
AddUser2	Creates a new user and adds them to the specified domain.
AddUserGroup	Creates a new user group and adds it to the specified domain.
AuthenticateUser	Returns a true ResultCode if the user name, domain name, and password match.
DeleteRSSFeed	Deletes an RSS feed from the specified email address.
DeleteUser	Deletes the specified user from the specified domain.
GetActiveSyncUsers	Returns all users in a domain that have Exchange ActiveSync enabled.
GetActiveSyncUsers2	Returns all domain-enabled Exchange ActiveSync users with device information.
GetInactiveUsers	Returns inactive users since the specified date.
GetLastLoginTimes	Gets last login time.
GetMigrationStatus	Returns the status of all migration requests.
GetRequestedUserSettings	Gets the specified user's settings.
GetUser	Returns attributes of the specified user.
GetUserAutoResponseInfo	Returns the autoresponder info of the specified user.
GetUserAutoResponseInfo2	Returns the autoresponder info of the specified user.
GetUserForwardingInfo2	Returns the forwarding info of the specified user.
GetUserGroup	Gets a user group in the specified domain with the given id.
GetUserGroupsByDomain	Get all user groups in the specified domain.
GetUserGroupsByUser	Get all user groups in the specified domain containing the give user.
GetUserQuotas	Returns Current and Max disk space for each user of a domain.
GetUsers	Returns attributes of each user in the specified domain.
GetUserStats	Returns statistics of the specified user for the specified time period.
IsUserEnabledForActiveSync	Checks whether ActiveSync is enabled for the specified user.
ListRSSFeeds	Lists all RSS feeds for the specified email address.
LoginValidated	Returns a LoginResult object with the LoginValidated field set to True if the specified username matches the specified password.
QueueMailBoxMigration	Adds a request item to be migrated to a specified mailbox. Note: Migrating gmail calendar and contacts can not be queued due to the type of authentication Google requires for accessing them.
RemoveFromMigrationQueue	Removes an item by ID from the pending migration queue.
RemoveUserGroup	Deletes a user group from the specified domain with the given id.
SetRequestedUserSettings	Updates the specified user's settings.
ToggleActiveSync	Enables or disables ActiveSync for the specified user. Note that domain-level limits are NOT enforced by this web service, and it is up to you to make the call to GetActiveSyncUsers or maintain internal tracking systems before toggling accounts in order to enforce limits.
UpdateUser2	Updates the specified user's settings.
UpdateUserAutoResponseInfo	Updates the specified user's auto response settings.
UpdateUserAutoResponseInfo2	Updates the specified user's auto response settings.
UpdateUserForwardingInfo2	Updates the specified user's forwarding settings (Multiple addresses).
UpdateUserGroup	Updates a user group in the specified domain with the given id.

Depricated: AddUser, GetUserForwardingInfo, UpdateUser, UpdateUserForwardingInfo

AddRSSFeed

Add an RSS feed to the specified email address. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`EmailAddress`	String	Full email address of the user.
`rssUrl`	String	URL of the RSS feed.
`rssName`	String	Display name of the RSS feed.
`rssFolder`	String	Folder name.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddUser

View the full specification

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. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`NewUsername`	String	Username for the user. Should not be a full email address.
`NewPassword`	String	Password for the user.
`DomainName`	String	Domain to add the user.
`FirstName`	String	First name of the user.
`LastName`	String	Last name of the user.
`IsDomainAdmin`	Boolean	True to make the user an administrator over the domain.
`maxMailboxSize`	Int32	Maximum size for the user mailbox (in MB). 0 should be passed for unlimited.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AddUserGroup

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

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	Name of the domain.
`UserGroupName`	String	Name of the user group.
`UserNames`	String[]	A list of users on the domain that should belong to the group.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

AuthenticateUser

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

Inputs

Input Parameters		Description
`UserName`	String	Username to authenticate.
`DomainName`	String	Domain that the user belongs to.
`Password`	String	The password to authenticate.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteRSSFeed

Deletes an RSS feed from the specified email address. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`EmailAddress`	String	Full email address of the user.
`UID`	String	Unique identifier of the RSS Feed.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

DeleteUser

Deletes the specified user from the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`Username`	String	Username of the user to delete.
`DomainName`	String	Domain on which the user exists.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetActiveSyncUsers

Returns all users in a domain that have Exchange ActiveSync enabled. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	Name of the domain.

Returns ActiveSyncUsersResult

ActiveSyncUsersResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`UserCount`	Int32	Count of ActiveSync users for the domain.
`Usernames`	String[]	All usernames that are activesync users for the domain.

GetActiveSyncUsers2

Returns all domain-enabled Exchange ActiveSync users with device information. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	Name of the domain.

Returns ActiveSyncUsersInfoResult

ActiveSyncUsersInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`UserCount`	Int32	Count of ActiveSync users for the domain.
`Users`	ActiveSyncUserInfoResult[]	All devices and last sync times per activesync user for the domain.

ActiveSyncUserInfoResult		Description
`Devices`	ActiveSyncDeviceInfoResult[]	ActiveSync Device Information (e.g., DeviceId, Name, UserAgent, LastSyncUtc).
`Username`	String	ActiveSync User for the domain.

ActiveSyncDeviceInfoResult		Description
`DeviceId`	String	ActiveSync Device Id.
`LastSyncUtc`	DateTime	ActiveSync Device Last Sync DateTime UTC.
`Name`	String	ActiveSync Device Name.
`UserAgent`	String	ActiveSync Device User Agent.

GetInactiveUsers

Returns inactive users since the specified date. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`date`	DateTime	All users that have not logged in since this date will be returned.

Returns InactiveUserResult

InactiveUserResult		Description
`EmailAddress`	String[]	A list of email addresses in the result set.
`LastLogin`	DateTime[]	A list of last login times. Results in this array directly correspond to the results in the EmailAddresses array.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetLastLoginTimes

Gets last login time. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`EmailAddress`	String	Full email address of the user.
`DateStart`	Nullable<DateTime>	If set, limits the results so that nothing will be returned before this date.
`DateEnd`	Nullable<DateTime>	If set, limits the results so that nothing will be returned after this date.

Returns LastLoginInfoResult

LastLoginInfoResult		Description
`lastLogins`	String[]	A list of the last login names.
`lastUserLogins`	UserLoginInfo[]	A list of details about the last logins, as defined in the UserLoginInfo class.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

UserLoginInfo		Description
`LoginTime`	DateTime	Last login time for the user.
`UserName`	String	Username for the user.

GetMigrationStatus

Returns the status of all migration requests. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns StatusResults[]

StatusResults		Description
`emailAddress`	String	Email address that is being migrated.
`ID`	Guid	Unique identifier of the migration.
`status`	String	Status of the migration.

GetRequestedUserSettings

Gets the specified user's settings. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`EmailAddress`	String	Full email address of the user.
`requestedSettings`	String[]	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) backupemailaddress (The email address to which password resets will be sent) calendarautocleanmonths (The number of months after a calendar entry is inactive such that it will be automatically removed. -2 = Use domain settings, -1 = Never) composemethod (html) composerows (Delete messages after auto forwarding) deleteoption (MoveToDeleteFolder, AutoPurge, MarkDeleted, MarkDeletedAndHide) dictionarylanguag(en-US, etc) disablegreylisting disablereminders displayname (Display name of the user) embedreplies (Attach forwards) enabledstatus (Enabled, Disabled, DisabledWMail) enableimapretrieval (Is IMAP retrieval allowed for this account) enableoutboundmessagesigning (Sign outgoing messages via DomainKeys for this account) enablepopretrieval (Is POP retrieval allowed for this account) enablesmtpaccounts (Are SMTP Accounts allowed for this account) 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. For example, to set POP and IMAP, the value of 3 would be passed.) showlinkswhenprinting (Show HTML links when printing a page) 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) spellcheckonsend (Automatically check spelling prior to sending) 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) warnifcomposemistakes (Warn about common email mistakes prior to sending) welcomewizardprogress (progress of welcome page)

Returns SettingsRequestResult

SettingsRequestResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settingValues`	String[]	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. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`EmailAddress`	String	Full email address of the user.

Returns UserInfoResult

UserInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`UserInfo`	UserInfo	Information about a user, as defined in the UserInfo class.

UserInfo		Description
`FirstName`	String	First name of the user.
`IsDomainAdmin`	Boolean	True if the user is a domain administrator.
`IsSystemAdmin`	Boolean	True if the user is a system administrator.
`LastName`	String	Last name of the user.
`Password`	String	Password for the user.
`UserName`	String	Username for the user.

GetUserAutoResponseInfo

Returns the autoresponder info of the specified user. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`EmailAddress`	String	Full email address of the user.

Returns UserAutoResponseResult

UserAutoResponseResult		Description
`Body`	String	Body of auto-responses.
`Enabled`	Boolean	True if auto-responder is enabled.
`EndTimeUTC`	DateTime
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`StartTimeUTC`	DateTime
`Subject`	String	Subject of auto-responses.
`UseTimes`	Boolean

GetUserAutoResponseInfo2

Returns the autoresponder info of the specified user. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`EmailAddress`	String	Full email address of the user.

Returns UserAutoResponseResult

UserAutoResponseResult		Description
`Body`	String	Body of auto-responses.
`Enabled`	Boolean	True if auto-responder is enabled.
`EndTimeUTC`	DateTime
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`StartTimeUTC`	DateTime
`Subject`	String	Subject of auto-responses.
`UseTimes`	Boolean

GetUserForwardingInfo

View the full specification

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. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`EmailAddress`	String	Full email address of the user.

Returns UserForwardingInfoResult2

UserForwardingInfoResult2		Description
`DeleteOnForward`	Boolean	True to delete emails when they are forwarded.
`ForwardingAddresses`	String[]	A list of email addresses to forward mail to.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

GetUserGroup

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

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	Name of the domain.
`UserGroupID`	String	Unique identifier of the user group.

Returns UserGroupInfoResult

UserGroupInfoResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`UserGroup`	UserGroupInfo	Details of the user group, as defined in the UserGroupInfo class.

UserGroupInfo		Description
`guid`	String	Unique identifier for the user group.
`name`	String	Display name for the user group.
`userNames`	String[]	A list of usernames that belong to the group.

GetUserGroupsByDomain

Get all user groups in the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	Name of the domain.

Returns UserGroupsResult

UserGroupsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`UserGroups`	UserGroupInfo[]	A list of details about user groups, as defined in the UserGroupInfo class.

UserGroupInfo		Description
`guid`	String	Unique identifier for the user group.
`name`	String	Display name for the user group.
`userNames`	String[]	A list of usernames that belong to the group.

GetUserGroupsByUser

Get all user groups in the specified domain containing the give user. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	Name of the domain.
`UserName`	String	Name of user to search for.
`IncludeUserNames`	Boolean	True to return other members of the groups.

Returns UserGroupsResult

UserGroupsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`UserGroups`	UserGroupInfo[]	A list of details about user groups, as defined in the UserGroupInfo class.

UserGroupInfo		Description
`guid`	String	Unique identifier for the user group.
`name`	String	Display name for the user group.
`userNames`	String[]	A list of usernames that belong to the group.

GetUserQuotas

Returns Current and Max disk space for each user of a domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	Name of the domain.

Returns QuotaInfoListResult

QuotaInfoListResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Users`	UserQuota[]	A list of quota details, as defined in the UserQuota class.

UserQuota		Description
`CurrentSpace`	Int64	Current disk space used.
`MaxSpace`	Int64	Max disk space allowed.
`UserName`	String	Username for this record.

GetUsers

Returns attributes of each user in the specified domain. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	Name of the domain.

Returns UserInfoListResult

UserInfoListResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Users`	UserInfo[]	A list of user details, as defined in the UserQuota class.

UserInfo		Description
`FirstName`	String	First name of the user.
`IsDomainAdmin`	Boolean	True if the user is a domain administrator.
`IsSystemAdmin`	Boolean	True if the user is a system administrator.
`LastName`	String	Last name of the user.
`Password`	String	Password for the user.
`UserName`	String	Username for the user.

GetUserStats

Returns statistics of the specified user for the specified time period. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`EmailAddress`	String	Full email address of the user.
`Start`	DateTime	Start date of the statistics range to retrieve.
`End`	DateTime	End date of the statistics range to retrieve.

Returns StatInfoResult

StatInfoResult		Description
`BytesReceived`	Int64	The number of bytes received.
`BytesSent`	Int64	The number of bytes sent.
`BytesSize`	Int64	The size on disk.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`MessagesReceived`	Int64	Number of messages received.
`MessagesSent`	Int64	Number of messages sent.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

IsUserEnabledForActiveSync

Checks whether ActiveSync is enabled for the specified user. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`EmailAddress`	String	Full email address of the user.
`Enabled`	Boolean	This parameter is unused.

Returns ActiveSyncEnabledResult

ActiveSyncEnabledResult		Description
`Enabled`	Boolean	True if ActiveSync is enabled.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ListRSSFeeds

Lists all RSS feeds for the specified email address. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`EmailAddress`	String	Full email address of the user.

Returns RSSFeedListResult

RSSFeedListResult		Description
`Folders`	String[]	A list of folder names.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`RSSFeeds`	RSSFeed[]	A list of details about the feeds, as defined in the RSSFeed class.

RSSFeed		Description
`folder`	String	Folder name that the feed belongs to.
`name`	String	Display name for the feed.
`uid`	String	Unique identifier for the feed.
`url`	String	URL 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. View the full specification

Inputs

Input Parameters		Description
`Username`	String	Username to check.
`Password`	String	Password to check.

Returns LoginResult

LoginResult		Description
`LoginValidated`	Boolean	True if the login is valid.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`ResultCode`	Int32	A result code, which differs by function.

QueueMailBoxMigration

Adds a request item to be migrated to a specified mailbox. Note: Migrating gmail calendar and contacts can not be queued due to the type of authentication Google requires for accessing them. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`parameters`	String[]	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

RequestStatusResult		Description
`KeyValuePairs`	String[]	A list of 'key=value' pairs. A list of keys can be found in the QueueMailBoxMigration function.
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

RemoveFromMigrationQueue

Removes an item by ID from the pending migration queue. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`itemID`	Guid	Unique identifier of item to remove.

Returns Void

RemoveUserGroup

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

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	Name of the domain.
`UserGroupID`	String	Unique identifier of the user group to delete.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetRequestedUserSettings

Updates the specified user's settings. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`EmailAddress`	String	Full email address of the user.
`newSettings`	String[]	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

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

ToggleActiveSync

Enables or disables ActiveSync for the specified user. Note that domain-level limits are NOT enforced by this web service, and it is up to you to make the call to GetActiveSyncUsers or maintain internal tracking systems before toggling accounts in order to enforce limits. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`EmailAddress`	String	Full email address of the user.
`Enabled`	Boolean	True to enable ActiveSync.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

UpdateUser

View the full specification

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. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`EmailAddress`	String	Full email address of the user to update.
`NewPassword`	String	New password for the user.
`NewFirstName`	String	New first name of the user.
`NewLastName`	String	New last name of the user.
`IsDomainAdmin`	Boolean	True to make the user an administrator over the domain.
`maxMailboxSize`	Int32	Maximum size for the user mailbox (in MB).

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

UpdateUserAutoResponseInfo

Updates the specified user's auto response settings. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`EmailAddress`	String	Full email address of the user to update.
`Enabled`	Boolean	True to enable the auto-responder.
`Subject`	String	Subject of the auto-response email.
`Body`	String	Body of the auto-response email.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

UpdateUserAutoResponseInfo2

Updates the specified user's auto response settings. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`EmailAddress`	String	Full email address of the user to update.
`Enabled`	Boolean	True to enable the auto-responder.
`Subject`	String	Subject of the auto-response email.
`Body`	String	Body of the auto-response email.
`StartDateUTC`	DateTime
`EndDateUTC`	DateTime

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

UpdateUserForwardingInfo

View the full specification

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). View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`EmailAddress`	String	Full email address of the user to update.
`DeleteOnForward`	Boolean	True to delete emails that are forwarded.
`ForwardingAddresses`	String[]	A list of email addresses to forward to.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

UpdateUserGroup

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

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`DomainName`	String	Name of the domain.
`UserGroupID`	String	Unique identifier of the user group to update.
`UserGroupName`	String	New name of the user group.
`UserNames`	String[]	New list of users on the domain that should belong to the group.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

http://dgxdatacenter-001-site2.mysitepanel.net/Services/svcVirusAdmin.asmx

This web service contains functions that modify virus settings.

WSDL Definition

Functions
GetAntivirusOptions	Get current settings for the AntiVirus options.
GetClamAvSettings	Get current settings specific to ClamAV.
GetCommandLineAvSettings	Get current settings specific to Command-Line AV.
GetCommtouchZeroHourSettings	Set current settings specific to CommTouch Zero-Hour anti-virus.
GetRealtimeAvSettings	Get current settings specific to Real-time AV.
SetAntivirusOptions	Set current settings for the AntiVirus options.
SetClamAvSettings	Set current settings specific to ClamAV.
SetCommandLineAvSettings	Set current settings specific to Command-line AV.
SetCommtouchZeroHourSettings	Set current settings specific to Command-line AV.
SetRealtimeAvSettings	Set current settings specific to Real-Time AV.

GetAntivirusOptions

Get current settings for the AntiVirus options. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns GetAntivirusOptionsSettingsResult

GetAntivirusOptionsSettingsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settings`	AntivirusOptionsSettings	Item details, as defined in the AntivirusOptionsSettings class.

AntivirusOptionsSettings		Description
`EnableClamAv`	Boolean	True to enable ClamAV.
`EnableCommandLineAv`	Boolean	True to enable command-line AV.
`EnableCommTouchAv`	Boolean	True to enable CommTouch Zero-Hour Antivirus.
`EnableRealTimeAv`	Boolean	True to enable real-time AV.
`QuarantineLength`	Int32	Number of days to keep Quaratine items. 0, 15, or 30 days.

GetClamAvSettings

Get current settings specific to ClamAV. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns GetClamAvSettingsResult

GetClamAvSettingsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settings`	ClamAvSettings	Item details, as defined in the AntivirusOptionsSettings class.

ClamAvSettings		Description
`ClamIpAddress`	String	IP address of Clam AV Sever.
`ClamPort`	Int32	Clam AV port.
`IsRemoteServer`	Boolean	true for remote server.
`NumOfFailures`	Int32	Number of failures before disable.
`Timeout`	Int32	Timeout in seconds.

GetCommandLineAvSettings

Get current settings specific to Command-Line AV. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns GetCommandLineAvSettingsResult

GetCommandLineAvSettingsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settings`	CommandLineAvSettings	Item details, as defined in the CommandLineAvSettings class.

CommandLineAvSettings		Description
`CommandLine`	String	Command Line to be added.

GetCommtouchZeroHourSettings

Set current settings specific to CommTouch Zero-Hour anti-virus. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns GetCommtouchZeroHourSettingsResult

GetCommtouchZeroHourSettingsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`Settings`	CommtouchZeroHourSettings	Item details, as defined in the CommtouchZeroHourSettings class.

CommtouchZeroHourSettings		Description
`HighResultAction`	CommtouchAntiVirusAction	High Result Action.
`MediumResultAction`	CommtouchAntiVirusAction	Medium Result Action.
`VirusResultAction`	CommtouchAntiVirusAction	Virus Result Action.

CommtouchAntiVirusAction Enum
0	None
1	Delete
2	MoveToJunk
3	PrependSubject

GetRealtimeAvSettings

Get current settings specific to Real-time AV. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.

Returns GetRealtimeAvSettingsResult

GetRealtimeAvSettingsResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.
`settings`	RealtimeAvSettings	Item details, as defined in the RealtimeAvSettings class.

RealtimeAvSettings		Description
`QuarnentineDirectory`	String	Quarantine Directory.
`VirusAction`	VirusActionOption	Virus action to be taken.

VirusActionOption Enum
0	Delete
1	InformSender

SetAntivirusOptions

Set current settings for the AntiVirus options. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`avSettings`	AntivirusOptionsSettings	New settings to apply, as defined in the AntivirisuOptionsSettings class.

AntivirusOptionsSettings		Description
`EnableClamAv`	Boolean	True to enable ClamAV.
`EnableCommandLineAv`	Boolean	True to enable command-line AV.
`EnableCommTouchAv`	Boolean	True to enable CommTouch Zero-Hour Antivirus.
`EnableRealTimeAv`	Boolean	True to enable real-time AV.
`QuarantineLength`	Int32	Number of days to keep Quaratine items. 0, 15, or 30 days.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetClamAvSettings

Set current settings specific to ClamAV. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`clamSettings`	ClamAvSettings	Settings to apply, as defined in the ClamAvSettings Class.

ClamAvSettings		Description
`ClamIpAddress`	String	IP address of Clam AV Sever.
`ClamPort`	Int32	Clam AV port.
`IsRemoteServer`	Boolean	true for remote server.
`NumOfFailures`	Int32	Number of failures before disable.
`Timeout`	Int32	Timeout in seconds.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetCommandLineAvSettings

Set current settings specific to Command-line AV. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`commandLineSettings`	CommandLineAvSettings	settings to apply, as deined in the CommandLineAvSettings class.

CommandLineAvSettings		Description
`CommandLine`	String	Command Line to be added.

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetCommtouchZeroHourSettings

Set current settings specific to Command-line AV. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`CommtouchSettings`	CommtouchZeroHourSettings	settings to apply, as deined in the CommtouchZeroHourSettings class.

CommtouchZeroHourSettings		Description
`HighResultAction`	CommtouchAntiVirusAction	High Result Action.
`MediumResultAction`	CommtouchAntiVirusAction	Medium Result Action.
`VirusResultAction`	CommtouchAntiVirusAction	Virus Result Action.

CommtouchAntiVirusAction Enum
0	None
1	Delete
2	MoveToJunk
3	PrependSubject

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.

SetRealtimeAvSettings

Set current settings specific to Real-Time AV. View the full specification

Inputs

Input Parameters		Description
`AuthUserName`	String	Username with permissions to call this web service.
`AuthPassword`	String	Password of the account used in authUserName parameter.
`realtimeSettings`	RealtimeAvSettings	settings to apply, as defined in the RealtimeAvSettings class.

RealtimeAvSettings		Description
`QuarnentineDirectory`	String	Quarantine Directory.
`VirusAction`	VirusActionOption	Virus action to be taken.

VirusActionOption Enum
0	Delete
1	InformSender

Returns GenericResult

GenericResult		Description
`Message`	String	A text message explaining the results of the operation, including the reason for any failures.
`Result`	Boolean	Returns true if the function call was successful.
`ResultCode`	Int32	A result code, which differs by function.