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

Revision as of 13:39, 9 January 2017

v1 - Current

Index

URL:

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

Description:

Shows a list of mailboxes under the domain

Filter/Search:

Mailbox searches may be filtered by the 'enabled' flag using query methods ?enabled=true and ?enabled=false.

Remarks:

The show operation only supports the GET HTTP verb.

Example:

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

XML Result Example:

<?xml version="1.0" encoding="utf-8"?>
<mailboxList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:mailboxList">
  <offset>0</offset>
  <size>50</size>
  <total>3</total>
  <mailboxes>
    <mailbox>
      <name>apiexmailbox55</name>
      <displayName>API Test</displayName>
    </mailbox>
    <mailbox>
      <name>apiexmailbox6</name>
      <displayName>API Test</displayName>
    </mailbox>
    <mailbox>
      <name>apiexmailbox90</name>
      <displayName>API Test</displayName>
    </mailbox>
  </mailboxes>
</mailboxList>

Json Result Example:

{"offset":0,"size":50,"total":3,"mailboxes":[{"name":"apiexmailbox55","displayName":"API Test"},{"name":"apiexmailbox6","displayName":"API Test"},{"name":"apiexmailbox90","displayName":"API Test"}]}

Custom Fields:

The result displays each mailbox's 'name' and 'displayName' as default. There is a query string 'fields' that allows the result to display more mailbox properties. The additional properties are: 'size', 'currentUsage', 'hasBlackBerryMobileService', 'hasActiveSyncMobileService'.

Example:

get '/customers/12345678/domains/example.com/ex/mailboxes?fields=size,currentUsage', 'text/xml'

Show

URL:

[GET] https://api.emailsrvr.com/v1/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.

The "samAccountName" is the logon name used to support clients and servers running older versions of the operating system.

Example:

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

XML Result Example:

<?xml version="1.0" encoding="utf-8"?>
<mailbox xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:mailbox">
  <name>apiexmailbox90</name>
  <displayName>API Test</displayName>
  <size>2048</size>
  <currentUsage>0</currentUsage>
  <isHidden>false</isHidden>
  <visibleInRackspaceEmailCompanyDirectory>false</visibleInRackspaceEmailCompanyDirectory>
  <isPublicFolderAdmin>true</isPublicFolderAdmin>
  <enabled>true</enabled>
  <lastLogin>2/12/2010 1:00:00 AM</lastLogin>
  <contactInfo>
    <firstName>API</firstName>
    <lastName>Test</lastName>
    <jobTitle>Dev</jobTitle>
    <company>My Company</company>
    <department>R&D</department>
    <businessNumber>111-1111</businessNumber>
    <homeNumber>222-2222</homeNumber>
    <mobileNumber>333-3333</mobileNumber>
    <faxNumber>444-4444</faxNumber>
    <pagerNumber>1234</pagerNumber>
    <addressLine1>123 Main Street</addressLine1>
    <city>Blacksburg</city>
    <state>VA</state>
    <zip>24060</zip>
    <country>USA</country>
    <notes>My Notes</notes>
    <customID>0123456789</customID>
  </contactInfo>
  <emailForwardingAddress>apiexmailbox8@apidomain24.com</emailForwardingAddress>
  <emailAddressList>
    <emailAddress>
      <address>apiexmailbox90@apidomain92.com</address>
      <replyTo>true</replyTo>
    </emailAddress>
  </emailAddressList>
  <hasBlackBerryMobileService>false</hasBlackBerryMobileService>
  <hasActiveSyncMobileService>false</hasActiveSyncMobileService>
  <samAccountName>apiexmailbox90_53B5B</samAccountName>
</mailbox>

Json Result Example:

{"name":"apiexmailbox90", "displayName":"API Test", "size":2048, "currentUsage":0, "isHidden":false, "isPublicFolderAdmin":true, "enabled":true, "lastLogin":"2\/12\/2006 1:00:00 AM", "contactInfo":{"firstName":"API", "lastName":"Test", "jobTitle":"Dev", "company":"My Company", "department":"R&D", "businessNumber":"111-1111", "homeNumber":"222-2222", "mobileNumber":"333-3333", "faxNumber":"444-4444", "pagerNumber":"1234", "addressLine1":"123 Main Street", "city":"Blacksburg", "state":"VA", "zip":"24060", "country":"USA", "notes":"My Notes", "customID":"0123456789"}, "emailForwardingAddress":"apiexmailbox8@apidomain24.com", "emailAddressList":[{"address":"apiexmailbox90@apidomain92.com", "replyTo":true}], "hasBlackBerryMobileService":false, "hasActiveSyncMobileService":false, "samAccountName":"apiexmailbox90_53B5B", "visibleInRackspaceEmailCompanyDirectory":false}

Add/Edit

URL:

Add: [POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(mailbox name)
Edit: [PUT] https://api.emailsrvr.com/v1/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.

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:

Delete

URL:

[DELETE] https://api.emailsrvr.com/v1/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'

Add Email Address

URL:

[POST] https://api.emailsrvr.com/v1/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'

Delete Email Address

URL:

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

Description:

Deletes the 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'

Spam Settings

See Exchange Mailbox Spam Settings.

Mailbox Permissions

Exchange mailboxes can be given permissions. A permission is defined as a tuple (mailbox, permissionType).

permissionType:= (SendAs | FullAccess | Both)

Index Permissions

URL:

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

Description:

Shows the current set of permissions granted on a user's mailbox.

Example:

get '/customers/100012/domains/enterpriseallservices.net/ex/mailboxes/jane.doe/permissions', 'text/xml'

XML Result Example:

<?xml version="1.0" encoding="utf-8"?>
<permissionList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:permissionList">
  <offset>0</offset>
  <size>50</size>
  <total>0</total>
  <permissions>
    <permission>
      <emailAddress>joe.schmoe@enterpriseallservices.net</emailAddress>
      <permissionType>fullAccess</permissionType>
    </permission>
  </permissions>
</permissionList>

Json Result Example:

{"offset":0,"size":50,"total":0,"permissions":[{"emailAddress":"joe.schmoe@enterpriseallservices.net","permissionType":"fullAccess"}]}

Comments: The above result shows the permission list for user Jane Doe's mailbox. The list contains one entry corresponding to that of user Joe Schmoe with permission type of "FullAccess".

Adding Permission

URL:

[POST] http://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(user1)/permissions/(user2)

Description:

Grants user2 the specified permission on mailbox of user1.

Example:

post '/customers/100012/domains/enterpriseallservices.net/ex/mailboxes/jane.doe/permissions/john.doe', {'permission' => 'fullAccess'}, 'text/xml'

Comments: The above result shows that on the mailbox of user Jane Doe, the user John Doe has been granted the permission of type "fullAccess".

Editing Permission

URL:

[PUT] http://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(user1)/permissions/(user2)

Description:

Modifies permission granted to user2 on the mailbox of user1.

Example:

put '/customers/100012/domains/enterpriseallservices.net/ex/mailboxes/jane.doe/permissions/john.doe', 
{'permission' => 'both'}, 'text/xml'

Comments: The permission granted to user John Doe on the mailbox of Jane Doe is modified to "both".

Deleting Permission

URL:

[DELETE] http://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
        /ex/mailboxes/(user1)/permissions/(user2)

Description:

Deletes permission granted to user2 on the mailbox of user1.

Example:

delete '/customers/100012/domains/enterpriseallservices.net/ex/mailboxes/jane.doe/permissions/john.doe', 'text/xml'

Comments: The permission granted to user John Doe on the mailbox of Jane Doe is deleted.

BlackBerry Mobile Service

Index

URL:

[GET] https://api.emailsrvr.com/v1/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.

Example:

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

XML Result Example:

<?xml version="1.0" encoding="utf-8"?>
<blackBerryMobileServiceList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns="urn:xml:blackBerryMobileServiceList">
  <offset>0</offset>
  <size>50</size>
  <total>3</total>
  <mailboxes>
    <mailbox>apiexmailbox36</mailbox>
    <mailbox>apiexmailbox66</mailbox>
    <mailbox>apiexmailbox85</mailbox>
  </mailboxes>
</blackBerryMobileServiceList>

Json Result Example:

{"offset":0,"size":50,"total":3,"mailboxes":["apiexmailbox36","apiexmailbox66","apiexmailbox85"]}

Add

URL:

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

Description:

Attaches a BlackBerry mobile service to the mailbox.

Example:

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

Errors:

Delete

URL:

[DELETE] https://api.emailsrvr.com/v1/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'

ActiveSync Mobile Service

Index

URL:

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

Description:

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

Remarks:

The index operation only supports the GET HTTP verb.

Example:

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

XML Result Example:

<?xml version="1.0" encoding="utf-8"?>
<activeSyncMobileServiceList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns="urn:xml:activeSyncMobileServiceList">
  <offset>0</offset>
  <size>50</size>
  <total>3</total>
  <mailboxes>
    <mailbox>apiexmailbox36</mailbox>
    <mailbox>apiexmailbox66</mailbox>
    <mailbox>apiexmailbox85</mailbox>
  </mailboxes>
</activeSyncMobileServiceList>

Json Result Example:

{"offset":0,"size":50,"total":3,"mailboxes":["apiexmailbox36","apiexmailbox66","apiexmailbox85"]}

Show

URL:

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

Description:

Returns the mailbox ActiveSync mobile service setup information to access Hosted Exchange 2007.

Remarks:

The index operation only supports the GET HTTP verb.

Example:

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

XML Result Example:

<?xml version="1.0" encoding="utf-8"?>
<activeSyncMobileService xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:activeSyncMobileService">
  <emailAddress>john.smith@example.com</emailAddress>
  <serverAddress>mex07A.emailsrvr.com</serverAddress>
  <userName>johnsmith1234</userName>
  <domainAddress>mex07A.mlsrvr.com</domainAddress>
</activeSyncMobileService>

Json Result Example:

{"emailAddress":"john.smith@example.com","serverAddress":"mex07A.emailsrvr.com","userName":"johnsmith1234","domainAddress":"mex07A.mlsrvr.com"}

Errors:

Add

URL:

[POST] https://api.emailsrvr.com/v1/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/activesyncmobileservice', 'text/xml', {}

Errors:

Delete

URL:

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

Description:

Detaches a ActiveSync mobile service from a mailbox.

Example:

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