Rackspace Mailbox (Rest API) - Revision history

Appscp: /* Add/Edit */ document displayName field

2017-01-24T16:38:53Z

‎Add/Edit: document displayName field

Appscp: remove accept header from examples to avoid confusion

2017-01-12T21:42:40Z

remove accept header from examples to avoid confusion

Appscp: /* v1 - Current */

2016-03-01T15:42:24Z

‎v1 - Current

Appscp at 20:00, 15 September 2015

2015-09-15T20:00:43Z

Appscp: /* Create Login Tokens */

2015-03-20T18:21:48Z

‎Create Login Tokens

Appscp: /* Create Login Tokens */

2015-03-20T18:20:00Z

‎Create Login Tokens

Appscp at 23:35, 21 January 2015

2015-01-21T23:35:24Z

Appscp at 18:38, 23 September 2014

2014-09-23T18:38:30Z

Appscp: v1 documentation

2013-12-04T22:22:47Z

v1 documentation

Appscp: /* Create Login Tokens */ added information about webmail mobile site token logins

2013-11-21T19:17:36Z

‎Create Login Tokens: added information about webmail mobile site token logins

@@ Line 304: / Line 304: @@
 | string
 | A person's middle initial
 |-
 | organizationUnit

@@ Line 28: / Line 28: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/rs/mailboxes', 'text/xml'
+get '/customers/12345678/domains/example.com/rs/mailboxes'
 </pre>
@@ Line 74: / Line 74: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/rs/mailboxes?fields=size,currentUsage', 'text/xml'
+get '/customers/12345678/domains/example.com/rs/mailboxes?fields=size,currentUsage'
 </pre>
@@ Line 95: / Line 95: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith', 'text/xml'
+get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith'
 </pre>
@@ Line 424: / Line 424: @@
 ''Example'':
 <pre>
-post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith', 'text/xml',
+post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith',
+{
    'password' => 'Secret13!@#',
@@ Line 465: / Line 465: @@
 ''Example'':
 <pre>
-put '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith', 'text/xml',
+put '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith',
+{
    'name' => 'alex.renamed'
@@ Line 488: / Line 488: @@
 ''Example'':
 <pre>
-delete '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith', 'text/xml'
+delete '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith'
 </pre>
@@ Line 511: / Line 511: @@
 <pre>
-post '/customers/460896/domains/testapidomain.net/rs/mailboxes/testmailbox/loginToken', {}, 'text/xml'
+post '/customers/460896/domains/testapidomain.net/rs/mailboxes/testmailbox/loginToken', {}
 </pre>

@@ Line 23: / Line 23: @@
 ''Remarks'':
-The show operation only supports the GET HTTP verb. For .xml format refer to the following schema document: [http://api.emailsrvr.com/Schemas/RSMailboxList.xsd RSMailboxList.xsd]
+The show operation only supports the GET HTTP verb.
@@ Line 91: / Line 91: @@
 ''Remarks'':
-The show operation only supports the GET HTTP verb. For .xml format refer to the following schema document: [http://api.emailsrvr.com/Schemas/RSMailbox.xsd RSMailbox.xsd]
+The show operation only supports the GET HTTP verb.
 ''Example'':

@@ Line 457: / Line 457: @@
    'visibleInRackspaceEmailCompanyDirectory' => 'false'
+}
 </pre>

← Older revision		Revision as of 18:21, 20 March 2015
Line 494:		Line 494:
	''Note:''		''Note:''

−	This route is not available to customers who access the Cloud Office Control Panel via my.rackspace.com and have an admin account w/ API keys.	+	This route is not available to customers who access the Cloud Office Control Panel via my.rackspace.com and have an admin account with API keys.

← Older revision		Revision as of 18:20, 20 March 2015
Line 490:		Line 490:

	Generate a login Token which can be used to log in to a user's mailbox. The POST will return a loginToken, created date, and expiration date.		Generate a login Token which can be used to log in to a user's mailbox. The POST will return a loginToken, created date, and expiration date.
		+
		+
		+	''Note:''
		+
		+	This route is not available to customers who access the Cloud Office Control Panel via my.rackspace.com and have an admin account w/ API keys.

@@ Line 53: / Line 53: @@
 ''Json Result Example'':
-{"offset":0,"size":50,"total":2,"rsMailboxes":[{"name":"apirsmailbox37"},{"name":"apirsmailbox91"}]}
+<pre>
@@ Line 145: / Line 156: @@
 ''Json Result Example'':
-''{"emailForwardingAddressList":["test@resellerallservices.net"],"enableVacationMessage":true,"enabled":true,"contactInfo":{"businessNumber":"555.123.0001" ,"faxNumber":"555.123.0005" ,"firstName":"Jimmy" ,"homeNumber":"555.123.0003" ,"lastName":"TestLaste" ,"mobileNumber":"555.123.0004" ,"notes":"This is my note about my mailbox." ,"pagerNumber":"555.123.0002" ,"businessCity":"" ,"businessCountry":"" ,"businessPostalCode":"" ,"businessState":"" ,"businessStreet":"" ,"employeeType":"DoesNotExist" ,"generationQualifier":"Jr" ,"homeCity":"" ,"homeCountry":"" ,"homeFaxNumber":"555.123.0006" ,"homePostalCode":"" ,"homeState":"" ,"homeStreet":"" ,"initials":"A" ,"organizationUnit":"IT" ,"organizationalStatus":"gainfully employed" ,"title":"My Title" ,"userID":"J.Test", "customID":"0123456789"},"name":"unittestexist" ,"saveForwardedEmail":false,"size":10240,"vacationMessage":"Test Vacation Message", "createdDate":"4\/10\/2006 7:47:34 PM", "currentUsage":1024, "visibleInExchangeGAL":false, "visibleInRackspaceEmailCompanyDirectory":false}''
+<pre>
 === Add/Edit ===
@@ Line 171: / Line 269: @@
 | positive integer
 | Mailbox size in megabytes (Required for Add)
 |-
 | enableVacationMessage
 | boolean
-| indicates whether vacation message has been enabled
+| Indicates whether vacation message has been enabled
 |-
 | vacationMessage

@@ Line 1: / Line 1: @@
 __TOC__
-== v0 - Current ==
+== v1 - Current ==
 === Index ===
@@ Line 7: / Line 7: @@
 ''URL'':
-  <nowiki>[GET] http://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
+  <nowiki>[GET] http://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
          /rs/mailboxes</nowiki>
@@ Line 69: / Line 69: @@
 ''URL'':
-  <nowiki>[GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
+  <nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
          /rs/mailboxes/(mailbox name)</nowiki>
@@ Line 150: / Line 150: @@
 ''URL'':
-  <nowiki>Add: [POST] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
+  <nowiki>Add: [POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
          /rs/mailboxes/(mailbox name)
-Edit: [PUT] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
+Edit: [PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
          /rs/mailboxes/(mailbox name)</nowiki>
@@ Line 360: / Line 360: @@
 === Delete ===
 ''URL'':
-  <nowiki>[DELETE] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
+  <nowiki>[DELETE] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
              /rs/mailboxes/(mailbox name)</nowiki>

@@ Line 418: / Line 418: @@
 Using the above created login token a user can SSO into testmailbox@testapidomain.net using the following URL:
 <pre>
@@ Line 424: / Line 423: @@
 </pre>
-Alternatively, http can be used if SSL is not desired.
+Alternatively, the login token can be used to SSO into the webmail mobile site using the following URL: