Rackspace Email & Apps API - User contributions [en]

Exchange Distribution List (Rest API)

2015-04-15T20:56:50Z

James.morgan: /* Distribution List */ removed verbs column from distro list table

__TOC__

== v1 - Current ==

This resource supports submitting and responding with both XML and JSON.
(The v0 method of submitting data via form URL-encoded variables is NOT supported in v1.)

=== Data Model ===

(See [[Common_Exchange_API_Concepts#Serialization|Serialization]])

==== Distribution List ====

Operations:

* Exchange Distribution List [[#List|List]], [[#Create|Create]], [[#Read|Read]], [[#Update|Update]], [[#Delete|Delete]], [[#Import|Import]], [[#Export|Export]]

This model extends [[Common_Exchange_API_Concepts#Mailbox|Mailbox]].

{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| Description
| String
| A user-defined description of the list.
|-
| MemberCount
| Integer
| A number of members currently assigned to this list.
|-
| PrimarySmtpAddress
| String
| The external email address for this list.
|-
| EmailAddresses
| [[#Email Address|Email Address]] Array
| [[#Email Addresses|See examples below.]]
|-
| Members
| [[#Members|Members]] Object
| [[#Members_2|See examples below.]]
|-
| AcceptMessagesOnlyFrom
| [[#Senders|Senders]] Object
| [[#Senders_2|See examples below.]]
|}

==== Email Addresses ====

{| class="wikitable"
!''Field Name''
!''Data Type''
!''Verbs''
!''Description''
|-
| Action
| String
| PUT
| Must be 'Add', 'Update' or 'Remove'
|-
| AddressPrimary
| Boolean
| GET, PUT
| True if this is the primary email address. Only one email address can be primary
|-
| AddressProtocol
| String
| GET, POST, PUT
| Must be 'smtp' or 'x500'. The primary email address must be 'smtp'
|-
| Value
| String
| GET, POST, PUT
| The email address, including the domain (See example below)
|}

When creating a new mailbox you are allowed to configure alternate email addresses, however there are a few special considerations

'''Allowed Domains'''
* Primary Domain (specified in the url)
* Accepted Domains

'''Domain Aliases'''
* Each email address entry using the primary domain will result in a corresponding entry for each domain alias
** ''Example:'' Adding myalternate@primary.com will also add an entry for myalternate@alias1.com and myalternate@alias2.com
** ''Example:'' Removing myalternate@primary.com will also remove myalternate@alias1.com and myalternate@alias2.com
* Domain alias entries cannot be independently added or removed

'''Common Name Email Address'''
* The common name email address is the mailbox name and domain used in the url
* The common name email address cannot be removed

'''AddressPrimary (Reply-To)'''
* The primary address is automatically set based on the supplied CommonName when the mailbox is added
** An entry for CommonName@PrimaryDomain will be added to the email address list with AddressPrimary set to 'true'
* The primary address can be changed after the mailbox is created
* Changing the primary address does not change the name of the mailbox
* Deleting the primary address without setting another address as the primary address will result in the common name email address being reset as the primary address

----

==== Members ====

{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| Recipients
| [[#Recipient|Recipient]] Array
| Array of Recipient (see below).
|}

==== Senders ====

{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| All
| String
| Must be 'restricted' or 'public'. In order to add specific recipients, this must be 'restricted'.
|-
| Recipients
| [[#Recipient|Recipient]] Array
| Array of Recipient (see below).
|}

==== Recipient ====

{| class="wikitable"
!''Field Name''
!''Data Type''
!''Verbs''
!''Description''
|-
| Value
| String
| GET, PUT
| Email Address
|-
| Action
| String
| PUT
| Must be "Add" or "Remove".
|}

----

=== List ===

{| class="wikitable"
! Verb
| GET
|-
! URL Format
| /v1/customers/{customer account number}/domains/{domain name}/ex/distributionLists/
|-
! Description
| Lists Distribution Lists, supports exporting. (see [[Common Exchange API Concepts#Listings|Listings]])
|-
! Model
| [[#Distribution List|Distribution List]] Listing
|}

HTTP Codes

{| class="wikitable"
! Code
! Condition
|-
| 200 OK
| The listing was successfully retrieved.
|-
| 400 Bad Request
| The request was invalid. Inspect the <tt>validationFault</tt> response for more detail.
|-
| 404 Not Found
| The domain does not exist, the domain does not have Exchange, or the marker was not found. Inspect the <tt>itemNotFoundFault</tt> for more detail.
|}

<pre>
Request:
GET https://api.emailsrvr.com/v1/domains/example.com/ex/distributionlists

Response:
200 OK
{
"DistributionLists": [
{
"Description": "This is an example of an edited DL.",
"MemberCount": 0,
"CommonName": "exampledl",
"DisplayName": "ExampleDL",
"Alias": "exampledl.example.com",
"IsHiddenFromAddressList": false,
"PrimarySmtpAddress": "exampledl@example.com",
"Status": "Ready",
"LegacyExchangeDn": "/o=e14s/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Recipients/cn=exampledl59c"
}
],
"Sort": "primarysmtpaddress",
"Limit": 25,
"Total": 1,
"Order": "asc"
}
</pre>

=== Distribution List ===

POSTS, PUTS, and DELETES support [[Common_Exchange_API_Concepts#Asynchronous_Statuses|Asynchronous Statuses]] and [[Common_Exchange_API_Concepts#Asynchronous_Errors|Asynchronous Errors]].

==== Create ====

{| class="wikitable"
! Verb
| POST
|-
! URL Format
| /v1/customers/{customer account number}/domains/{domain name}/ex/distributionLists/
|-
! Description
| Use this route to add a new Distribution List.
|-
! Model
| [[#Distribution List|Distribution List]]
|}

HTTP Codes

{| class="wikitable"
! Code
! Condition
|-
| 204 No Content
| The request has been accepted and will be processed.
|-
| 400 Bad Request
| The request was invalid. Inspect the <tt>validationFault</tt> response for more detail.
|-
| 404 Not Found
| The domain does not exist, the domain does not have Exchange, or the marker was not found. Inspect the <tt>itemNotFoundFault</tt> for more detail.
|}

<pre>
Request:
POST: https://api.emailsrvr.com/v1/domains/example.com/ex/distributionlists
{
"Description": "This is an example DL.",
"CommonName": "ExampleDL",
"DisplayName": "ExampleDL",
"IsHiddenFromAddressList": false,
"EmailAddresses": [
{
"Action":"Add",
"Value": "exampledl-alias@example.com",
"AddressPrimary": false,
"AddressProtocol": "smtp"
}
],
"Members": {
"Recipients": [
{
"Action":"Add",
"Value":"mexuser1"
},
{
"Action":"Add",
"Value":"mexuser2"
}
]
},
"AcceptMessagesOnlyFrom": {
"All":"restricted",
"Recipients": [
{
"Action":"Add",
"Value":"mexuser1"
},
{
"Action":"Add",
"Value":"mexuser2"
}
]
}
}

Response:
204 No Content
</pre>

==== Read ====

{| class="wikitable"
! Verb
| GET
|-
! URL Format
| /v1/customers/{customer account number}/domains/{domain name}/ex/distributionLists/{common name}
|-
! Description
| Use this route to read an existing Distribution List.
|-
! Model
| [[#Distribution List|Distribution List]] *
|}

<nowiki>*</nowiki> Note: The Distribution List resource contains some paged data that must be accessed via separate GET requests. Properties directly on the object can be accessed via a GET on the base resource, however [[#Members|Members]] and [[#Senders|Senders]] must each be retrieved by separate requests.

HTTP Codes

{| class="wikitable"
! Code
! Condition
|-
| 200 OK
| The resource was successfully retrieved.
|-
| 400 Bad Request
| The request was invalid. Inspect the <tt>validationFault</tt> response for more detail.
|-
| 404 Not Found
| The domain does not exist, the domain does not have Exchange, or the marker was not found. Inspect the <tt>itemNotFoundFault</tt> for more detail.
|}

<pre>
Request:
GET: https://api.emailsrvr.com/v1/domains/example.com/ex/distributionlists/ExampleDL

Response:
200 OK
{
"Description": "This is an example DL.",
"MemberCount": 2,
"CommonName": "exampledl",
"DisplayName": "Example DL",
"Alias": "exampledl.example.com",
"IsHiddenFromAddressList": false,
"PrimarySmtpAddress": "exampledl@example.com",
"Status": "Ready",
"LegacyExchangeDn": "/o=e14s/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Recipients/cn=exampledl59c"
}
</pre>

==== Update ====

{| class="wikitable"
! Verb
| PUT
|-
! URL Format
| /v1/customers/{customer account number}/domains/{domain name}/ex/distributionLists/{common name}
|-
! Description
| Updates an existing Distribution List.
|-
! Model
| [[#Distribution_List|Distribution List]]
|}

HTTP Codes

{| class="wikitable"
! Code
! Condition
|-
| 204 No Content
| The request has been accepted and will be processed.
|-
| 400 Bad Request
| The request was invalid. Inspect the <tt>validationFault</tt> response for more detail.
|-
| 404 Not Found
| The domain does not exist, the domain does not have Exchange, or the marker was not found. Inspect the <tt>itemNotFoundFault</tt> for more detail.
|}

All data that is part of the Exchange Distribution List resource can be updated in a single PUT request. <tt>Recipients</tt> and <tt>AcceptMessagesOnlyFrom</tt> must specify an <tt>Action</tt>, set to either <tt>Add</tt> or <tt>Remove</tt>, to specify the operation for that value. <tt>AcceptMessagesOnlyFrom</tt> also has an additional parameter <tt>All</tt> that can be set to <tt>restricted</tt> (to specify specific allowed senders) or <tt>public</tt>.

<pre>
Request:
PUT: https://api.emailsrvr.com/v1/domains/example.com/ex/distributionlists/ExampleDL
{
"Description": "This is an example of an edited DL.",
"DisplayName": "ExampleDL",
"IsHiddenFromAddressList": false,
"EmailAddresses": [
{
"Action":"remove",
"Value": "exampledl-alias@example.com",
"AddressPrimary": false,
"AddressProtocol": "smtp"
}
],
"Members": {
"Recipients": [
{
"Action":"Remove",
"Value":"mexuser1"
},
{
"Action":"Add",
"Value":"mexuser3"
}
]
},
"AcceptMessagesOnlyFrom": {
"All":"restricted",
"Recipients": [
{
"Action":"Remove",
"Value":"mexuser3"
},
{
"Action":"Add",
"Value":"mexuser2"
}
]
}
}

Response:
204 No Content
</pre>

==== Delete ====

{| class="wikitable"
! Verb
| DELETE
|-
! URL Format
| /v1/customers/{customer account number}/domains/{domain name}/ex/distributionList/{common name}
|-
! Description
| Use this route to delete a distribution list.
|-
! Model
| None
|}

HTTP Codes

{| class="wikitable"
! Code
! Condition
|-
| 204 No Content
| The request has been accepted and will be processed.
|-
| 400 Bad Request
| The request was invalid. Inspect the <tt>validationFault</tt> response for more detail.
|-
| 404 Not Found
| The domain does not exist, the domain does not have Exchange, or the marker was not found. Inspect the <tt>itemNotFoundFault</tt> for more detail.
|}

<pre>
Request:
DELETE https://api.emailsrvr.com/v1/domains/example.com/ex/distributionList/ExampleDL

Response:
204 No Content
</pre>

----

==== Export ====

{| class="wikitable"
! Verb
| GET
|-
! URL Format
| /v1/customers/{customer account number}/domains/{domain name}/ex/distributionLists?exportTo={your email address}
|-
! Description
| Use this route to export a file of distribution lists.
|-
! Model
| [[#Distribution List|Distribution List]] Listing
|}

HTTP Codes

{| class="wikitable"
! Code
! Condition
|-
| 202 Accepted
| The request has been accepted and will be processed.
|-
| 400 Bad Request
| The request was invalid. Inspect the <tt>validationFault</tt> response for more detail.
|-
| 404 Not Found
| The domain does not exist, the domain does not have Exchange, or the marker was not found. Inspect the <tt>itemNotFoundFault</tt> for more detail.
|}

<pre>
Request:
GET https://api.emailsrvr.com/v1/domains/example.com/ex/distributionLists?exportTo=myAdminEmail@example.com

Response:
202 Accepted
</pre>

----

==== Import ====

{| class="wikitable"
! Verb
| POST
|-
! URL Format
| /v1/customers/{customer account number}/domains/{domain name}/ex/distributionLists?emailAddress={your email address}
|-
! Description
| Use this route to import a file of distribution lists.
|-
! Model
| FileUrl (string), OverrideExisting (boolean)
|}

HTTP Codes

{| class="wikitable"
! Code
! Condition
|-
| 202 Accepted
| The request has been accepted and will be processed.
|-
| 400 Bad Request
| The request was invalid. Inspect the <tt>validationFault</tt> response for more detail.
|-
| 404 Not Found
| The domain does not exist, the domain does not have Exchange, or the marker was not found. Inspect the <tt>itemNotFoundFault</tt> for more detail.
|}

Instructions:

1. Create a CSV (comma-separated values) file containing the distribution lists you'd like to import. You can get a valid CSV file format by bulk-exporting your current distribution lists.

2. Upload the file to a public accessible URL (e.g. cloud-files, CDN, etc.)

3. Call this endpoint with the url of the file in the body.

4. The OverrideExisting field is optional and defaults to false. When true, any existing distribution lists will be modified to match the CSV file, including the removal of members and senders.
* NOTE: The Description field will be cleared out if left blank when OverrideExisting is true or false.

5. You will receive a confirmation email to the address specified in the URL when the import is complete. Any rows that were not able to be imported are available via a link provided in the confirmation email.

<pre>
Request:
POST https://api.emailsrvr.com/v1/domains/example.com/ex/distributionLists?emailAddress=myAdminEmail@example.com
{
"FileUrl": "http://asdfasdfzxcvzxcvasdfasdf.cf1.rackcdn.com/MyDistributionLists.csv",
"OverrideExisting": false
}
Response:
202 Accepted
</pre>

----

==== Email Addresses====

===== List =====

{| class="wikitable"
! Verb
| GET
|-
! URL Format
| /v1/customers/{customer account number}/domains/{domain name}/ex/distributionLists/{common name}/emailaddresses
|-
! Description
| Lists an existing Distribution List's alternate email addresses. (see [[Common Exchange API Concepts#Listings|Listings]])
|-
! Model
| [[#Email Address|Email Address]] Listing
|}

HTTP Codes

{| class="wikitable"
! Code
! Condition
|-
| 200 OK
| The data was successfully retrieved.
|-
| 404 Not Found
| The domain does not exist, the domain does not have Exchange, or the resource was not found. Inspect the <tt>itemNotFoundFault</tt> for more detail.
|}

<pre>
GET: https://api.emailsrvr.com/v1/domains/example.com/ex/distributionlists/ExampleDL/emailaddresses

Response:
200 OK
{
"EmailAddresses": [
{
"Value": "exampledl@example.com",
"AddressPrimary": true,
"AddressProtocol": "smtp"
},
{
"Value": "exampledl-alias@example.com",
"AddressPrimary": false,
"AddressProtocol": "smtp"
}
],
"Limit": 25,
"Total": 2,
"Order": "asc"
}
</pre>

==== Members ====

===== List =====

{| class="wikitable"
! Verb
| GET
|-
! URL Format
| /v1/customers/{customer account number}/domains/{domain name}/ex/distributionLists/{common name}/members
|-
! Description
| Lists an existing Distribution List's Members. (see [[Common Exchange API Concepts#Listings|Listings]])
|-
! Model
| [[#Members|Members]] Listing
|}

HTTP Codes

{| class="wikitable"
! Code
! Condition
|-
| 200 OK
| The data was successfully retrieved.
|-
| 404 Not Found
| The domain does not exist, the domain does not have Exchange, or the resource was not found. Inspect the <tt>itemNotFoundFault</tt> for more detail.
|}

<pre>
GET: https://api.emailsrvr.com/v1/domains/example.com/ex/distributionlists/ExampleDL/members

Response:
200 OK
{
"Recipients": [
{
"Value": "mexuser1"
},
{
"Value": "mexuser2"
}
],
"Limit": 25,
"Total": 2,
"Order": "asc"
}
</pre>

==== Senders ====

===== List =====

{| class="wikitable"
! Verb
| GET
|-
! URL Format
| /v1/customers/{customer account number}/domains/{domain name}/ex/distributionlists/{common name}/senders
|-
! Description
| Lists an existing Distribution List's Senders. (see [[Common Exchange API Concepts#Listings|Listings]])
|-
! Model
| [[#Senders|Senders]] Listing
|}

HTTP Codes

{| class="wikitable"
! Code
! Condition
|-
| 200 OK
| The data was successfully retrieved.
|-
| 404 Not Found
| The domain does not exist, the domain does not have Exchange, or the resource was not found. Inspect the <tt>itemNotFoundFault</tt> for more detail.
|}

<pre>
GET: https://api.emailsrvr.com/v1/domains/example.com/ex/distributionlists/ExampleDL/senders

Response:
200 OK
{
"All": "restricted",
"Recipients": [
{
"Value": "mexuser1"
},
{
"Value": "mexuser2"
}
],
"Limit": 25,
"Total": 2,
"Order": "asc"
}
</pre>

=== New Distribution List Options ===

<tt><nowiki>https://api.emailsrvr.com/v1/domains/(domain)/ex/distributionListOptions/</nowiki></tt> is the base URL for getting complete sets of valid data that can be submitted as part of a Distribution List create operation.

==== Available Senders Recipients ====

{| class="wikitable"
! Verb
| GET
|-
! URL Format
| /v1/customers/{customer account number}/domains/{domain name}/ex/distributionListOptions/AvailableSendersRecipients
|-
! Description
| Use this route to retrieve a list of recipients that can be senders for a new Distribution List on the given domain.
|-
! Model
| [[#Senders|Senders]] Listing
|}

<pre>
Request:
GET https://api.emailsrvr.com/v1/customers/all/domains/example.com/ex/distributionlistOptions/AvailableSendersRecipients

Response:
200 OK
{
"Recipients": [
{
"Value": "mexuser1"
},
{
"Value": "mexuser2"
},
{
"Value": "mexuser3"
},
{
"Value": "mexuser4"
}
],
"Limit": 25,
"Total": 2,
"Order": "asc"
}
</pre>

==== Available Members Recipients ====

{| class="wikitable"
! Verb
| GET
|-
! URL Format
| /v1/customers/{customer account number}/domains/{domain name}/ex/distributionListOptions/AvailableMembersRecipients
|-
! Description
| Use this route to retrieve a list of recipients that can be Members for a new Distribution List on the given domain.
|-
! Model
| [[#Members|Members]] Listing
|}

<pre>
Request:
GET https://api.emailsrvr.com/v1/customers/all/domains/example.com/ex/distributionlistOptions/AvailableMembersRecipients

Response:
200 OK
{
"Recipients": [
{
"Value": "mexuser1"
},
{
"Value": "mexuser2"
},
{
"Value": "mexuser3"
},
{
"Value": "mexuser4"
}
],
"Limit": 25,
"Total": 2,
"Order": "asc"
}
</pre>

=== Existing Distribution List Options ===

<tt><nowiki>https://api.emailsrvr.com/v1/domains/(domain)/ex/distributionLists/(common name)/options</nowiki></tt> is the base URL for getting complete sets of valid data that can be submitted as part of a Distribution List update operation.

==== Available Senders Recipients ====

{| class="wikitable"
! Verb
| GET
|-
! URL Format
| /v1/customers/{customer account number}/domains/{domain name}/ex/distributionLists/{common name}/options/AvailableSendersRecipients
|-
! Description
| Use this route to retrieve a list of recipients that can be senders for a specific Distribution List on the given domain.
|-
! Model
| [[#Senders|Senders]] Listing
|}

<pre>
Request:
GET https://api.emailsrvr.com/v1/customers/all/domains/example.com/ex/distributionLists/ExampleDL/options/AvailableSendersRecipients

Response:
200 OK
{
"Recipients": [
{
"Value": "mexuser3"
},
{
"Value": "mexuser4"
}
],
"Limit": 25,
"Total": 2,
"Order": "asc"
}
</pre>

==== Available Members Recipients ====

{| class="wikitable"
! Verb
| GET
|-
! URL Format
| /v1/customers/{customer account number}/domains/{domain name}/ex/distributionLists/{common name}/options/AvailableMembersRecipients
|-
! Description
| Use this route to retrieve a list of recipients that can be Members for a specific Distribution List on the given domain.
|-
! Model
| [[#Members|Members]] Listing
|}

<pre>
Request:
GET https://api.emailsrvr.com/v1/customers/all/domains/example.com/ex/distributionLists/ExampleDL/options/AvailableMembersRecipients

Response:
200 OK
{
"Recipients": [
{
"Value": "mexuser3"
},
{
"Value": "mexuser4"
}
],
"Limit": 25,
"Total": 2,
"Order": "asc"
}
</pre>

UsersDomain

2015-04-15T19:22:07Z

James.morgan: Updated UsersDomain - removed deprecated functions

[[ModifyDomainMaxMailboxSize()]] 
[[ModifyDomainMaxNumUsers()]] 
[[GetDomainNumUsers()]] 
[[GetDomainUsers()]] 
[[GetDomainUsersStringAlpha()]] 
[[GetDomainAllUserLastLogin()]] 
[[GetDomainAllUserCurrentSize()]] 
[[GetDomainAllUserStats()]] 
[[GetDomainAllUserStatsActive()]] 
[[GetDomainAllUserStatsActiveString()]] 
[[GetDomainAllUsersForward()]] 
[[ModifyUsersBulk()]] 
[[DeleteUsersBulk()]] 
[[GetMailAllotStorage()]] 
[[GetDomainUsersMailboxMaxSize()]] 
[[SetDomainUsersMailboxMaxSize()]] 
[[AddMailAllotStorage()]]

AliasDomain

2015-04-15T19:14:37Z

James.morgan:

[[ModifyDomainAliases()]] 
[[SetNobodyAlias()]] 
[[RemoveNobodyAlias()]] 
[[GetUserAliasesBulk()]] 
[[AddUserAliasesBulk()]]

BusinessDomain

2015-04-15T19:11:26Z

James.morgan: Updated BusinessDomain - removed deprecated functions

__TOC__
[[ping()]] 
===Find out about a domain===
[[GetDomainStats()]] 
[[GetDomainUsers()]] 
[[GetDomainUsersString()]] 
[[GetDomainUsersSpamStatusString()]] 
[[GetDomainUsersSafeListStatusString()]] 
[[CheckUserExists()]] 
[[CheckAliasExists()]] 
[[CheckUserAvailable()]] 
[[GetDomainAllUserLastLogin()]] 
[[GetDomainAllUserStats()]] 
[[GetDomainAllUserStatsActive()]] 
[[GetDomainAllUsersForward()]] 

===General domain settings===
[[SetNobodyAlias()]] 
[[RemoveNobodyAlias()]] 
[[SetDomainNotify()]] 

===Bulk operations===
[[DeleteUsersBulk()]] 
[[SetUsersActiveBulk()]] 
[[GetUserAliasesBulk()]] 
[[AddUserAliasesBulk()]] 
===Mailbox size===
[[GetMailAllotStorage()]] 
[[GetDomainUsersMailboxMaxSize()]] 
[[SetDomainUsersMailboxMaxSize()]] 
[[GetDomainAllUserCurrentSize()]] 

===Spam functions===
[[AddDomainSpam()]] 
[[GetDomainSpam()]] 
[[SetDomainSpamCleaner()]] 
[[SetDomainSpamSafeList()]] 
[[GetDomainSpamSafeList()]] 
[[GetDomainSpamBlackList()]]

BusinessUser

2015-04-15T19:04:57Z

James.morgan: Updated BusinessUser - removed deprecated functions

__TOC__
[[ping()]] to test connection to the SOAP server 
===Find out about users===
[[GetDomainUsers()]] 
===Adding users and aliases===
[[CheckUserExists()]] 
[[CheckAliasExists()]] 
[[CheckUserAvailable()]] 
[[GetAlias()]] 
[[GetUserAliasesString()]] 
[[AddUser()]] 
[[AddUserWithLdapAttributes()]] 
[[AddAlias()]] 
[[DeleteUser()]] 
[[DeleteAlias()]] 
[[ModifyUser()]] 
[[ModifyUserWithLdapAttributes()]] 
[[ModifyAlias()]] 
===Forwarding and vacation===
[[GetUserMailForward()]] 
[[SetUserMailForward()]] 
[[RemoveUserMailForward()]] 
[[GetUserMailVacation()]] 
[[SetUserMailVacation()]] 
===Mailbox size===
[[SetUserMailboxMaxSize()]] 
[[GetUserMailboxMaxSize()]] 
[[GetMailAllotStorage()]] 
===User status info===
[[GetUserLastLogin()]] 
[[GetUserActiveStatus()]] 
===Spam functions===
[[AddUserSpam()]] 
[[DeleteUserSpam()]] 
[[GetUserSpam()]] 
[[SetUserSpamCleaner()]] 
[[GetUserSpamCleaner()]] 
[[SetUserSpamSafeList()]] 
[[GetUserSpamSafeList()]] 
[[SetUserSpamBlackList()]] 
[[GetUserSpamBlackList()]]

BusinessAll

2015-04-15T18:49:59Z

James.morgan:

[[AddAlias()]] 
[[AddDomainSpam()]] 
[[AddDomainSpamSafeList()]] 
[[AddUser()]] 
[[AddUserAliasesBulk()]] 
[[AddUserSpam()]] 
[[AddUserSpamSafeList()]] 
[[AddUserWithLdapAttributes()]] 
[[CheckAliasExists()]] 
[[CheckUserAvailable()]] 
[[CheckUserExists()]] 
[[DeleteAlias()]] 
[[DeleteUser()]] 
[[DeleteUserSpam()]] 
[[DeleteUsersBulk()]] 
[[GetAlias()]] 
[[GetDomainAllUserCurrentSize()]] 
[[GetDomainAllUserLastLogin()]] 
[[GetDomainAllUserStats()]] 
[[GetDomainAllUserStatsActive()]] 
[[GetDomainAllUsersForward()]] 
[[GetDomainSpam()]] 
[[GetDomainSpamBlackList()]] 
[[GetDomainSpamSafeList()]] 
[[GetDomainStats()]] 
[[GetDomainUsers()]] 
[[GetDomainUsersMailboxMaxSize()]] 
[[GetMailAllotStorage()]] 
[[GetUserActiveStatus()]] 
[[GetUserAliasesBulk()]] 
[[GetUserAliasesString()]] 
[[GetUserAttributes()]] 
[[GetUserLastLogin()]] 
[[GetUserMailForward()]] 
[[GetUserMailVacation()]] 
[[GetUserMailboxMaxSize()]] 
[[GetUserSpam()]] 
[[GetUserSpamBlackList()]] 
[[GetUserSpamCleaner()]] 
[[GetUserSpamSafeList()]] 
[[GetUsersWithFilterStr()]] 
[[ModifyAlias()]] 
[[ModifyUser()]] 
[[ModifyUserWithLdapAttributes()]] 
[[RemoveNobodyAlias()]] 
[[RemoveUserMailForward()]] 
[[SetDomainNotify()]] 
[[SetDomainSpamCleaner()]] 
[[SetDomainSpamSafeList()]] 
[[SetDomainUsersMailboxMaxSize()]] 
[[SetNobodyAlias()]] 
[[SetUserMailForward()]] 
[[SetUserMailVacation()]] 
[[SetUserMailboxMaxSize()]] 
[[SetUserSpamBlackList()]] 
[[SetUserSpamCleaner()]] 
[[SetUserSpamSafeList()]] 
[[SetUsersActiveBulk()]] 
[[ping()]] 

== Deprecated ==

[[AddDomainSpamBlackList()|AddDomainSpamBlackList]] 
[[AddDomainSpamIPBlackList()|AddDomainSpamIPBlackList]] 
[[AddDomainSpamIPSafeList()|AddDomainSpamIPSafeList]] 
[[AddDomainVirus()|AddDomainVirus]] 
[[AddUsersBulk()|AddUsersBulk]] 
[[AddUserSpamBlackList()|AddUserSpamBlackList]] 
[[AddUserSpamIPBlackList()|AddUserSpamIPBlackList]] 
[[AddUserSpamIPSafeList()|AddUserSpamIPSafeList]] 
[[AddUserVirus()|AddUserVirus]] 
[[AddUserVirusBulk()|AddUserVirusBulk]] 
[[AddUserWithLdapAttributesString()|AddUserWithLdapAttributesString]] 
[[CleanAliasesByUser()|CleanAliasesByUser]] 
[[DeleteDomainSpam()|DeleteDomainSpam]] 
[[DeleteDomainVirus()|DeleteDomainVirus]] 
[[DeleteUserAliasesBulk()|DeleteUserAliasesBulk]] 
[[DeleteUserVirus()|DeleteUserVirus]] 
[[DeleteUserVirusBulk()|DeleteUserVirusBulk]] 
[[DisableSubaccount()|DisableSubaccount]] 
[[EnableSubaccount()|EnableSubaccount]] 
[[GetAllDomainsMXRecords()|GetAllDomainsMXRecords]] 
[[GetAllDomainsSettings()|GetAllDomainsSettings]] 
[[GetAllDomainsStats()|GetAllDomainsStats]] 
[[GetAllDomainsUserCount()|GetAllDomainsUserCount]] 
[[GetAllocatedStorage()|GetAllocatedStorage]] 
[[GetDomainAdministrators()|GetDomainAdministrators]] 
[[GetDomainAllUserCurrentSizeActive()|GetDomainAllUserCurrentSizeActive]] 
[[GetDomainAllUserCurrentSizeAlpha()|GetDomainAllUserCurrentSizeAlpha]] 
[[GetDomainAllUserLastLoginActive()|GetDomainAllUserLastLoginActive]] 
[[GetDomainAllUserLastLoginAlpha()|GetDomainAllUserLastLoginAlpha]] 
[[GetDomainAllUserStatsAlpha()|GetDomainAllUserStatsAlpha]] 
[[GetDomainMXRecords()|GetDomainMXRecords]] 
[[GetDomainNotify()|GetDomainNotify]] 
[[GetDomainNumBcc()|GetDomainNumBcc]] 
[[GetDomainNumSync()|GetDomainNumSync]] 
[[GetDomainNumUserAliases()|GetDomainNumUserAliases]] 
[[GetDomainNumUsersActive()|GetDomainNumUsersActive]] 
[[GetDomainSpamCleaner()|GetDomainSpamCleaner]] 
[[GetDomainSpamGreylist()|GetDomainSpamGreylist]] 
[[GetDomainUsersBlackListStatusString()|GetDomainUsersBlackListStatusString]] 
[[GetDomainUsersSafeListStatusString()|GetDomainUsersSafeListStatusString]] 
[[GetDomainUsersSpamStatusString()|GetDomainUsersSpamStatusString]] 
[[GetDomainUsersString()|GetDomainUsersString]] 
[[GetDomainVirus()|GetDomainVirus]] 
[[GetGroupAliasesString()|GetGroupAliasesString]] 
[[GetListUsers()|GetListUsers]] 
[[GetMailTotalStorage()|GetMailTotalStorage]] 
[[GetSubaccountStatus()|GetSubaccountStatus]] 
[[GetSubaccountsWithStatus()|GetSubaccountsWithStatus]] 
[[GetUserAliasesStringAlpha()|GetUserAliasesStringAlpha]] 
[[GetUserSpamGreylist()|GetUserSpamGreylist]] 
[[GetUserVirus()|GetUserVirus]] 
[[GetUserVirusBulk()|GetUserVirusBulk]] 
[[ModifyDomainAdministrator()|ModifyDomainAdministrator]] 
[[ModifyGroupAlias()|ModifyGroupAlias]] 
[[ModifyUsersBulk()|ModifyUsersBulk]] 
[[ModifyUserWithLdapAttributesString()|ModifyUserWithLdapAttributesString]] 
[[RemoveDomainSpamBlackList()|RemoveDomainSpamBlackList]] 
[[RemoveDomainSpamIPBlackList()|RemoveDomainSpamIPBlackList]] 
[[RemoveDomainSpamIPSafeList()|RemoveDomainSpamIPSafeList]] 
[[RemoveDomainSpamSafeList()|RemoveDomainSpamSafeList]] 
[[RemoveUserSpamBlackList()|RemoveUserSpamBlackList]] 
[[RemoveUserSpamIPBlackList()|RemoveUserSpamIPBlackList]] 
[[RemoveUserSpamIPSafeList()|RemoveUserSpamIPSafeList]] 
[[RemoveUserSpamSafeList()|RemoveUserSpamSafeList]] 
[[RetCode()|RetCode]] 
[[SendMailDomainUsersAll()|SendMailDomainUsersAll]] 
[[SetAliasSingleAddress()|SetAliasSingleAddress]] 
[[SetDomainSpamBlackList()|SetDomainSpamBlackList]] 
[[SetDomainSpamGreylist()|SetDomainSpamGreylist]] 
[[SetDomainSpamIPBlackList()|SetDomainSpamIPBlackList]] 
[[SetDomainSpamIPSafeList()|SetDomainSpamIPSafeList]] 
[[SetListUsers()|SetListUsers]] 
[[SetUserSpamGreylist()|SetUserSpamGreylist]] 
[[Subaccount_GetAccountSetting()|Subaccount_GetAccountSetting]] 
[[Subaccount_GetAccountSettings()|Subaccount_GetAccountSettings]] 
[[Subaccount_GetAdminType()|Subaccount_GetAdminType]] 
[[Subaccount_GetAllocatedStorage()|Subaccount_GetAllocatedStorage]] 
[[Subaccount_GetLimitedAdminPermissions()|Subaccount_GetLimitedAdminPermissions]] 
[[Subaccount_GetMailTotalStorage()|Subaccount_GetMailTotalStorage]] 
[[Subaccount_GetNumBcc()|Subaccount_GetNumBcc]] 
[[Subaccount_GetNumDomains()|Subaccount_GetNumDomains]] 
[[Subaccount_GetNumMailboxes()|Subaccount_GetNumMailboxes]] 
[[Subaccount_GetNumSync()|Subaccount_GetNumSync]] 
[[Subaccount_ModifyAccountSetting()|Subaccount_ModifyAccountSetting]] 
[[Subaccount_ModifyDomain()|Subaccount_ModifyDomain]] 
[[UndeleteUser()|UndeleteUser]]

Domain administration

2015-04-15T18:47:19Z

James.morgan: Updated domain administration section

[[AddDomain()]] 
[[DeleteDomain()]] 
[[ModifyDomain()]] 
[[ModifyDomainAliases()]] 
[[ModifyDomainMaxMailboxSize()]] 
[[ModifyDomainMaxNumUsers()]] 
[[GetDomainSettings()]] 
[[GetDomainStats()]] 
[[GetDomainNumUsers()]] 
[[GetAllDomains()]] 
[[SetNobodyAlias()]] 
[[RemoveNobodyAlias()]] 
[[GetDomainAllUserLastLogin()]] 
[[GetDomainAllUserCurrentSize()]] 
[[GetDomainAllUserStats()]] 
[[GetDomainAllUserStatsActive()]] 
[[GetDomainAllUserStatsActiveString()]] 
[[GetDomainAllUsersForward()]] 
[[SetDomainNotify()]] 
[[GetMailAllotStorage()]] 
[[GetDomainUsersMailboxMaxSize()]] 
[[SetDomainUsersMailboxMaxSize()]] 
[[AddMailAllotStorage()]] 
[[SearchDomains()]] 
[[Subaccount_GetDomains()]] 
[[Subaccount_GetAdmins()]] 
[[Subaccount_AddAdmin()]] 
[[Subaccount_ChangeAdminPassword()]] 
[[Subaccount_ChangeAdminType()]] 
[[Subaccount_DeleteAdmin()]] 
[[Subaccount_AddDomain()]] 
[[Subaccount_MoveDomain()]] 
[[Subaccount_DeleteDomain()]]

Domain spam

2015-04-15T18:46:21Z

James.morgan: Updated domain spam section

There are three aspects to spam management: the spam identification threshold, what action to take with messages that meet that threshold, and which domains and email addresses should be exempt (safelisted) from the spam action process. Further, if the chosen action is to deliver the message to the spam folder, configuration should be done to make sure that messages there are deleted after a certain age or after a certain number of messages are stored there.

If a mailbox user has customized spam threshold and action settings, their settings will supercede those of the domain.

If a mailbox user has a customized safelist, the domain safelist + the user safelist will be applied to determine the action to take with email messages to that mailbox user.

==Functions==

[[AddDomainSpam()]] The should probably be renamed to ModifyDomainSpam, set threshold and action here 
[[GetDomainSpam()]] To see the threshold and action 
[[SetDomainSpamCleaner()]] Set spam folder auto-cleanup here 
[[SetDomainSpamSafeList()]] 
[[GetDomainSpamSafeList()]] 
[[GetDomainSpamBlackList()]]

Companies

2015-04-15T18:45:12Z

James.morgan: Updated Reseller API company sublist

Resellers of Rackspace Email hosting services can add sub-accounts to their main reseller account. Each sub-account usually represents a company that purchases email hosting from the reseller. Sub-accounts may only be one level deep with respect to the reseller (no sub-accounts of sub-accounts).

== Function List ==
[[GetSubaccounts()]] 
[[SearchSubaccounts()]] 
[[SearchDomains()]] 
[[AddSubaccount()]] 
[[DeleteSubaccount()]] 
[[ModifySubaccount()]] 
[[Subaccount_GetDomains()]] 
[[Subaccount_GetAdmins()]] 
[[Subaccount_AddAdmin()]] 
[[Subaccount_ChangeAdminPassword()]] 
[[Subaccount_ChangeAdminType()]] 
[[Subaccount_DeleteAdmin()]] 
[[Subaccount_AddDomain()]] 
[[Subaccount_MoveDomain()]]

Deprecation

2015-04-15T18:43:42Z

James.morgan: Added list of deprecated functions

* [[AddDomainSpamBlackList()|AddDomainSpamBlackList]]
* [[AddDomainSpamIPBlackList()|AddDomainSpamIPBlackList]]
* [[AddDomainSpamIPSafeList()|AddDomainSpamIPSafeList]]
* [[AddDomainVirus()|AddDomainVirus]]
* [[AddUsersBulk()|AddUsersBulk]]
* [[AddUserSpamBlackList()|AddUserSpamBlackList]]
* [[AddUserSpamIPBlackList()|AddUserSpamIPBlackList]]
* [[AddUserSpamIPSafeList()|AddUserSpamIPSafeList]]
* [[AddUserVirus()|AddUserVirus]]
* [[AddUserVirusBulk()|AddUserVirusBulk]]
* [[AddUserWithLdapAttributesString()|AddUserWithLdapAttributesString]]
* [[CleanAliasesByUser()|CleanAliasesByUser]]
* [[DeleteDomainSpam()|DeleteDomainSpam]]
* [[DeleteDomainVirus()|DeleteDomainVirus]]
* [[DeleteUserAliasesBulk()|DeleteUserAliasesBulk]]
* [[DeleteUserVirus()|DeleteUserVirus]]
* [[DeleteUserVirusBulk()|DeleteUserVirusBulk]]
* [[DisableSubaccount()|DisableSubaccount]]
* [[EnableSubaccount()|EnableSubaccount]]
* [[GetAllDomainsMXRecords()|GetAllDomainsMXRecords]]
* [[GetAllDomainsSettings()|GetAllDomainsSettings]]
* [[GetAllDomainsStats()|GetAllDomainsStats]]
* [[GetAllDomainsUserCount()|GetAllDomainsUserCount]]
* [[GetAllocatedStorage()|GetAllocatedStorage]]
* [[GetDomainAdministrators()|GetDomainAdministrators]]
* [[GetDomainAllUserCurrentSizeActive()|GetDomainAllUserCurrentSizeActive]]
* [[GetDomainAllUserCurrentSizeAlpha()|GetDomainAllUserCurrentSizeAlpha]]
* [[GetDomainAllUserLastLoginActive()|GetDomainAllUserLastLoginActive]]
* [[GetDomainAllUserLastLoginAlpha()|GetDomainAllUserLastLoginAlpha]]
* [[GetDomainAllUserStatsAlpha()|GetDomainAllUserStatsAlpha]]
* [[GetDomainMXRecords()|GetDomainMXRecords]]
* [[GetDomainNotify()|GetDomainNotify]]
* [[GetDomainNumBcc()|GetDomainNumBcc]]
* [[GetDomainNumSync()|GetDomainNumSync]]
* [[GetDomainNumUserAliases()|GetDomainNumUserAliases]]
* [[GetDomainNumUsersActive()|GetDomainNumUsersActive]]
* [[GetDomainSpamCleaner()|GetDomainSpamCleaner]]
* [[GetDomainSpamGreylist()|GetDomainSpamGreylist]]
* [[GetDomainUsersBlackListStatusString()|GetDomainUsersBlackListStatusString]]
* [[GetDomainUsersSafeListStatusString()|GetDomainUsersSafeListStatusString]]
* [[GetDomainUsersSpamStatusString()|GetDomainUsersSpamStatusString]]
* [[GetDomainUsersString()|GetDomainUsersString]]
* [[GetDomainVirus()|GetDomainVirus]]
* [[GetGroupAliasesString()|GetGroupAliasesString]]
* [[GetListUsers()|GetListUsers]]
* [[GetMailTotalStorage()|GetMailTotalStorage]]
* [[GetSubaccountStatus()|GetSubaccountStatus]]
* [[GetSubaccountsWithStatus()|GetSubaccountsWithStatus]]
* [[GetUserAliasesStringAlpha()|GetUserAliasesStringAlpha]]
* [[GetUserSpamGreylist()|GetUserSpamGreylist]]
* [[GetUserVirus()|GetUserVirus]]
* [[GetUserVirusBulk()|GetUserVirusBulk]]
* [[ModifyDomainAdministrator()|ModifyDomainAdministrator]]
* [[ModifyGroupAlias()|ModifyGroupAlias]]
* [[ModifyUsersBulk()|ModifyUsersBulk]]
* [[ModifyUserWithLdapAttributesString()|ModifyUserWithLdapAttributesString]]
* [[RemoveDomainSpamBlackList()|RemoveDomainSpamBlackList]]
* [[RemoveDomainSpamIPBlackList()|RemoveDomainSpamIPBlackList]]
* [[RemoveDomainSpamIPSafeList()|RemoveDomainSpamIPSafeList]]
* [[RemoveDomainSpamSafeList()|RemoveDomainSpamSafeList]]
* [[RemoveUserSpamBlackList()|RemoveUserSpamBlackList]]
* [[RemoveUserSpamIPBlackList()|RemoveUserSpamIPBlackList]]
* [[RemoveUserSpamIPSafeList()|RemoveUserSpamIPSafeList]]
* [[RemoveUserSpamSafeList()|RemoveUserSpamSafeList]]
* [[RetCode()|RetCode]]
* [[SendMailDomainUsersAll()|SendMailDomainUsersAll]]
* [[SetAliasSingleAddress()|SetAliasSingleAddress]]
* [[SetDomainSpamBlackList()|SetDomainSpamBlackList]]
* [[SetDomainSpamGreylist()|SetDomainSpamGreylist]]
* [[SetDomainSpamIPBlackList()|SetDomainSpamIPBlackList]]
* [[SetDomainSpamIPSafeList()|SetDomainSpamIPSafeList]]
* [[SetListUsers()|SetListUsers]]
* [[SetUserSpamGreylist()|SetUserSpamGreylist]]
* [[Subaccount_GetAccountSetting()|Subaccount_GetAccountSetting]]
* [[Subaccount_GetAccountSettings()|Subaccount_GetAccountSettings]]
* [[Subaccount_GetAdminType()|Subaccount_GetAdminType]]
* [[Subaccount_GetAllocatedStorage()|Subaccount_GetAllocatedStorage]]
* [[Subaccount_GetLimitedAdminPermissions()|Subaccount_GetLimitedAdminPermissions]]
* [[Subaccount_GetMailTotalStorage()|Subaccount_GetMailTotalStorage]]
* [[Subaccount_GetNumBcc()|Subaccount_GetNumBcc]]
* [[Subaccount_GetNumDomains()|Subaccount_GetNumDomains]]
* [[Subaccount_GetNumMailboxes()|Subaccount_GetNumMailboxes]]
* [[Subaccount_GetNumSync()|Subaccount_GetNumSync]]
* [[Subaccount_ModifyAccountSetting()|Subaccount_ModifyAccountSetting]]
* [[Subaccount_ModifyDomain()|Subaccount_ModifyDomain]]
* [[UndeleteUser()|UndeleteUser]]

Soap API (Deprecated)

2015-04-15T18:43:20Z

James.morgan: Added deprecation link

== The Rackspace Email Soap API Deprecation ==

=== Why are you doing this? ===
In order to maximize our ability to deliver great functionality quickly, we have to make the tough call to deprecate old stuff that slows us down. We feel that REST is a better approach to web services: It is more scaleable, more securable, more evolvable, and generally simpler to consume, maintain, and support.

=== What does this mean for me? ===

* For customers new to our APIs
For the best support, you should integrate with our [[Main_Page|REST API]]. If there is functionality you need that is not available in the REST API, please tell us. We thrive on your feedback!

* For customers who consume our SOAP API
Deprecation of the SOAP API is not imminent but we highly encourage you to consider revisiting your current applications and update them to use the newer REST API. Once a SOAP API deprecation date has been set there will be 6 month notice prior to its End-Of-Life.

We will not be porting over every function from our SOAP API to our REST API. So the only way to ensure you'll have everything you need when the SOAP API is officially deprecated is to start early, and let us know what is missing.

=== What is currently missing from the REST API, that you plan to add? ===
* Search for a Domain
* Get default max mailbox size for domain
* Get/Set max size for mailbox
* Get mailbox last login date/time
* Get addresses configured to receive forwarded email
* Search mailboxes

If you rely on functionality that is not currently in the [[Main_Page|REST API]], or in this list, please tell us.

== The Rackspace Email Soap API (Deprecated) ==

The Rackspace Email [http://en.wikipedia.org/wiki/Api API] comprises a robust set of web services designed to allow businesses to fully integrate administrative email functions into their own applications. Based on [http://en.wikipedia.org/wiki/SOAP SOAP], functions in the API allow programs written in many different languages to perform operations such as [[AddUser()|adding mailboxes]] and changing settings. The API can also be used to provide [[LoginUserWebmail()|single sign on]] functionality in concert with other web applications. The Webmail API runs on the same robust server platform that supports our high-availability [http://www.rackspace.com/email_hosting webmail] and email services.

* [[webmail|Webmail User API]] - provides a short list of webmail user functions

* [[business|Business API]] - provides a list of functions designed for single business/domain usage

* [[reseller|Reseller API]] - provides a complete list of functions for multiple domains and sub-accounts

=== Code Examples ===

{|
|
*[[Perl]]
|
*[[PHP]]
|-
|
*[[ASP]]
|
*[[C#]]
|-
|
*[[ColdFusion]]
|
*[[Ruby]]
|-
|
* [[HTML]] (not part of the API, strictly speaking)
|}

=== Getting Started Screencast ===
[http://www.mailtrust.com/api-wiki/screencasts/api-pings.htm Screencast] of accessing two of our SOAP API's from PHP using Ubuntu linux.

=== Result Codes ===
Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

=== Deprecation ===

Functions returning error code -777 indicates that it has been deprecated.
* [[Deprecation|View list of deprecated functions]]

AllReseller

2015-04-15T18:42:29Z

James.morgan:

[[AddAlias()]] 
[[AddDomain()]] 
[[AddDomainSpam()]] 
[[AddDomainSpamSafeList()]] 
[[AddMailAllotStorage()]] 
[[AddSubaccount()]] 
[[AddUser()]] 
[[AddUserAliasesBulk()]] 
[[AddUserSpam()]] 
[[AddUserSpamSafeList()]] 
[[AddUserWithLdapAttributes()]] 
[[CheckAliasExists()]] 
[[CheckUserAvailable()]] 
[[CheckUserExists()]] 
[[DeleteAlias()]] 
[[DeleteDomain()]] 
[[DeleteSubaccount()]] 
[[DeleteUser()]] 
[[DeleteUserSpam()]] 
[[DeleteUsersBulk()]] 
[[GetAlias()]] 
[[GetAllDomains()]] 
[[GetCurrentUserMailboxSize()]] 
[[GetDomainAllUserCurrentSize()]] 
[[GetDomainAllUserLastLogin()]] 
[[GetDomainAllUserStats()]] 
[[GetDomainAllUserStatsActive()]] 
[[GetDomainAllUserStatsActiveString()]] 
[[GetDomainAllUsersForward()]] 
[[GetDomainNumUsers()]] 
[[GetDomainSettings()]] 
[[GetDomainSpam()]] 
[[GetDomainSpamBlackList()]] 
[[GetDomainSpamSafeList()]] 
[[GetDomainStats()]] 
[[GetDomainUsers()]] 
[[GetDomainUsersMailboxMaxSize()]] 
[[GetDomainUsersStringAlpha()]] 
[[GetMailAllotStorage()]] 
[[GetRetCodeDesc()]] 
[[GetSubaccounts()]] 
[[GetUserActiveStatus()]] 
[[GetUserAliasesBulk()]] 
[[GetUserAliasesString()]] 
[[GetUserAttributes()]] 
[[GetUserLastLogin()]] 
[[GetUserMailForward()]] 
[[GetUserMailVacation()]] 
[[GetUserMailboxMaxSize()]] 
[[GetUserNumMessages()]] 
[[GetUserSpam()]] 
[[GetUserSpamBlackList()]] 
[[GetUserSpamCleaner()]] 
[[GetUserSpamSafeList()]] 
[[GetUserStatus()]] 
[[GetUsersWithFilterStr()]] 
[[LoginUserWebmail()]] 
[[ModifyAlias()]] 
[[ModifyDomain()]] 
[[ModifyDomainAliases()]] 
[[ModifyDomainMaxMailboxSize()]] 
[[ModifyDomainMaxNumUsers()]] 
[[ModifySubaccount()]] 
[[ModifyUser()]] 
[[ModifyUserWithLdapAttributes()]] 
[[RemoveNobodyAlias()]] 
[[RemoveUserMailForward()]] 
[[SearchDomains()]] 
[[SearchSubaccounts()]] 
[[SetDomainNotify()]] 
[[SetDomainSpamCleaner()]] 
[[SetDomainSpamSafeList()]] 
[[SetDomainUsersMailboxMaxSize()]] 
[[SetNobodyAlias()]] 
[[SetUserMailForward()]] 
[[SetUserMailVacation()]] 
[[SetUserMailboxMaxSize()]] 
[[SetUserSpamBlackList()]] 
[[SetUserSpamCleaner()]] 
[[SetUserSpamSafeList()]] 
[[SetUsersActiveBulk()]] 
[[Subaccount_AddAdmin()]] 
[[Subaccount_AddDomain()]] 
[[Subaccount_ChangeAdminPassword()]] 
[[Subaccount_ChangeAdminType()]] 
[[Subaccount_DeleteAdmin()]] 
[[Subaccount_DeleteDomain()]] 
[[Subaccount_GetAdmins()]] 
[[Subaccount_GetDomains()]] 
[[Subaccount_MoveDomain()]] 
[[Subaccount_SetLimitedAdminPermissions()]] 
[[ping()]] 

== Deprecated ==

[[AddDomainSpamBlackList()|AddDomainSpamBlackList]] 
[[AddDomainSpamIPBlackList()|AddDomainSpamIPBlackList]] 
[[AddDomainSpamIPSafeList()|AddDomainSpamIPSafeList]] 
[[AddDomainVirus()|AddDomainVirus]] 
[[AddUsersBulk()|AddUsersBulk]] 
[[AddUserSpamBlackList()|AddUserSpamBlackList]] 
[[AddUserSpamIPBlackList()|AddUserSpamIPBlackList]] 
[[AddUserSpamIPSafeList()|AddUserSpamIPSafeList]] 
[[AddUserVirus()|AddUserVirus]] 
[[AddUserVirusBulk()|AddUserVirusBulk]] 
[[AddUserWithLdapAttributesString()|AddUserWithLdapAttributesString]] 
[[CleanAliasesByUser()|CleanAliasesByUser]] 
[[DeleteDomainSpam()|DeleteDomainSpam]] 
[[DeleteDomainVirus()|DeleteDomainVirus]] 
[[DeleteUserAliasesBulk()|DeleteUserAliasesBulk]] 
[[DeleteUserVirus()|DeleteUserVirus]] 
[[DeleteUserVirusBulk()|DeleteUserVirusBulk]] 
[[DisableSubaccount()|DisableSubaccount]] 
[[EnableSubaccount()|EnableSubaccount]] 
[[GetAllDomainsMXRecords()|GetAllDomainsMXRecords]] 
[[GetAllDomainsSettings()|GetAllDomainsSettings]] 
[[GetAllDomainsStats()|GetAllDomainsStats]] 
[[GetAllDomainsUserCount()|GetAllDomainsUserCount]] 
[[GetAllocatedStorage()|GetAllocatedStorage]] 
[[GetDomainAdministrators()|GetDomainAdministrators]] 
[[GetDomainAllUserCurrentSizeActive()|GetDomainAllUserCurrentSizeActive]] 
[[GetDomainAllUserCurrentSizeAlpha()|GetDomainAllUserCurrentSizeAlpha]] 
[[GetDomainAllUserLastLoginActive()|GetDomainAllUserLastLoginActive]] 
[[GetDomainAllUserLastLoginAlpha()|GetDomainAllUserLastLoginAlpha]] 
[[GetDomainAllUserStatsAlpha()|GetDomainAllUserStatsAlpha]] 
[[GetDomainMXRecords()|GetDomainMXRecords]] 
[[GetDomainNotify()|GetDomainNotify]] 
[[GetDomainNumBcc()|GetDomainNumBcc]] 
[[GetDomainNumSync()|GetDomainNumSync]] 
[[GetDomainNumUserAliases()|GetDomainNumUserAliases]] 
[[GetDomainNumUsersActive()|GetDomainNumUsersActive]] 
[[GetDomainSpamCleaner()|GetDomainSpamCleaner]] 
[[GetDomainSpamGreylist()|GetDomainSpamGreylist]] 
[[GetDomainUsersBlackListStatusString()|GetDomainUsersBlackListStatusString]] 
[[GetDomainUsersSafeListStatusString()|GetDomainUsersSafeListStatusString]] 
[[GetDomainUsersSpamStatusString()|GetDomainUsersSpamStatusString]] 
[[GetDomainUsersString()|GetDomainUsersString]] 
[[GetDomainVirus()|GetDomainVirus]] 
[[GetGroupAliasesString()|GetGroupAliasesString]] 
[[GetListUsers()|GetListUsers]] 
[[GetMailTotalStorage()|GetMailTotalStorage]] 
[[GetSubaccountStatus()|GetSubaccountStatus]] 
[[GetSubaccountsWithStatus()|GetSubaccountsWithStatus]] 
[[GetUserAliasesStringAlpha()|GetUserAliasesStringAlpha]] 
[[GetUserSpamGreylist()|GetUserSpamGreylist]] 
[[GetUserVirus()|GetUserVirus]] 
[[GetUserVirusBulk()|GetUserVirusBulk]] 
[[ModifyDomainAdministrator()|ModifyDomainAdministrator]] 
[[ModifyGroupAlias()|ModifyGroupAlias]] 
[[ModifyUsersBulk()|ModifyUsersBulk]] 
[[ModifyUserWithLdapAttributesString()|ModifyUserWithLdapAttributesString]] 
[[RemoveDomainSpamBlackList()|RemoveDomainSpamBlackList]] 
[[RemoveDomainSpamIPBlackList()|RemoveDomainSpamIPBlackList]] 
[[RemoveDomainSpamIPSafeList()|RemoveDomainSpamIPSafeList]] 
[[RemoveDomainSpamSafeList()|RemoveDomainSpamSafeList]] 
[[RemoveUserSpamBlackList()|RemoveUserSpamBlackList]] 
[[RemoveUserSpamIPBlackList()|RemoveUserSpamIPBlackList]] 
[[RemoveUserSpamIPSafeList()|RemoveUserSpamIPSafeList]] 
[[RemoveUserSpamSafeList()|RemoveUserSpamSafeList]] 
[[RetCode()|RetCode]] 
[[SendMailDomainUsersAll()|SendMailDomainUsersAll]] 
[[SetAliasSingleAddress()|SetAliasSingleAddress]] 
[[SetDomainSpamBlackList()|SetDomainSpamBlackList]] 
[[SetDomainSpamGreylist()|SetDomainSpamGreylist]] 
[[SetDomainSpamIPBlackList()|SetDomainSpamIPBlackList]] 
[[SetDomainSpamIPSafeList()|SetDomainSpamIPSafeList]] 
[[SetListUsers()|SetListUsers]] 
[[SetUserSpamGreylist()|SetUserSpamGreylist]] 
[[Subaccount_GetAccountSetting()|Subaccount_GetAccountSetting]] 
[[Subaccount_GetAccountSettings()|Subaccount_GetAccountSettings]] 
[[Subaccount_GetAdminType()|Subaccount_GetAdminType]] 
[[Subaccount_GetAllocatedStorage()|Subaccount_GetAllocatedStorage]] 
[[Subaccount_GetLimitedAdminPermissions()|Subaccount_GetLimitedAdminPermissions]] 
[[Subaccount_GetMailTotalStorage()|Subaccount_GetMailTotalStorage]] 
[[Subaccount_GetNumBcc()|Subaccount_GetNumBcc]] 
[[Subaccount_GetNumDomains()|Subaccount_GetNumDomains]] 
[[Subaccount_GetNumMailboxes()|Subaccount_GetNumMailboxes]] 
[[Subaccount_GetNumSync()|Subaccount_GetNumSync]] 
[[Subaccount_ModifyAccountSetting()|Subaccount_ModifyAccountSetting]] 
[[Subaccount_ModifyDomain()|Subaccount_ModifyDomain]] 
[[UndeleteUser()|UndeleteUser]]

AddDomainSpamBlackList()

2015-04-15T18:38:56Z

James.morgan:

This function has been deprecated.

This function will add one or more entries to the existing blacklistlist for a given domain. Blacklist entries can be either domain names ("example.com") or email addresses ("info@example.com").

===Parameters===

Four strings:
Administrative username,
Administrative password,
Domain name,
Black list (formatted as "[entry]crlf[entry]crlf...")

===Return Values===
If successful, the return value of the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

AddDomainSpamIPBlackList()

2015-04-15T18:38:51Z

James.morgan:

This function has been deprecated.

This function will add one or more entries to the existing IP address blacklist for a given domain. Blacklist entries can be specific hosts (like "10.167.10.21") or simple ranges through the use of the % wildcard (like "10.167.10.%").

===Parameters===

Four strings:
Administrative username,
Administrative password,
Domain name,
IP black list (formatted as "[entry]crlf[entry]crlf...")

===Return Values===
If successful, the return value of the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

AddDomainSpamIPSafeList()

2015-04-15T18:38:45Z

James.morgan:

This function has been deprecated.

This function will add one or more entries to the existing IP address safelist for a given domain. Safelist entries can be specific hosts (like "10.167.10.21") or simple ranges through the use of the % wildcard (like "10.167.10.%").

===Parameters===

Four strings:
Administrative username,
Administrative password,
Domain name,
IP safe list (formatted as "[entry]crlf[entry]crlf...")

===Return Values===
If successful, the return value of the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

AddDomainVirus()

2015-04-15T18:38:40Z

James.morgan: Created page with 'This function has been deprecated.'

This function has been deprecated.

AddUsersBulk()

2015-04-15T18:38:36Z

James.morgan:

This function has been deprecated.

This function will add several mailboxes at one time. There is an upper limit of around 100 mailboxes that may be added in a single function call.

===Input Parameters===
Three strings, one array/result array of strings:
Administrative username,
Administrative password,
Domain name,
User array ("user, pass, active, John, Doe, Company, Department, Street, City, State, Zip, Country, Phone", ...)
===Return Values===
If successful, the return value of the function will be 1. Please note that any unsuccessful user additions will be returned in the user array.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

AddUserSpamBlackList()

2015-04-15T18:38:31Z

James.morgan:

This function has been deprecated.

This function will add one or more entries to the existing blacklist for a given user. Blacklist entries can be either domain names ("example.com") or email addresses ("info@example.com").

===Parameters===

Four strings:
Administrative username,
Administrative password,
Domain name,
User ID,
Black list (formatted as "[entry]crlf[entry]crlf...")

===Return Values===
If successful, the return value of the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

AddUserSpamIPBlackList()

2015-04-15T18:38:26Z

James.morgan:

This function has been deprecated.

This function will add one or more entries to the existing IP address blacklist for a given user. Blacklist entries can be specific hosts (like "10.167.10.21") or simple ranges through the use of the % wildcard (like "10.167.10.%").

===Parameters===

Five strings:
Administrative username,
Administrative password,
Domain name,
User ID,
IP black list (formatted as "[entry]crlf[entry]crlf...")

===Return Values===
If successful, the return value of the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

AddUserSpamIPSafeList()

2015-04-15T18:38:21Z

James.morgan:

This function has been deprecated.

This function will add one or more entries to the existing IP address safelist for a given user. Safelist entries can be specific hosts (like "10.167.10.21") or simple ranges through the use of the % wildcard (like "10.167.10.%").

===Parameters===

Five strings:
Administrative username,
Administrative password,
Domain name,
User ID,
IP safe list (formatted as "[entry]crlf[entry]crlf...")

===Return Values===
If successful, the return value of the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

AddUserVirus()

2015-04-15T18:38:15Z

James.morgan: Created page with 'This function has been deprecated.'

This function has been deprecated.

AddUserVirusBulk()

2015-04-15T18:38:11Z

James.morgan: Created page with 'This function has been deprecated.'

This function has been deprecated.

AddUserWithLdapAttributesString()

2015-04-15T18:38:06Z

James.morgan:

This function has been deprecated.

This function will add a new mailbox and set it's mailbox LDAP attributes.

===Input Parameters===
Five strings, one integer, and one more string:
Administrative username,
Administrative password,
Domain name,
UserID (the part before @),
Surname (last name of user-- required),
Password,
Active (int; 1=active, 0=inactive),
Attributes string ("givenname John [crlf] o MyCompany", ...) (tab delimited between key/value pairs and CRLF delimited between records)

===Return Values===
If successful, the return value of the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

CleanAliasesByUser()

2015-04-15T18:38:01Z

James.morgan: Created page with 'This function has been deprecated.'

This function has been deprecated.

DeleteDomainSpam()

2015-04-15T18:37:57Z

James.morgan:

This function has been deprecated.

This function will disable spam filtering for a domain.
===Parameters===

Three strings
Administrative username (string),
Administrative password (string),
Domain name
===Return Values===
If successful, the return value of the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

DeleteDomainVirus()

2015-04-15T18:37:53Z

James.morgan: Created page with 'This function has been deprecated.'

This function has been deprecated.

DeleteUserAliasesBulk()

2015-04-15T18:37:49Z

James.morgan:

This function has been deprecated.

This function will remove several aliases at one time. There is an upper limit of around 100 aliases that may be removed in a single function call.

===Input Parameters===
Three strings, one array of strings:
Administrative username,
Administrative password,
Domain name,
Alias array ("alias1", "alias2", ...)
===Return Values===
If successful, the return value of the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

DeleteUserVirus()

2015-04-15T18:37:43Z

James.morgan: Created page with 'This function has been deprecated.'

This function has been deprecated.

DeleteUserVirusBulk()

2015-04-15T18:37:39Z

James.morgan: Created page with 'This function has been deprecated.'

This function has been deprecated.

DisableSubaccount()

2015-04-15T18:37:35Z

James.morgan: Created page with 'This function has been deprecated.'

This function has been deprecated.

EnableSubaccount()

2015-04-15T18:37:31Z

James.morgan: Created page with 'This function has been deprecated.'

This function has been deprecated.

GetAllDomainsMXRecords()

2015-04-15T18:37:27Z

James.morgan:

This function has been deprecated.

This function will report the current MX record settings for all domains associated with the username and password.

===Parameters===

Two strings, one array of strings
Administrative username,
Administrative password,

Domain list (array of strings as in "domainname.com, firstmxrecord, mx preference")
===Return Values===
If successful, the return value of the function will be 1.

If successful, the domain list should have one or more lines for the domains.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

GetAllDomainsSettings()

2015-04-15T18:37:22Z

James.morgan:

This function has been deprecated.

This function will report the domain settings for every domain associated with a reseller account. Settings include: domain aliases, base max mailbox size, and maximum mailboxes.

===Parameters===

Two strings, one result array:
Administrative username,
Administrative password,

Array with domain settings (format: domain, alias1 alias2 alias3, base max mailbox size, max mailboxes)
===Return Values===
If successful, the return value of the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

GetAllDomainsStats()

2015-04-15T18:37:11Z

James.morgan:

This function has been deprecated.

This function will report the number of users and the disk space used for each domain associated with a reseller account.

===Parameters===

Two strings, one result array:
Administrative username,
Administrative password,

Array with domain statistics (format: domain, user count, megabytes used; list[0]="company1.com,215,5.4",...)
===Return Values===
If successful, the return value of the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

GetAllDomainsUserCount()

2015-04-15T18:37:00Z

James.morgan:

This function has been deprecated.

This function will count all of the mailboxes across all domains associated with the username and password provided. Please note that it counts provisioned mailboxes, not allocated mailboxes (e.g. if a company is allowed to have 10 mailboxes, but has only configured 8 mailboxes, this function would count 8 users).

===Parameters===

Two strings, one integer
Administrative username (string),
Administrative password (string),

Number of users (int)
===Return Values===
If successful, the return value of the function will be 1.

If successful, the integer variable will hold the total user count across all domains.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

GetAllocatedStorage()

2015-04-15T18:36:55Z

James.morgan: Created page with 'This function has been deprecated.'

This function has been deprecated.

GetDomainAdministrators()

2015-04-15T18:36:50Z

James.morgan: Created page with 'This function has been deprecated.'

This function has been deprecated.

GetDomainAllUserCurrentSizeActive()

2015-04-15T18:36:46Z

James.morgan:

This function has been deprecated.

This function will report the amount of space used by each mailbox in a domain that is either active or inactive as selected by the API user. This information is updated nightly. Size is given in bytes (not KB nor MB)

===Input Parameters===
Three strings, an integer, and one result array:
Administrative username,
Administrative password,
Domain name,
Active flag (integer, 1=active, 0=inactive)

Size array (as is: list[0]="user1, 243423", list[1]="user2, 3423", ...)
===Return Values===
If successful, the return value of the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

GetDomainAllUserCurrentSizeAlpha()

2015-04-15T18:36:42Z

James.morgan:

This function has been deprecated.

This function will report the amount of space used by each mailbox in a domain where the mailbox matches the search element. Passing a single letter or number as the search element will return the info for all usernames that begin with that letter or number. Passing 2+ letters/numbers will return the info for all usernames that match the search element inside the username. This information is updated nightly. Size is given in bytes (not KB nor MB)

===Input Parameters===
Four strings and one result array:
Administrative username,
Administrative password,
Domain name,
Search element (single letter or number= match usernames that start with it, multiple = match inside username)

Size array (as is: list[0]="user1, 243423", list[1]="user2, 3423", ...)
===Return Values===
If successful, the return value of the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

GetDomainAllUserLastLoginActive()

2015-04-15T18:36:37Z

James.morgan:

This function has been deprecated.

This function will report the date of the last login for all mailboxes on a domain that are either active or inactive (whichever is selected by the API user). POP3/IMAP/Webmail logins are all considered a login (not SMTP Auth). Last login information is recalculated nightly-- so the most recent login should generally be yesterday's date on an active account.

===Input Parameters===
Three strings, an integer, and one result array:
Administrative username,
Administrative password,
Domain name,
Active flag (integer, 1=active, 0=inactive)

Last login array (as in: list[0]="user1, month/day/year hour:minute:second AM/PM",list[1]="user2..."...)
===Return Values===
If successful, the return value of the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

GetDomainAllUserLastLoginAlpha()

2015-04-15T18:36:33Z

James.morgan:

This function has been deprecated.

This function will report the date of the last login for all mailboxes on a domain that match the string provided. Note that if a single letter is passed as the search element, then the function will return all usernames where the first letter matches the search element. Otherwise, the 2+ letters given in the search element will be used to return usernames that have the search element somewhere inside the username. POP3/IMAP/Webmail logins are all considered a login (not SMTP Auth). Last login information is recalculated nightly-- so the most recent login should generally be yesterday's date on an active account.

===Input Parameters===
Three strings, an integer, and one result array:
Administrative username,
Administrative password,
Domain name,
Search element (single number or letter: match usernames that start with it, multiple = match in username),

Last login array (as in: list[0]="user1, month/day/year hour:minute:second AM/PM",list[1]="user2..."...)
===Return Values===
If successful, the return value of the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

GetDomainAllUserStatsAlpha()

2015-04-15T18:36:27Z

James.morgan:

This function has been deprecated.

This function will return last login and mailbox sizes for either active users or inactive (disabled) users on a domain, where the usernames match the search element. If only a single letter or number is used for the search element, this function will return info on usernames that begin with that letter or number. If 2+ letters/numbers are in the search element, then usernames that match the search element inside the username will be returned.

===Input Parameters===
Three strings, one integer, and one result array:
Administrative username,
Administrative password,
Domain name,
Search element (single letter or number = match usernames that start with it, 2+ = return usernames that match)

User array (formatted as: list[0]="user1, 11/30/05, 2420302", list[1]="user2..."...)
===Return Values===
If successful, the return value of the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

GetDomainMXRecords()

2015-04-15T18:36:22Z

James.morgan: Created page with 'This function has been deprecated.'

This function has been deprecated.

GetDomainNotify()

2015-04-15T18:36:18Z

James.morgan:

This function has been deprecated.

This function will report the notification percentage and message to be used when a mailbox on a domain starts to get full. It also reports any configured email address that will also receive a copy of the notice.

There are two special tags that can be used inside the notification message:
<nowiki><*USER*></nowiki> will insert the userID (part before the @) of the mailbox that is getting full
<nowiki><*DOMAIN*></nowiki> will insert the domain name of the mailbox that is getting full

===Input Parameters===
Three strings, three result strings:
Administrative username,
Administrative password,
Domain name,

Notify percentage (string, whole numbers 0-100 only; 0 means no notices will be sent)
CC: address (string email address of someone who should *also* receive a copy of the notice, "" for none)
Notify message (string of text of notification message).
===Return Values===
If successful, the return value of the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

GetDomainNumBcc()

2015-04-15T18:36:13Z

James.morgan:

This function has been deprecated.

This function will return the number of BCC archived mailboxes

===Parameters===

Three strings of input, two integers of output:
"ResellerUsername" (the administrative user for the API),
"ResellerPassword",
"HostName" (domain name),

"Result",
"numBcc" (number of mailboxes being archived via BCC)

===Return Values===
If successful, the return value of "Result" from the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

GetDomainNumSync()

2015-04-15T18:36:06Z

James.morgan: Created page with 'This function has been deprecated.'

This function has been deprecated.

GetDomainNumUserAliases()

2015-04-15T18:36:02Z

James.morgan: Created page with 'This function has been deprecated.'

This function has been deprecated.

GetDomainNumUsersActive()

2015-04-15T18:35:37Z

James.morgan:

This function has been deprecated.

This function will return the current number of either active or inactive mailboxes on the domain.

===Input Parameters===

Three strings, an integer, and a result integer:
Administrative username,
Administrative password,
Domain name,
Active flag (integer, 1=active, 0=inactive)

Number of users (int)
===Return Values===
If successful, the return value of the function will be 1.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

GetDomainSpamCleaner()

2015-04-15T18:30:50Z

James.morgan:

This function has been deprecated.

This function will report the automatic delete action to be taken with messages that reside in the spam IMAP/webmail folder.

===Parameters===

Three strings, two integers
Administrative username (string),
Administrative password (string),
Domain name,

Number of days to store a message before auto-deletion (0 to disable),
Number of messages to store in the spam folder before auto-deletion (0 to disable)
===Return Values===
If successful, the return value of the function will be 1.

If successful, the day and message counts will have the current settings.

Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

GetDomainSpamGreylist()

2015-04-15T18:30:44Z

James.morgan:

This function has been deprecated.