Overview

Data formats

Some data formats need some clarification and are not obvious from the API itself.

Timestamps

Timestamps are in milliseconds since 01/01/1970 UTC +0:00.

URLs

URLs can be either an absolute URL or an absolute URL path. In case of an absolute URL path the client is expected to prepend the configured scheme and hostname.

User agents

To be able to distinguish different mail clients in the facade all clients must send a specific user agent. This user agent is build up with a branding identifier, an OS identifier, a string identifying the type of client, a version of the client, version information about the operating system running on and the name of the device running on.

The complete user agent has the format:

{branding name}.{OS identifier}.Mail/{client version} (OS: {OS version}; device: {device identifier})

The default branding name is OpenXchange.

The OS specific identifier is a short string as described in the following table.

Platform OS identifier

Android

Android

iOS

iOS

OS X

OSX

Windows

Windows

Windows 10 Mobile

WP

Swagger

Swagger

If your client is not listed in the above table please contact the facade developers.

Version numbers are in semantic versioning scheme.

Examples are

OpenXchange.Android.Mail/1.0+1234 (OS: 7.0; device: Samsung/GT9700)
OpenXchange.iOS.Mail/1.0.3 (OS: 10.0.3; device: iPhone 7 Plus)

Error codes

In general the errors are delegated from the middleware to the facade. The facade wraps them in a common format and sends them to the client. The error codes for errors returned by the middleware can be found at https://oxpedia.org/wiki/index.php?title=Error_list.

The facade itself provides the following error codes:

Code Information

1

Invalid credentials

2

Missing header

3

Missing parameter

4

Missing cookie

5

Invalid User-Agent header

900

Client too old

999

Internal server error

The response is a JSON string with two string fields: - error (contains the error code created by the middleware or the facade) - message (further information regarding the occured error)

Version information

Version : 0.0.1

Contact information

Contact : Open-Xchange GmbH
Contact Email : info@open-xchange.com

URI scheme

Host : facade.open-xchange.com
BasePath : /services/api-facade/
Schemes : HTTPS

Tags

  • authentication

  • accounts & folders

  • config

  • contacts

  • mails

  • mail actions

  • mail flag actions

  • version

Consumes

  • application/json

Produces

  • application/json

Resources

Accounts & Folders

Creates a folder.

POST /v1/folders
Description

This request creates a new folder. You need to give it the ID of the parent folder and the name of the folder to create.

Not all names for folders are allowed, allowed names are middleware specific. Requests with not allowed names return a failure.

Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object.

FolderCreateRequestBody

Responses
HTTP Code Description Schema

201

The folder has been successfully created.

CreateFolderResponseBody

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Deletes a folders.

DELETE /v1/folders
Description

This request deletes a given folder

Standard folders are not allowed to get deleted.

Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object.

FolderRequestBody

Responses
HTTP Code Description Schema

200

The folder has been successfully created.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Deletes all mails in a given folder.

DELETE /v1/folders/clear
Description

This request deletes all mails in a given folder and depending on configuration moves to the trash folder. If the trash folder is cleared the mails are permanently deleted.

Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object.

FolderRequestBody

Responses
HTTP Code Description Schema

200

The mails in the given folder are deleted.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Returns all mail folders.

GET /v1/folders/mail
Description

This request returns all accounts together with the mail folders in them.

Parameters
Type Name Description Schema Default

Header

If-None-Match
optional

The caching key previously returned in an ETag header.

string

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Responses
HTTP Code Description Schema

200

A JSON object.
Headers :
ETag (string) : Used as a caching key for future requests.

AccountsResponseBody

304

The data don’t changed since the last request.
Headers :
ETag (string) : Used as a caching key for future requests.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Checks if there are new mails in a given mail folders.

GET /v1/folders/mail/checknew
Description

This request does an EXAMINE call on the mail backend and checks if there are new mails in a specific folder. It returns the current UIDVALIDITY and NEXT value returned by the EXAMINE request.

Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object.

ExamineFolderRequestBody

Responses
HTTP Code Description Schema

200

There are new mails available. A JSON object with the new UIDVALIDITY and NEXT is returned.

ExamineFolderResponseBody

304

There are no new mails available. A JSON object with the old UIDVALIDITY and NEXT is returned.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Authentication

Authenticates the user.

POST /v1/auth/login
Description

This request performs the authentication for the user.

Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Body

body
required

A JSON object.

AuthenticationRequestBody

Responses
HTTP Code Description Schema

200

A JSON object.

SessionData

400

The request failed.

Error

401

The Login failed.

Error

500

An internal server error occured.

Error

Invalidates the session.

POST /v1/auth/logout
Description

This request performs the logout for the user.

Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Responses
HTTP Code Description Schema

200

The session has been deleted.

No Content

403

The session could not be deleted.

No Content

500

An internal server error occured.

Error

Config

Retrieves the configuration values for the user.

GET /v1/config
Description

This request returns an object with all the configuration values for the user.

Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Responses
HTTP Code Description Schema

200

The configuration values wrappen in an object.

ConfigResponseBody

Contacts

Retrieves all contacts.

GET /v1/contacts
Description

This request returns a list of all contacts a user knowns. These might be real contacts or distribution lists.

Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Responses
HTTP Code Description Schema

200

The list of contacts is successfully returned.

No Content

Mail Actions

Sets colors of mails.

POST /v1/mails/color
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object describing colors to set for specific mails in a given folder.

SetColorsRequestBody

Responses
HTTP Code Description Schema

200

The color has been set to all respective mails.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Deletes mails in a specific folder.

DELETE /v1/mails/delete
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object.

DeleteMailsRequestBody

Responses
HTTP Code Description Schema

200

The mails are deleted.

DeleteMailsResponseBody

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Moves mails to a specific folder.

POST /v1/mails/move
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object.

MoveMailsRequestBody

Responses
HTTP Code Description Schema

200

On success this endpoint returns the list of new IDs for the moved mails.

MailIdsResponseBody

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Mail Flag Actions

Sets the 'answered' flag for a set of mails in a specific folder.

POST /v1/mails/flags/answered
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object describing for which mails flags has to be set or cleared in a given folder.

SetAndClearFlagsRequestBody

Responses
HTTP Code Description Schema

200

The flag has been set in all respective mails.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Clears the 'answered' flag for a set of mails in a specific folder.

DELETE /v1/mails/flags/answered
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object describing for which mails flags has to be set or cleared in a given folder.

SetAndClearFlagsRequestBody

Responses
HTTP Code Description Schema

200

The flag has been cleared in all respective mails.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Sets the 'deleted' flag for a set of mails in a specific folder.

POST /v1/mails/flags/deleted
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object describing for which mails flags has to be set or cleared in a given folder.

SetAndClearFlagsRequestBody

Responses
HTTP Code Description Schema

200

The flag has been set in all respective mails.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Clears the 'deleted' flag for a set of mails in a specific folder.

DELETE /v1/mails/flags/deleted
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object describing for which mails flags has to be set or cleared in a given folder.

SetAndClearFlagsRequestBody

Responses
HTTP Code Description Schema

200

The flag has been cleared in all respective mails.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Sets the 'draft' flag for a set of mails in a specific folder.

POST /v1/mails/flags/draft
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object describing for which mails flags has to be set or cleared in a given folder.

SetAndClearFlagsRequestBody

Responses
HTTP Code Description Schema

200

The flag has been set in all respective mails.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Clears the 'draft' flag for a set of mails in a specific folder.

DELETE /v1/mails/flags/draft
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object describing for which mails flags has to be set or cleared in a given folder.

SetAndClearFlagsRequestBody

Responses
HTTP Code Description Schema

200

The flag has been cleared in all respective mails.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Sets the 'flagged' flag for a set of mails in a specific folder.

POST /v1/mails/flags/flagged
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object describing for which mails flags has to be set or cleared in a given folder.

SetAndClearFlagsRequestBody

Responses
HTTP Code Description Schema

200

The flag has been set in all respective mails.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Clears the 'flagged' flag for a set of mails in a specific folder.

DELETE /v1/mails/flags/flagged
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object describing for which mails flags has to be set or cleared in a given folder.

SetAndClearFlagsRequestBody

Responses
HTTP Code Description Schema

200

The flag has been cleared in all respective mails.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Sets the 'forwarded' flag for a set of mails in a specific folder.

POST /v1/mails/flags/forwarded
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object describing for which mails flags has to be set or cleared in a given folder.

SetAndClearFlagsRequestBody

Responses
HTTP Code Description Schema

200

The flag has been set in all respective mails.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Clears the 'forwarded' flag for a set of mails in a specific folder.

DELETE /v1/mails/flags/forwarded
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object describing for which mails flags has to be set or cleared in a given folder.

SetAndClearFlagsRequestBody

Responses
HTTP Code Description Schema

200

The flag has been cleared in all respective mails.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Sets the 'unread' flag for a set of mails in a specific folder.

POST /v1/mails/flags/unread
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object describing for which mails flags has to be set or cleared in a given folder.

SetAndClearFlagsRequestBody

Responses
HTTP Code Description Schema

200

The flag has been set in all respective mails.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Clears the 'unread' flag for a set of mails in a specific folder.

DELETE /v1/mails/flags/unread
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object describing for which mails flags has to be set or cleared in a given folder.

SetAndClearFlagsRequestBody

Responses
HTTP Code Description Schema

200

The flag has been cleared in all respective mails.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Mails

Returns all mail data for specific mails.

POST /v1/mails/complete
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object.

MailRequestBody

Responses
HTTP Code Description Schema

200

A JSON object.

MailsResponseBody

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Returns envelopa data for specific mails.

POST /v1/mails/envelopes
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object.

MailsRequestBody

Responses
HTTP Code Description Schema

200

A JSON object.

EnvelopesResponseBody

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Returns stubs for a specific mail folder.

POST /v1/mails/stubs
Description

All mails are returned in pre-calculated MailThreadCto objects.

When using this request a field validity containing the IMAP UIDVALIDITY value and a field next containing the IMAP NEXT value.

With the validity the client can make sure the folder he retrieved with the given folder ID is still the same folder. If the validity in the response is different to a previously retrieved validity this means this is a new completely new folder with the same name and ID. All clients need to delete all local data about this folder and completely sync it again.

The clients also need to store next value locally. If the newly retrieved next value is different to a previously retrieved value this means that the folder contains new mails which are not retrieved yet.

State changes (flags, color) are only available in the retrieved stubs. There is no indicator that these changed. All stubs need to be checked for changed.

Parameters
Type Name Description Schema Default

Header

If-None-Match
optional

The caching key previously returned in an ETag header.

string

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object.

StubsRequestBody

Responses
HTTP Code Description Schema

200

A JSON object.
Headers :
ETag (string) : Used as a caching key for future requests.

MailThreadsResponseBody

304

The data don’t changed since the last request.
Headers :
ETag (string) : Used as a caching key for future requests.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Push

Subscribe to push events.

POST /v1/push/subscribe
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object describing the content needed for subscribing to push messaging.

PushSubscribeRequestBody

Responses
HTTP Code Description Schema

200

Subscribing was successful

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Unsubscribe from push events.

POST /v1/push/unsubscribe
Parameters
Type Name Description Schema Default

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object describing the content needed for unsubscribing from push messaging.

PushUnsubscribeRequestBody

Responses
HTTP Code Description Schema

200

Unsubscribing was successful

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Users

Returns user data for the current user.

GET /v1/users/current
Description

Returns information about the currently logged in user. This contains things like display name, email address, avatar image url, etc.

Parameters
Type Name Description Schema Default

Header

If-None-Match
optional

The caching key previously returned in an ETag header.

string

Header

User-Agent
required

A user agent string.

string

"OpenXchange.Swagger.Mail/2.0.0 (device: unknown, OS: unknown)"

Header

X-Session
required

A session ID previously obtained from the login module.

string

Responses
HTTP Code Description Schema

200

A JSON object.
Headers :
ETag (string) : Used as a caching key for future requests.

UserResponseBody

304

The data don’t changed since the last request.
Headers :
ETag (string) : Used as a caching key for future requests.

No Content

400

The request failed.

Error

401

The Session is invalid.

Error

500

An internal server error occured.

Error

Version

Retrieve version information about the running system.

GET /v1/version
Description

This endpoint can be enabled/disabled in the configuration. By default its disabled.

Responses
HTTP Code Description Schema

200

The version information.

VersionResponseBody

Definitions

AccountCto

Name Description Schema

accountName
required

string

aliases
optional

< AliasCto > array

firstName
optional

string

folders
optional

< FolderCto > array

id
required

string

lastName
optional

string

primaryAddress
required

string

standardFolders
optional

StandardFoldersCto

userName
optional

string

AccountsResponseBody

Name Description Schema

accounts
optional

< AccountCto > array

AliasCto

Name Description Schema

address
required

string

AttachmentCto

Name Description Schema

cid
optional

string

content
optional

string

contentType
required

string

disposition
optional

string

downloadUrl
optional

string

filename
optional

string

id
required

string

size
required

This is an estimated value. The real value can vary.

integer

truncated
optional

boolean

AuthenticationRequestBody

Name Description Schema

password
required

Default : "secret"

string

username
required

string

ConfigResponseBody

Name Description Schema

deleteDraftOnTransport
optional

Tells whether a draft mail is automatically purged when the mail gets sent. Not present or false means mails are not purged from the drafts folder.

boolean

maxUploadAttachmentSize
optional

The maximum size of an attachment when sending a mail in bytes after encoding it to Base64. Not present means unlimited.

integer

maxUploadSize
optional

The maximum size of the HTTP request body when uploading data to the server in bytes. Not present means unlimited.

integer

purgeOnDeletion
optional

Tells whether a mail is directly purged on deletion, or moved into the trash folder. Not present or false means mails are moved to trash.

boolean

ContactCto

Name Description Schema

displayName
optional

string

distributionList
optional

DistributionEntryCto

email1
optional

string

email2
optional

string

email3
optional

string

firstName
optional

string

lastName
optional

string

CreateFolderResponseBody

Name Description Schema

folderId
optional

string

name
optional

string

CreateMailsResponseBody

Name Description Schema

folderId
optional

string

mailId
optional

string

DeleteMailsRequestBody

Name Description Schema

folderId
required

Default : "default0/INBOX"

string

mailIds
required

< string > array

purge
optional

Default : false

boolean

DeleteMailsResponseBody

Name Description Schema

mailIds
optional

< string > array

trashFolderId
optional

string

DistributionEntryCto

Name Description Schema

displayName
optional

string

email
required

string

EnvelopeCto

Name Description Schema

bcc
optional

< MailContactCto > array

cc
optional

< MailContactCto > array

color
optional

integer

flags
optional

MailFlagsCto

from
optional

< MailContactCto > array

id
required

string

receivedDate
required

The date in milliseconds since 01/01/1970, UTC.

integer(int64)

sentDate
required

The date in milliseconds since 01/01/1970, UTC.

integer(int64)

subject
optional

string

to
optional

< MailContactCto > array

EnvelopesResponseBody

Name Description Schema

mails
optional

< EnvelopeCto > array

Error

Name Description Schema

error
required

the internal error code

string

message
required

further information regarding the sent error

string

ExamineFolderRequestBody

Name Description Schema

folderId
required

Default : "default0/INBOX"

string

next
required

string

validity
required

string

ExamineFolderResponseBody

Name Description Schema

next
required

string

validity
required

string

FolderCreateRequestBody

Name Description Schema

name
required

string

parentFolderId
required

Default : "default0/INBOX"

string

FolderCto

Name Description Schema

id
required

string

name
required

string

next
optional

the NEXT value of the folder

string

parentId
optional

string

total
optional

the total number of mails in this folder

integer

type
required

Type is either an identifier for a standard folder, which are all private or it indicates the global visibility level of a folder.

Possible values are DRAFT, SENT, SPAM, TRASH, INBOX, PRIVATE, SHARED, PUBLIC. As fallback UNKNOWN will be set.

string

unread
optional

the number of unread mails in this folder

integer

validity
optional

The UIDVALIDITY value of the folder

string

FolderRequestBody

Name Description Schema

folderId
required

Default : "default0/INBOX"

string

MailContactCto

Name Description Schema

address
required

string

name
optional

string

MailCto

Name Description Schema

attachments
optional

< AttachmentCto > array

bcc
optional

< MailContactCto > array

body
optional

string

bodyType
optional

string

cc
optional

< MailContactCto > array

color
optional

integer

contentType
optional

string

flags
optional

MailFlagsCto

from
optional

< MailContactCto > array

id
required

string

messageId
optional

string

priority
optional

enum (noPriority, veryHigh, high, medium, low, veryLow)

realAttachment
optional

boolean

receivedDate
required

The date in milliseconds since 01/01/1970, UTC.

integer(int64)

replyTo
optional

< MailContactCto > array

sentDate
required

The date in milliseconds since 01/01/1970, UTC.

integer(int64)

size
optional

integer(int64)

subject
optional

string

teaser
optional

string

to
optional

< MailContactCto > array

MailFlagsCto

Name Description Schema

answered
optional

Default : false

boolean

deleted
optional

Default : false

boolean

draft
optional

Default : false

boolean

flagged
optional

Default : false

boolean

forwarded
optional

Default : false

boolean

recent
optional

Default : false

boolean

spam
optional

Default : false

boolean

unread
optional

Default : false

boolean

user
optional

Default : false

boolean

MailIdsResponseBody

Name Description Schema

mailIds
optional

< string > array

MailRequestBody

Name Description Schema

folderId
required

Default : "default0/INBOX"

string

mailId
required

string

maximumTeaserLength
optional

integer

MailThreadCto

Name Description Schema

latestMailId
required

string

latestReceivedDate
required

The date in milliseconds since 01/01/1970, UTC.

integer(int64)

mails
optional

< StubCto > array

rootMailId
required

string

MailThreadsResponseBody

Name Description Schema

threads
optional

< MailThreadCto > array

MailsRequestBody

Name Description Schema

folderId
required

Default : "default0/INBOX"

string

mailIds
required

< string > array

MailsResponseBody

Name Description Schema

mails
optional

< MailCto > array

MoveMailsRequestBody

Name Description Schema

folderId
required

Default : "default0/INBOX"

string

mailIds
required

< string > array

targetFolderId
required

string

PushSubscribeRequestBody

Name Description Schema

token
required

string

topics
required

< enum (mail) > array

transport
required

enum (apn, gcm, wns)

PushUnsubscribeRequestBody

Name Description Schema

token
required

string

topics
optional

< enum (mail) > array

transport
required

enum (apn, gcm, wns)

SessionData

Name Description Schema

session
optional

string

SetAndClearFlagsRequestBody

Name Description Schema

folderId
required

Default : "default0/INBOX"

string

mailIds
required

< string > array

SetColorsRequestBody

Name Description Schema

color
required

integer

folderId
required

Default : "default0/INBOX"

string

mailIds
required

< string > array

StandardFoldersCto

Name Description Schema

archiveId
optional

string

draftsId
optional

string

inboxId
optional

string

sentId
optional

string

spamId
optional

string

trashId
optional

string

StubCto

Name Description Schema

color
optional

integer

flags
optional

MailFlagsCto

id
required

string

level
optional

integer

receivedDate
required

The date in milliseconds since 01/01/1970, UTC.

integer(int64)

StubsRequestBody

Name Description Schema

folderId
required

Default : "default0/INBOX"

string

threaded
optional

Default : true

boolean

UserResponseBody

Name Description Schema

displayName
optional

string

firstName
optional

string

image
optional

string

imageType
optional

string

lastName
optional

string

VersionResponseBody

Name Description Schema

commitHash
optional

string

middlewareVersion
optional

string

version
optional

string