Difference between revisions of "Exchange Mailbox (Rest API)"

Revision as of 08:35, 31 August 2009 (view source) Kevin.lin (talk | contribs) ← Older edit		Revision as of 11:22, 2 September 2009 (view source) Kevin.lin (talk | contribs) Newer edit →
Line 1:		Line 1:
−	== Exchange Mailbox ==
−	=== Index ===	+
		+	__TOC__
		+
		+
		+	== Index ==
	''URL'':		''URL'':
−	[GET] /customers/(customer account number)/domains/(domain name)/ex/mailboxes	+
		+	<nowiki>[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes</nowiki>
Line 29:		Line 34:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
Line 40:		Line 45:
−	=== Show ===	+	== Show ==
	''URL'':		''URL'':
−	[GET] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)	+	<nowiki>[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)</nowiki>
Line 68:		Line 74:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
	| abc.com not found		| abc.com not found
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
Line 83:		Line 89:
−	=== Add/Edit ===	+	== Add/Edit ==
	''URL'':		''URL'':
−	Add: [POST] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)	+	<nowiki>Add: [POST] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
−	Edit: [PUT] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)	+	/ex/mailboxes/(mailbox name)
		+	Edit: [PUT] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)</nowiki>
Line 99:		Line 107:
	!''Data Type''		!''Data Type''
	!''Description''		!''Description''
−	|-	+	|-
	| displayName		| displayName
	| string		| string
	| Display name (Required for Add)		| Display name (Required for Add)
−	|-	+	|-
	| password		| password
	| string		| string
	| Password (Required for Add)		| Password (Required for Add)
−	|-	+	|-
	| size		| size
	| positive integer		| positive integer
	| Mailbox size in megabytes (Required for Add)		| Mailbox size in megabytes (Required for Add)
−	|-	+	|-
	| isHidden		| isHidden
	| boolean		| boolean
	| Indicates whether or not the mailbox is hidden from the Global Address List		| Indicates whether or not the mailbox is hidden from the Global Address List
−	|-	+	|-
	| isPublicFolderAdmin		| isPublicFolderAdmin
	| boolean		| boolean
	| Indicates whether or not the account is a public folder administrator		| Indicates whether or not the account is a public folder administrator
−	|-	+	|-
	| firstName		| firstName
	| string		| string
	| First name		| First name
−	|-	+	|-
	| lastName		| lastName
	| string		| string
	| Last name		| Last name
−	|-	+	|-
	| company		| company
	| string		| string
	| Company		| Company
−	|-	+	|-
	| department		| department
	| string		| string
	| Department		| Department
−	|-	+	|-
	| jobTitle		| jobTitle
	| string		| string
	| Job title		| Job title
−	|-	+	|-
	| addressLine1		| addressLine1
	| string		| string
	| Street address		| Street address
−	|-	+	|-
	| city		| city
	| string		| string
	| City		| City
−	|-	+	|-
	| state		| state
	| string		| string
	| State		| State
−	|-	+	|-
	| zip		| zip
	| string		| string
	| Zip or postal code		| Zip or postal code
−	|-	+	|-
	| country		| country
	| string		| string
	| Country		| Country
−	|-	+	|-
	| businessnumber		| businessnumber
	| string		| string
	| Business phone number		| Business phone number
−	|-	+	|-
	| pagernumber		| pagernumber
	| string		| string
	| Pager phone number		| Pager phone number
−	|-	+	|-
	| homenumber		| homenumber
	| string		| string
	| Home phone number		| Home phone number
−	|-	+	|-
	| mobilenumber		| mobilenumber
	| string		| string
	| Mobile phone number		| Mobile phone number
−	|-	+	|-
	| faxnumber		| faxnumber
	| string		| string
	| Fax phone number		| Fax phone number
−	|-	+	|-
	| notes		| notes
	| string		| string
	| Notes field		| Notes field
−	|-	+	|-
	| emailForwardingAddress		| emailForwardingAddress
	| string		| string
	| Forwarding email address (If this field is assigned an email address, then email forwarding will be turned on. If this field is not assigned or assigned an empty string, then email forwarding will be disabled.)		| Forwarding email address (If this field is assigned an email address, then email forwarding will be turned on. If this field is not assigned or assigned an empty string, then email forwarding will be disabled.)
−	|-	+	|-
	| enabled		| enabled
	| string		| string
Line 198:		Line 206:
	post '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith', 'text/xml',		post '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith', 'text/xml',
	{		{
−	'displayName' => 'Alex Smith',	+	'displayName' => 'Alex Smith',
−	'password' => 'Secret123!@#',	+	'password' => 'Secret123!@#',
−	'size' => '2048'	+	'size' => '2048'
	}		}
	</pre>		</pre>
Line 207:		Line 215:
	put '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith', 'text/xml',		put '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith', 'text/xml',
	{		{
−	'homenumber' => '8005551234'	+	'homenumber' => '8005551234'
	}		}
	</pre>		</pre>
Line 218:		Line 226:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
	| abc.com not found		| abc.com not found
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
	| Mailbox not found		| Mailbox not found
−	|-	+	|-
	| Required form field is missing		| Required form field is missing
	| 400		| 400
	| Missing required field: displayName		| Missing required field: displayName
−	|-	+	|-
	| Required form field has null or empty string input		| Required form field has null or empty string input
	| 400		| 400
	| Required field displayName cannot be empty		| Required field displayName cannot be empty
−	|-	+	|-
	| New mailbox name (user name) doesn't meet the naming requirements		| New mailbox name (user name) doesn't meet the naming requirements
	| 400		| 400
	| Invalid user name		| Invalid user name
−	|-	+	|-
	| New mailbox display name doesn't meet the naming requirements		| New mailbox display name doesn't meet the naming requirements
	| 400		| 400
	| Invalid display name		| Invalid display name
−	|-	+	|-
	| Integer form field has non-integer input		| Integer form field has non-integer input
	| 400		| 400
	| Invalid format for size, input must be an integer		| Invalid format for size, input must be an integer
−	|-	+	|-
	| Boolean form field has non-boolean input		| Boolean form field has non-boolean input
	| 400		| 400
	| Invalid format for Enabled, input must be True or False		| Invalid format for Enabled, input must be True or False
−	|-	+	|-
	| New mailbox password doesn't meet the password pattern requirements		| New mailbox password doesn't meet the password pattern requirements
	| 400		| 400
	| Password must be at least 8 characters long		| Password must be at least 8 characters long
−	|-	+	|-
	| Form data has unrecognized field		| Form data has unrecognized field
	| 400		| 400
	| Unrecognized field: extraStorage		| Unrecognized field: extraStorage
−	|-	+	|-
	| New mailbox name (user name) already exists		| New mailbox name (user name) already exists
	| 400		| 400
Line 269:		Line 277:
−	=== Delete ===	+	== Delete ==
	''URL'':		''URL'':
−	[DELETE] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)	+	<nowiki>[DELETE] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)</nowiki>
Line 297:		Line 306:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
	| abc.com not found		| abc.com not found
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
Line 308:		Line 317:
−	=== Add Email Address ===	+	== Add Email Address ==
	''URL'':		''URL'':
−	[POST] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/emailaddresses/(email address)	+	<nowiki>[POST] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/emailaddresses/(email address)</nowiki>
Line 331:		Line 341:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
Line 342:		Line 352:
−	=== Delete Email Address ===	+	== Delete Email Address ==
	''URL'':		''URL'':
−	[DELETE] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/emailaddresses/(email address)	+	<nowiki>[DELETE] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/emailaddresses/(email address)</nowiki>
Line 370:		Line 381:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
Line 381:		Line 392:
−	=== Spam ===	+	== Spam ==
−	==== Index Blacklist ====	+	=== Index Blacklist ===
	''URL'':		''URL'':
−	[GET] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/spam/blacklist	+	<nowiki>[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/spam/blacklist</nowiki>
Line 411:		Line 423:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
Line 422:		Line 434:
−	==== Index IP Blacklist ====	+	=== Index IP Blacklist ===
	''URL'':		''URL'':
−	[GET] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/spam/ipblacklist	+	<nowiki>[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/spam/ipblacklist</nowiki>
Line 450:		Line 463:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
Line 461:		Line 474:
−	==== Index Safelist ====	+	=== Index Safelist ===
	''URL'':		''URL'':
−	[GET] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/spam/safelist	+	<nowiki>[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/spam/safelist</nowiki>
Line 489:		Line 503:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
Line 500:		Line 514:
−	==== Index IP Safelist ====	+	=== Index IP Safelist ===
	''URL'':		''URL'':
−	[GET] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/spam/ipsafelist	+	<nowiki>[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/spam/ipsafelist</nowiki>
Line 528:		Line 543:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
Line 539:		Line 554:
−	==== Add Blacklist ====	+	=== Add Blacklist ===
	''URL'':		''URL'':
−	[POST] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/spam/blacklist/(email address)	+	<nowiki>[POST] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/spam/blacklist/(email address)</nowiki>
Line 562:		Line 578:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
	| abc.com not found		| abc.com not found
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
	| No user with the email address alex.smith@example.com exists		| No user with the email address alex.smith@example.com exists
−	|-	+	|-
	| Entered invalid email or domain		| Entered invalid email or domain
	| 400		| 400
	| invalid email address: abc		| invalid email address: abc
−	|-	+	|-
	| Entered current domain		| Entered current domain
	| 400		| 400
Line 585:		Line 601:
−	==== Add IP Blacklist ====	+	=== Add IP Blacklist ===
	''URL'':		''URL'':
−	[POST] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/spam/ipblacklist/(ip address)	+	<nowiki>[POST] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/spam/ipblacklist/(ip address)</nowiki>
Line 608:		Line 625:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
	| abc.com not found		| abc.com not found
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
	| No user with the email address alex.smith@example.com exists		| No user with the email address alex.smith@example.com exists
−	|-	+	|-
	| Entered invalid IP address		| Entered invalid IP address
	| 400		| 400
Line 627:		Line 644:
−	==== Add Safelist ====	+	=== Add Safelist ===
	''URL'':		''URL'':
−	[POST] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/spam/safelist/(email address)	+	<nowiki>[POST] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/spam/safelist/(email address)</nowiki>
Line 650:		Line 668:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
	| abc.com not found		| abc.com not found
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
	| No user with the email address alex.smith@example.com exists		| No user with the email address alex.smith@example.com exists
−	|-	+	|-
	| Entered invalid email or domain		| Entered invalid email or domain
	| 400		| 400
Line 669:		Line 687:
−	==== Add IP Safelist ====	+	=== Add IP Safelist ===
	''URL'':		''URL'':
−	[POST] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/spam/safelist/(ip address)	+	<nowiki>[POST] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/spam/safelist/(ip address)</nowiki>
Line 692:		Line 711:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
	| abc.com not found		| abc.com not found
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
	| No user with the email address alex.smith@example.com exists		| No user with the email address alex.smith@example.com exists
−	|-	+	|-
	| Entered invalid IP address		| Entered invalid IP address
	| 400		| 400
Line 711:		Line 730:
−	==== Delete Blacklist ====	+	=== Delete Blacklist ===
	''URL'':		''URL'':
−	[DELETE] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/spam/blacklist/(email address)	+	<nowiki>[DELETE] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/spam/blacklist/(email address)</nowiki>
Line 734:		Line 754:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
	| abc.com not found		| abc.com not found
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
	| No user with the email address alex.smith@example.com exists		| No user with the email address alex.smith@example.com exists
−	|-	+	|-
	| Entered invalid email or domain		| Entered invalid email or domain
	| 400		| 400
	| invalid email address: abc		| invalid email address: abc
−	|-	+	|-
	| Entered email or domain is not on the current blacklist		| Entered email or domain is not on the current blacklist
	| 400		| 400
Line 757:		Line 777:
−	==== Delete IP Blacklist ====	+	=== Delete IP Blacklist ===
	''URL'':		''URL'':
−	[DELETE] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/spam/ipblacklist/(ip address)	+	<nowiki>[DELETE] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/spam/ipblacklist/(ip address)</nowiki>
Line 780:		Line 801:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
	| abc.com not found		| abc.com not found
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
	| No user with the email address alex.smith@example.com exists		| No user with the email address alex.smith@example.com exists
−	|-	+	|-
	| Entered invalid IP address		| Entered invalid IP address
	| 400		| 400
	| invalid ip address: 123		| invalid ip address: 123
−	|-	+	|-
	| Entered IP is not on the current blacklist		| Entered IP is not on the current blacklist
	| 400		| 400
Line 803:		Line 824:
−	==== Delete Safelist ====	+	=== Delete Safelist ===
	''URL'':		''URL'':
−	[DELETE] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/spam/safelist/(email address)	+	<nowiki>[DELETE] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/spam/safelist/(email address)</nowiki>
Line 826:		Line 848:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
	| abc.com not found		| abc.com not found
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
	| No user with the email address alex.smith@example.com exists		| No user with the email address alex.smith@example.com exists
−	|-	+	|-
	| Entered invalid email or domain		| Entered invalid email or domain
	| 400		| 400
	| invalid email address: abc		| invalid email address: abc
−	|-	+	|-
	| Entered email or domain is not on the current safelist		| Entered email or domain is not on the current safelist
	| 400		| 400
Line 849:		Line 871:
−	==== Delete IP Safelist ====	+	=== Delete IP Safelist ===
	''URL'':		''URL'':
−	[DELETE] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/spam/ipsafelist/(email address)	+	<nowiki>[DELETE] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/spam/ipsafelist/(email address)</nowiki>
Line 872:		Line 895:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
	| abc.com not found		| abc.com not found
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
	| No user with the email address alex.smith@example.com exists		| No user with the email address alex.smith@example.com exists
−	|-	+	|-
	| Entered invalid IP address		| Entered invalid IP address
	| 400		| 400
	| invalid ip address: 123		| invalid ip address: 123
−	|-	+	|-
	| Entered IP is not on the current safelist		| Entered IP is not on the current safelist
	| 400		| 400
Line 895:		Line 918:
−	==== Show Spam Setting ====	+	=== Show Spam Setting ===
	''URL'':		''URL'':
−	[GET] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/spam/settings	+	<nowiki>[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/spam/settings</nowiki>
Line 923:		Line 947:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
	| abc.com not found		| abc.com not found
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
Line 938:		Line 962:
−	==== Edit Spam Setting ====	+	=== Edit Spam Setting ===
	''URL'':		''URL'':
−	[PUT] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/spam/settings	+	<nowiki>[PUT] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/spam/settings</nowiki>
Line 953:		Line 978:
	!''Data Type''		!''Data Type''
	!''Description''		!''Description''
−	|-	+	|-
	| filterlevel		| filterlevel
	| string		| string
	| Spam filter status, must be 'on' or 'off' or 'exclusive' (Required)		| Spam filter status, must be 'on' or 'off' or 'exclusive' (Required)
−	|-	+	|-
	| sendtodomainquarantine		| sendtodomainquarantine
	| boolean		| boolean
	| Indicates whether or not send spam to domain quarantine		| Indicates whether or not send spam to domain quarantine
−	|-	+	|-
	| quarantineowner		| quarantineowner
	| string		| string
Line 991:		Line 1,016:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
	| abc.com not found		| abc.com not found
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
	| No user with the email address alex.smith@example.com exists		| No user with the email address alex.smith@example.com exists
−	|-	+	|-
	| Required form field is missing		| Required form field is missing
	| 400		| 400
	| Missing required field: filterlevel		| Missing required field: filterlevel
−	|-	+	|-
	| Required form field has null or empty string input		| Required form field has null or empty string input
	| 400		| 400
	| Required field filterlevel cannot be empty		| Required field filterlevel cannot be empty
−	|-	+	|-
	| Form data has unrecognized field		| Form data has unrecognized field
	| 400		| 400
	| Unrecognized field: address		| Unrecognized field: address
−	|-	+	|-
	| Boolean form field has non-boolean input		| Boolean form field has non-boolean input
	| 400		| 400
−	| Invalid format for sendtodomainquarantine, input must be true or false	+	| Invalid format for sendtodomainquarantine, input must be true or false
−	|-	+	|-
	| Invalid input for form field 'filterlevel'		| Invalid input for form field 'filterlevel'
	| 400		| 400
Line 1,026:		Line 1,051:
−	=== BlackBerry Mobile Service ===	+	== BlackBerry Mobile Service ==
−	==== Index ====	+	=== Index ===
	''URL'':		''URL'':
−	[GET] /customers/(customer account number)/domains/(domain name)/ex/blackberrymobileservices	+	<nowiki>[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/blackberrymobileservices</nowiki>
Line 1,056:		Line 1,082:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
Line 1,068:		Line 1,094:
−	==== Add ====	+	=== Add ===
	''URL'':		''URL'':
−	[POST] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/blackberrymobileservice	+	<nowiki>[POST] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/blackberrymobileservice</nowiki>
Line 1,083:		Line 1,110:
	!''Data Type''		!''Data Type''
	!''Description''		!''Description''
−	|-	+	|-
	| activationPassword		| activationPassword
	| string		| string
Line 1,105:		Line 1,132:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
	| abc.com not found		| abc.com not found
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
	| Mailbox not found		| Mailbox not found
−	|-	+	|-
	| Mailbox already has BlackBerry Service		| Mailbox already has BlackBerry Service
	| 400		| 400
Line 1,124:		Line 1,151:
−	==== Delete ====	+	=== Delete ===
	''URL'':		''URL'':
−	[DELETE] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/blackberrymobileservice	+	<nowiki>[DELETE] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/blackberrymobileservice</nowiki>
Line 1,147:		Line 1,175:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
	| abc.com not found		| abc.com not found
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
Line 1,158:		Line 1,186:
−	=== ActiveSync Mobile Service ===	+	== ActiveSync Mobile Service ==
−	==== Index ====	+	=== Index ===
	''URL'':		''URL'':
−	[GET] /customers/(customer account number)/domains/(domain name)/ex/activesyncmobileservices	+	<nowiki>[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/activesyncmobileservices</nowiki>
Line 1,188:		Line 1,217:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
Line 1,200:		Line 1,229:
−	==== Add ====	+	=== Add ===
	''URL'':		''URL'':
−	[POST] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/activesyncmobileservice	+	<nowiki>[POST] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/activesyncmobileservice</nowiki>
Line 1,226:		Line 1,256:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Format is invalid		| Format is invalid
	| 404		| 404
	| Invalid format		| Invalid format
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
	| abc.com not found		| abc.com not found
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
	| Mailbox not found		| Mailbox not found
−	|-	+	|-
	| Mailbox already has BlackBerry Service		| Mailbox already has BlackBerry Service
	| 400		| 400
Line 1,245:		Line 1,275:
−	==== Delete ====	+	=== Delete ===
	''URL'':		''URL'':
−	[DELETE] /customers/(customer account number)/domains/(domain name)/ex/mailboxes/(mailbox name)/blackberrymobileservice	+	<nowiki>[DELETE] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
		+	/ex/mailboxes/(mailbox name)/blackberrymobileservice</nowiki>
Line 1,268:		Line 1,299:
	!''HTTP Response Code''		!''HTTP Response Code''
	!''Sample Message''		!''Sample Message''
−	|-	+	|-
	| Domain is not found		| Domain is not found
	| 404		| 404
	| abc.com not found		| abc.com not found
−	|-	+	|-
	| Mailbox is not found		| Mailbox is not found
	| 404		| 404
	| Mailbox not found		| Mailbox not found
	|}		|}

---

Revision as of 11:22, 2 September 2009

Index

URL:

[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes

Description:

Shows a list of mailboxes under the domain

Remarks:

The show operation only supports the GET HTTP verb. For .xml format refer to the following schema document: MailboxList.xsd

Example:

get '/customers/12345678/domains/example.com/ex/mailboxes', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found

Show

URL:

[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(mailbox name)

Description:

The show operation will return detailed information about the specified mailbox.

Remarks:

The show operation only supports the GET HTTP verb. For .xml format refer to the following schema document: Mailbox.xsd

Example:

get '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found
Mailbox is not found	404	Mailbox not found

Add/Edit

URL:

Add: [POST] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(mailbox name)
Edit: [PUT] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(mailbox name)

Description:

Adds/edits a mailbox using the specified form fields. All required fields must be supplied when adding. Other fields may be omitted.

Field Name	Data Type	Description
displayName	string	Display name (Required for Add)
password	string	Password (Required for Add)
size	positive integer	Mailbox size in megabytes (Required for Add)
isHidden	boolean	Indicates whether or not the mailbox is hidden from the Global Address List
isPublicFolderAdmin	boolean	Indicates whether or not the account is a public folder administrator
firstName	string	First name
lastName	string	Last name
company	string	Company
department	string	Department
jobTitle	string	Job title
addressLine1	string	Street address
city	string	City
state	string	State
zip	string	Zip or postal code
country	string	Country
businessnumber	string	Business phone number
pagernumber	string	Pager phone number
homenumber	string	Home phone number
mobilenumber	string	Mobile phone number
faxnumber	string	Fax phone number
notes	string	Notes field
emailForwardingAddress	string	Forwarding email address (If this field is assigned an email address, then email forwarding will be turned on. If this field is not assigned or assigned an empty string, then email forwarding will be disabled.)
enabled	string	Enable/Disable mailbox, input must be "true" or "false"

Example:

post '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith', 'text/xml', 
{ 
  'displayName' => 'Alex Smith',
  'password' => 'Secret123!@#',
  'size' => '2048'
} 

put '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith', 'text/xml',
{ 
  'homenumber' => '8005551234'
}  

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found
Mailbox is not found	404	Mailbox not found
Required form field is missing	400	Missing required field: displayName
Required form field has null or empty string input	400	Required field displayName cannot be empty
New mailbox name (user name) doesn't meet the naming requirements	400	Invalid user name
New mailbox display name doesn't meet the naming requirements	400	Invalid display name
Integer form field has non-integer input	400	Invalid format for size, input must be an integer
Boolean form field has non-boolean input	400	Invalid format for Enabled, input must be True or False
New mailbox password doesn't meet the password pattern requirements	400	Password must be at least 8 characters long
Form data has unrecognized field	400	Unrecognized field: extraStorage
New mailbox name (user name) already exists	400	The email address john.doe@abc.com is already in use

Delete

URL:

[DELETE] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
            /ex/mailboxes/(mailbox name)

Description:

Deletes the mailbox.

Remarks:

The mailbox and mailbox contents are deleted permanently.

Example:

delete '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Domain is not found	404	abc.com not found
Mailbox is not found	404	Mailbox not found

Add Email Address

URL:

[POST] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(mailbox name)/emailaddresses/(email address)

Description:

Adds a mailbox's email address.

Example:

post '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith/emailaddresses/alex@example.com', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found

Delete Email Address

URL:

[DELETE] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
            /ex/mailboxes/(mailbox name)/emailaddresses/(email address)

Description:

The delete email address.

Remarks:

The operation will fail if the email address does not exist.

Example:

delete '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith/emailaddresses/alex@example.com', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found

Spam

Index Blacklist

URL:

[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(mailbox name)/spam/blacklist

Description:

This operation returns email address blacklist associated with the mailbox.

Remarks:

The Index operation only supports the GET HTTP verb. For .xml format refer to the following schema document: Blacklist.xsd

Example:

get '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith/spam/blacklist', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Mailbox is not found	404	No user with the email address alex.smith@example.com exists

Index IP Blacklist

URL:

[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(mailbox name)/spam/ipblacklist

Description:

This operation returns IP blacklist associated with the mailbox.

Remarks:

The Index operation only supports the GET HTTP verb. For .xml format refer to the following schema document: IpBlacklist.xsd

Example:

get '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith/spam/ipblacklist', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Mailbox is not found	404	No user with the email address alex.smith@example.com exists

Index Safelist

URL:

[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(mailbox name)/spam/safelist

Description:

This operation returns email address safelist associated with the mailbox.

Remarks:

The Index operation only supports the GET HTTP verb. For .xml format refer to the following schema document: Safelist.xsd

Example:

get '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith/spam/safelist', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Mailbox is not found	404	No user with the email address alex.smith@example.com exists

Index IP Safelist

URL:

[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(mailbox name)/spam/ipsafelist

Description:

This operation returns IP safelist associated with the mailbox.

Remarks:

The Index operation only supports the GET HTTP verb. For .xml format refer to the following schema document: IpSafelist.xsd

Example:

get '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith/spam/ipsafelist', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Mailbox is not found	404	No user with the email address alex.smith@example.com exists

Add Blacklist

URL:

[POST] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(mailbox name)/spam/blacklist/(email address)

Description:

Adds an email address or domain to the blacklist.

Example:

post '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith/spam/blacklist/anyone@spam.com', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found
Mailbox is not found	404	No user with the email address alex.smith@example.com exists
Entered invalid email or domain	400	invalid email address: abc
Entered current domain	400	Adding example.com would blacklist the current domain

Add IP Blacklist

URL:

[POST] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(mailbox name)/spam/ipblacklist/(ip address)

Description:

Adds an IP to the blacklist.

Example:

post '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith/spam/blacklist/216.12.34.1', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found
Mailbox is not found	404	No user with the email address alex.smith@example.com exists
Entered invalid IP address	400	invalid ip address: 123

Add Safelist

URL:

[POST] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(mailbox name)/spam/safelist/(email address)

Description:

Adds an email address or domain to the safelist.

Example:

post '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith/spam/safelist/anyone@yahoo.com', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found
Mailbox is not found	404	No user with the email address alex.smith@example.com exists
Entered invalid email or domain	400	invalid email address: abc

Add IP Safelist

URL:

[POST] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(mailbox name)/spam/safelist/(ip address)

Description:

Adds an IP to the safelist.

Example:

post '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith/spam/safelist/216.12.34.1', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found
Mailbox is not found	404	No user with the email address alex.smith@example.com exists
Entered invalid IP address	400	invalid ip address: 123

Delete Blacklist

URL:

[DELETE] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
            /ex/mailboxes/(mailbox name)/spam/blacklist/(email address)

Description:

Removes an email address or domain from the blacklist.

Example:

delete '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith/spam/blacklist/anyone@yahoo.com', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found
Mailbox is not found	404	No user with the email address alex.smith@example.com exists
Entered invalid email or domain	400	invalid email address: abc
Entered email or domain is not on the current blacklist	400	abc@junkmail.com is not found on the blacklist

Delete IP Blacklist

URL:

[DELETE] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
            /ex/mailboxes/(mailbox name)/spam/ipblacklist/(ip address)

Description:

Removes an IP from the blacklist.

Example:

delete '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith/spam/ipblacklist/216.12.34.1', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found
Mailbox is not found	404	No user with the email address alex.smith@example.com exists
Entered invalid IP address	400	invalid ip address: 123
Entered IP is not on the current blacklist	400	216.12.34.1 is not found on the blacklist

Delete Safelist

URL:

[DELETE] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
            /ex/mailboxes/(mailbox name)/spam/safelist/(email address)

Description:

Removes an email address or domain from the safelist.

Example:

delete '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith/spam/safelist/anyone@yahoo.com', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found
Mailbox is not found	404	No user with the email address alex.smith@example.com exists
Entered invalid email or domain	400	invalid email address: abc
Entered email or domain is not on the current safelist	400	anyone@yahoo.com is not found on the safelist

Delete IP Safelist

URL:

[DELETE] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
            /ex/mailboxes/(mailbox name)/spam/ipsafelist/(email address)

Description:

Removes an IP from the safelist.

Example:

delete '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith/spam/ipsafelist/216.12.34.1', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found
Mailbox is not found	404	No user with the email address alex.smith@example.com exists
Entered invalid IP address	400	invalid ip address: 123
Entered IP is not on the current safelist	400	216.12.34.1 is not found on the safelist

Show Spam Setting

URL:

[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(mailbox name)/spam/settings

Description:

This operation returns the spam settings associated with the mailbox.

Remarks:

The Show operation only supports the GET HTTP verb. For .xml format refer to the following schema document: MailboxSpamSetting.xsd

Example:

get '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith/spam/settings', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found
Mailbox is not found	404	Mailbox not found

Edit Spam Setting

URL:

[PUT] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(mailbox name)/spam/settings

Description:

This operation will modify the mailbox spam setting. Only 'filterlevel' is the required form field.

Field Name	Data Type	Description
filterlevel	string	Spam filter status, must be 'on' or 'off' or 'exclusive' (Required)
sendtodomainquarantine	boolean	Indicates whether or not send spam to domain quarantine
quarantineowner	string	The email address that quarantine notifications be sent to

Remarks:

Form field "filterlevel" is always required.
When "filterlevel" is "on", spam will be sent to mailbox quarantine as default, unless "sendtodomainquarantine" is set to "true".
Changing "filterlevel" to "off" will force "sendtodomainquarantine" to be "false".
When "filterlevel" is "exclusive", spam will be sent to mailbox quarantine as default, unless "sendtodomainquarantine" is set to "true". In addition, mailbox will only receive email from addresses and IPs on its safelist.

Example:

put '/customers/12345678/domains/example.com/ex/mailboxes/alex.smith/spam/settings', 'text/xml',
{ 
  'filterlevel' => 'off'
}  

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found
Mailbox is not found	404	No user with the email address alex.smith@example.com exists
Required form field is missing	400	Missing required field: filterlevel
Required form field has null or empty string input	400	Required field filterlevel cannot be empty
Form data has unrecognized field	400	Unrecognized field: address
Boolean form field has non-boolean input	400	Invalid format for sendtodomainquarantine, input must be true or false
Invalid input for form field 'filterlevel'	400	Invalid filterLevel, input must be: on/off/exclusive

BlackBerry Mobile Service

Index

URL:

[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/blackberrymobileservices

Description:

Returns a list of mailboxes that has BlackBerry mobile service enabled.

Remarks:

The index operation only supports the GET HTTP verb. For .xml format refer to the following schema document: BlackberryMobileServiceList.xsd

Example:

get '/customers/12345678/domains/example.com/ex/blackberrymobileservices', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found

Add

URL:

[POST] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(mailbox name)/blackberrymobileservice

Description:

Attaches a BlackBerry mobile service to the mailbox.

Field Name	Data Type	Description
activationPassword	string	Activation password (Required)

Example:

post '/customers/12345678/domains/example.com/ex/mailboxes/john.smith/blackberrymobileservice', 'text/xml',
{
  'activationPassword' => '12345'
}

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found
Mailbox is not found	404	Mailbox not found
Mailbox already has BlackBerry Service	400	User john.smith@example.com has BlackBerry Mobile Service already

Delete

URL:

[DELETE] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
            /ex/mailboxes/(mailbox name)/blackberrymobileservice

Description:

Detaches a BlackBerry mobile service from a mailbox.

Example:

delete '/customers/12345678/domains/example.com/ex/mailboxes/john.smith/blackberrymobileservice', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Domain is not found	404	abc.com not found
Mailbox is not found	404	Mailbox not found

ActiveSync Mobile Service

Index

URL:

[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/activesyncmobileservices

Description:

Returns a list of mailboxes that has ActiveSync mobile service enabled.

Remarks:

The index operation only supports the GET HTTP verb. For .xml format refer to the following schema document: ActiveSyncMobileServiceList.xsd

Example:

get '/customers/12345678/domains/example.com/ex/activesyncmobileservices', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found

Add

URL:

[POST] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(mailbox name)/activesyncmobileservice

Description:

Attaches a ActiveSync service to the mailbox.

Example:

post '/customers/12345678/domains/example.com/ex/mailboxes/john.smith/blackberrymobileservice', 'text/xml',
{
  'activationPassword' => '12345'
}

Errors:

Description	HTTP Response Code	Sample Message
Format is invalid	404	Invalid format
Domain is not found	404	abc.com not found
Mailbox is not found	404	Mailbox not found
Mailbox already has BlackBerry Service	400	User john.smith@example.com has BlackBerry Mobile Service already

Delete

URL:

[DELETE] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
            /ex/mailboxes/(mailbox name)/blackberrymobileservice

Description:

Detaches a ActiveSync mobile service from a mailbox.

Example:

delete '/customers/12345678/domains/example.com/ex/mailboxes/john.smith/blackberrymobileservice', 'text/xml'

Errors:

Description	HTTP Response Code	Sample Message
Domain is not found	404	abc.com not found
Mailbox is not found	404	Mailbox not found