Rackspace Email Mobile Sync (Rest API)

From Rackspace Email & Apps API
Jump to: navigation, search

v1 - Current

Index

URL:

[GET] http://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/mobilesync/users


Description:

Returns a list of Mobile Sync users on the domain. This list contains all potential users of Mobile Sync and their current status (enabled/disabled).


Filter/Search:

Searches may be filtered by the 'name' property using query methods ?startsWith= or ?contains=.


Ordering

Searches may be ordered by any of their properties. You can order by multiple properties. Some examples are:

  •  ?order=Name%20asc (Order by name ascending)
  •  ?order=Enabled%20desc (Order by enabled descending)
  •  ?order[0]=Name%20desc&order[1]=Enabled%20asc (Order by name descending then enabled ascending)


Note: It is important to capitalize the first letter of the property.


Paging

Searches may be paged using ?size= and/or ?offset=. Some examples are:

  •  ?size=3 (Return a maximum of 3 results)
  •  ?offset=2 (Return results starting with the 3rd entry)
  •  ?size=5&offset=5 (Return 5 results starting with the 6th entry)


Remarks:

The index operation only supports the GET HTTP verb.


Example:

get '/customers/12345678/domains/example.com/mobilesync/users?startsWith=a&size=50&offset=100&order=Enabled%20asc'


XML Result Example:

<?xml version="1.0" encoding="utf-8"?>
<mobileSyncUserList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:mobileSyncUserList">
  <offset>100</offset>
  <size>50</size>
  <total>1000</total>
  <users>
    <user>
      <name>alex</name>
      <domain>example.com</domain>
      <enabled>false</enabled>
      <details></details>
    </user>
    <user>
      <name>ann</name>
      <domain>example.com</domain>
      <enabled>true</enabled>
      <details></details>
    </user>
  </users>
</mobileSyncUserList>


Json Result Example:

{"offset":100,"size":50,"total":1000,"users":[{"details":null,"domain":"example.com","enabled":false,"name":"alex"},{"details":null,"domain":"example.com","enabled":true,"name":"ann"}]}

Enable/Disable

URL:

Enable:  [POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/mobilesync/users/enable
Disable: [POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/mobilesync/users/disable


Description:

Enables or disables Mobile Sync for a list of users.


Special Considerations

  • Enabling Mobile Sync for a user will increase your monthly bill.
  • This is a throttled operation. Send as many users as you can at once instead of making the call multiple times, once per user.
  • The maximum number of users per request is 250.
Field Name Data Type Description
users String array Comma-separated list of user names to enable/disable


Example:

post '/customers/12345678/domains/example.com/mobilesync/users/enable',
{ 
  'users' => 'user1,user2,user3'
} 
post '/customers/12345678/domains/example.com/mobilesync/users/disable',
{ 
  'users' => 'user1,user2,user3'
}


Get Domain Auto-Provisioning Setting

URL:

[GET] http://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/mobilesync


Description:

Returns the status of domain auto-provisioning setting.


Example:

get '/customers/12345678/domains/example.com/mobilesync'


XML Result Example:

<?xml version="1.0" encoding="utf-8"?>
<mobileSyncDomainInfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:mobileSyncDomainInfo">
  <autoProvision>false</autoProvision>
</mobileSyncDomainInfo>


Json Result Example:

{"autoProvision":true}

Edit Domain Auto-Provisioning Setting

URL:

[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/mobilesync


Description:

Enables or disables Mobile Sync auto-provisioning for the whole domain.


Special Considerations

  • Enabling Mobile Sync auto-provisioning will add Mobile Sync to all existing Rackspace Email mailboxes on the domain. Any new Rackspace Email mailbox will have Mobile Sync as well.
  • Disabling Mobile Sync auto-provisioning will only prevent new mailboxes having Mobile Sync when they are created. It will not disable Mobile Sync for the existing mailboxes. New mailboxes can still add Mobile Sync later.


Field Name Data Type Description
autoProvision Boolean 'True' for enable and 'False' for disable


Example:

put '/customers/12345678/domains/example.com/mobilesync',
{ 
  'autoProvision' => 'True'
}