Skip to content

In-mail Service v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

In mail microservice

Base URLs:

Authentication

  • HTTP Authentication, scheme: bearer

OriginatorController

API provides an interface for restore message from trash.

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
const inputBody = '{
  "messageIds": [
    "string"
  ],
  "threadIds": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/mails/bulk/restore',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
const fetch = require('node-fetch');
const inputBody = {
  "messageIds": [
    "string"
  ],
  "threadIds": [
    "string"
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/mails/bulk/restore',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /mails/bulk/restore

Permissions
RestoreMail
10

Body parameter

1
2
3
4
5
6
7
8
{
  "messageIds": [
    "string"
  ],
  "threadIds": [
    "string"
  ]
}

Parameters

Name In Type Required Description
filter query object false none
body body IdArraysPartial false none

Responses

Status Meaning Description Schema
200 OK Restore Message Successful! None
400 Bad Request Message identity does not exist. None
403 Forbidden Forbidden request due to unauthorized token in header. None

API for moving mails to trash and then delete

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
const inputBody = '{
  "messageIds": [
    "string"
  ],
  "threadIds": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/mails/bulk/{storage}/{action}',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
const fetch = require('node-fetch');
const inputBody = {
  "messageIds": [
    "string"
  ],
  "threadIds": [
    "string"
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/mails/bulk/{storage}/{action}',
{
  method: 'DELETE',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /mails/bulk/{storage}/{action}

Permissions
TrashMail
9

Body parameter

1
2
3
4
5
6
7
8
{
  "messageIds": [
    "string"
  ],
  "threadIds": [
    "string"
  ]
}

Parameters

Name In Type Required Description
storage path string true none
action path string true none
filter query object false none
body body IdArraysPartial false none

Responses

Status Meaning Description Schema
200 OK Trash/Deletion of Mail(s) sucessful! None
403 Forbidden Forbidden request due to unauthorized token in header. None
404 Not Found Message identity does not exist. None

API provides interface to mark read, unread and important

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
const inputBody = '{
  "messageIds": [
    "string"
  ],
  "threadIds": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/mails/marking/{markType}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
const fetch = require('node-fetch');
const inputBody = {
  "messageIds": [
    "string"
  ],
  "threadIds": [
    "string"
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/mails/marking/{markType}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /mails/marking/{markType}

Permissions
UpdateMail
2

Body parameter

1
2
3
4
5
6
7
8
{
  "messageIds": [
    "string"
  ],
  "threadIds": [
    "string"
  ]
}

Parameters

Name In Type Required Description
markType path string true none
body body IdArraysPartial false none

Responses

Status Meaning Description Schema
200 OK Message is marked read/unread/important None

API provides an interface for removing attachment before message is sent

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/mails/{messageId}/attachments/{attachmentId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/mails/{messageId}/attachments/{attachmentId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /mails/{messageId}/attachments/{attachmentId}

Permissions
DeleteAttachment
14

Parameters

Name In Type Required Description
messageId path string true none
attachmentId path string true none
filter query object false none

Responses

Status Meaning Description Schema
200 OK Deletetion of Attachment Successful! None
403 Forbidden Forbidden request due to unauthorized token in header. None
404 Not Found Message identity does not exist. None

API provides an interface for adding attachment before message is sent.

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
const inputBody = '{
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/mails/{messageId}/attachments',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
const fetch = require('node-fetch');
const inputBody = {
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/mails/{messageId}/attachments',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /mails/{messageId}/attachments

Permissions
AddAttachments
4

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ]
}

Parameters

Name In Type Required Description
messageId path string true none
filter query object false none
body body object false none
» attachments body [AttachmentPartial] false [(tsType: Partial, schemaOptions: { partial: true })]
»» AttachmentPartial body AttachmentPartial false (tsType: Partial, schemaOptions: { partial: true })
»»» deleted body boolean false none
»»» deletedOn body string(date-time)¦null false none
»»» deletedBy body string¦null false none
»»» createdOn body string(date-time) false none
»»» modifiedOn body string(date-time) false none
»»» createdBy body string false none
»»» modifiedBy body string false none
»»» id body string false none
»»» name body string false none
»»» path body string false none
»»» thumbnail body string false none
»»» mime body string false none
»»» extId body string false none
»»» extMetadata body object false none
»»» messageId body string false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "items": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK collect single attachment for user by message identifier Attachment add response schema
400 Bad Request Message identity does not exist. None
403 Forbidden Forbidden request due to unauthorized token in header. None

API for sending a drafted message.

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/mails/{messageId}/send',
{
  method: 'PATCH',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/mails/{messageId}/send',
{
  method: 'PATCH',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /mails/{messageId}/send

Permissions
ComposeMail
1

Parameters

Name In Type Required Description
messageId path string true none
filter query object false none

Responses

Status Meaning Description Schema
200 OK Mail is Successfully sent! None
400 Bad Request Message identity does not exist. None
403 Forbidden Forbidden request due to unauthorized token in header. None

Update API. Update draft messages.

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
const inputBody = '{
  "threadId": "string",
  "groups": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "party": "string",
      "type": "from",
      "isImportant": true,
      "storage": "draft",
      "visibility": "read",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string",
      "threadId": "string"
    }
  ],
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "meta": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "key": "string",
      "value": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "body": "string",
  "subject": "string",
  "status": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/mails/{messageId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
const fetch = require('node-fetch');
const inputBody = {
  "threadId": "string",
  "groups": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "party": "string",
      "type": "from",
      "isImportant": true,
      "storage": "draft",
      "visibility": "read",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string",
      "threadId": "string"
    }
  ],
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "meta": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "key": "string",
      "value": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "body": "string",
  "subject": "string",
  "status": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/mails/{messageId}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /mails/{messageId}

Permissions
UpdateMail
2

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
{
  "threadId": "string",
  "groups": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "party": "string",
      "type": "from",
      "isImportant": true,
      "storage": "draft",
      "visibility": "read",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string",
      "threadId": "string"
    }
  ],
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "meta": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "key": "string",
      "value": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "body": "string",
  "subject": "string",
  "status": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
messageId path string true none
body body composeMailBody false none

Example responses

Responses

Status Meaning Description Schema
400 Bad Request Message identity does not exist. None
403 Forbidden Forbidden request due to unauthorized token in header. None
application/json Unknown collect single message for user by message identifier None

Response Schema

ComposeAPI. For drafting, reply on and create new message

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
const inputBody = '{
  "threadId": "string",
  "groups": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "party": "string",
      "type": "from",
      "isImportant": true,
      "storage": "draft",
      "visibility": "read",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string",
      "threadId": "string"
    }
  ],
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "meta": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "key": "string",
      "value": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "body": "string",
  "subject": "string",
  "status": "string",
  "extId": "string",
  "extMetadata": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/mails',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
const fetch = require('node-fetch');
const inputBody = {
  "threadId": "string",
  "groups": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "party": "string",
      "type": "from",
      "isImportant": true,
      "storage": "draft",
      "visibility": "read",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string",
      "threadId": "string"
    }
  ],
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "meta": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "key": "string",
      "value": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "body": "string",
  "subject": "string",
  "status": "string",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/mails',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /mails

Permissions
ComposeMail
1

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
{
  "threadId": "string",
  "groups": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "party": "string",
      "type": "from",
      "isImportant": true,
      "storage": "draft",
      "visibility": "read",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string",
      "threadId": "string"
    }
  ],
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "meta": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "key": "string",
      "value": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "body": "string",
  "subject": "string",
  "status": "string",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
body body composeMailBody false none

Example responses

Responses

Status Meaning Description Schema
201 Created collect single message for user by message identifier None
403 Forbidden Forbidden request due to unauthorized token in header. None
404 Not Found Message identity does not exist. None

Response Schema

CollectorController

GET Message API. Collect a single message based on message identity.

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/mails/{messageId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/mails/{messageId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /mails/{messageId}

Permissions
GetInMail
8

Parameters

Name In Type Required Description
messageId path string true none
filter query object false none

Example responses

200 Response

1
2
3
{
  "item": "string"
}

Responses

Status Meaning Description Schema
200 OK Gets mail details based on unique message id Inline
403 Forbidden Forbidden request due to unauthrized token in header. None
404 Not Found Message identity does not exist None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» item string false none none

Collect a list of all messages.

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/mails',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/mails',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /mails

Permissions
GetInMails
7

Parameters

Name In Type Required Description
messageFilter query object false none
groupFilter query object false none

Example responses

Responses

Status Meaning Description Schema
200 OK fetch mails None
403 Forbidden Forbidden request due to unauthrized token in header. None

Response Schema

GET Thread Message API. Collect complete single message thread based on thread identity.

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/threads/{threadId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/threads/{threadId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /threads/{threadId}

Permissions
GetThread
6

Parameters

Name In Type Required Description
threadId path string true none
filter query object false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "item": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "subject": "string",
    "messageCounts": 0,
    "extId": "string",
    "extMetadata": {}
  }
}

Responses

Status Meaning Description Schema
200 OK Fetches a thread along with message, group, attachment(s) etc based on unique thread Id Inline
400 Bad Request Message identity does not exist None
403 Forbidden Forbidden request due to unauthorized token in header. None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» item Thread false none none
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» subject string true none none
»» messageCounts number false none none
»» extId string false none none
»» extMetadata object false none none

Thread List API. Collect a list of all threads.

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/threads',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/threads',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /threads

Permissions
GetThread
6

Parameters

Name In Type Required Description
threadFilter query object false none
groupFilter query object false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
  "version": "string",
  "items": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "subject": "string",
      "messageCounts": 0,
      "extId": "string",
      "extMetadata": {}
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK fetch threads Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» version string false none none
» items [Thread] false none none
»» Thread Thread false none none
»»» deleted boolean false none none
»»» deletedOn string(date-time)¦null false none none
»»» deletedBy string¦null false none none
»»» createdOn string(date-time) false none none
»»» modifiedOn string(date-time) false none none
»»» createdBy string false none none
»»» modifiedBy string false none none
»»» id string false none none
»»» subject string true none none
»»» messageCounts number false none none
»»» extId string false none none
»»» extMetadata object false none none

ReplyAndForwardController

API provides interface to forward single message.

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
const inputBody = '{
  "groups": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "party": "string",
      "type": "from",
      "isImportant": true,
      "storage": "draft",
      "visibility": "read",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string",
      "threadId": "string"
    }
  ],
  "subject": "string",
  "body": "string",
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "meta": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "key": "string",
      "value": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "status": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/threads/{threadId}/forward',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
const fetch = require('node-fetch');
const inputBody = {
  "groups": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "party": "string",
      "type": "from",
      "isImportant": true,
      "storage": "draft",
      "visibility": "read",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string",
      "threadId": "string"
    }
  ],
  "subject": "string",
  "body": "string",
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "meta": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "key": "string",
      "value": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "status": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/threads/{threadId}/forward',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /threads/{threadId}/forward

Permissions
ComposeMail
1

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
{
  "groups": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "party": "string",
      "type": "from",
      "isImportant": true,
      "storage": "draft",
      "visibility": "read",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string",
      "threadId": "string"
    }
  ],
  "subject": "string",
  "body": "string",
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "meta": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "key": "string",
      "value": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "status": "string"
}

Parameters

Name In Type Required Description
threadId path string true none
body body object false none
» groups body [GroupPartial] true [(tsType: Partial, schemaOptions: { partial: true })]
»» GroupPartial body GroupPartial false (tsType: Partial, schemaOptions: { partial: true })
»»» deleted body boolean false none
»»» deletedOn body string(date-time)¦null false none
»»» deletedBy body string¦null false none
»»» createdOn body string(date-time) false none
»»» modifiedOn body string(date-time) false none
»»» createdBy body string false none
»»» modifiedBy body string false none
»»» id body string false none
»»» party body string false none
»»» type body string false none
»»» isImportant body boolean false none
»»» storage body string false none
»»» visibility body string false none
»»» extId body string false none
»»» extMetadata body object false none
»»» messageId body string false none
»»» threadId body string false none
» subject body string false none
» body body string false none
» attachments body [AttachmentPartial] false [(tsType: Partial, schemaOptions: { partial: true })]
»» AttachmentPartial body AttachmentPartial false (tsType: Partial, schemaOptions: { partial: true })
»»» deleted body boolean false none
»»» deletedOn body string(date-time)¦null false none
»»» deletedBy body string¦null false none
»»» createdOn body string(date-time) false none
»»» modifiedOn body string(date-time) false none
»»» createdBy body string false none
»»» modifiedBy body string false none
»»» id body string false none
»»» name body string false none
»»» path body string false none
»»» thumbnail body string false none
»»» mime body string false none
»»» extId body string false none
»»» extMetadata body object false none
»»» messageId body string false none
» meta body [MetaPartial] false [(tsType: Partial, schemaOptions: { partial: true })]
»» MetaPartial body MetaPartial false (tsType: Partial, schemaOptions: { partial: true })
»»» deleted body boolean false none
»»» deletedOn body string(date-time)¦null false none
»»» deletedBy body string¦null false none
»»» createdOn body string(date-time) false none
»»» modifiedOn body string(date-time) false none
»»» createdBy body string false none
»»» modifiedBy body string false none
»»» id body string false none
»»» key body string false none
»»» value body string false none
»»» extId body string false none
»»» extMetadata body object false none
»»» messageId body string false none
» status body string false none

Enumerated Values

Parameter Value
»»» type from
»»» type to
»»» type cc
»»» type bcc
»»» storage draft
»»» storage send
»»» storage inbox
»»» storage trash
»»» visibility read
»»» visibility new
»»» visibility unread
»»» visibility important
»»» visibility not-important

Example responses

Responses

Status Meaning Description Schema
204 No Content Message is forwarded to another recipient None
400 Bad Request Message identity does not exist. None
403 Forbidden Forbidden request due to unauthorized token in header. None

Response Schema

API provides interface to reply to a single message

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
const inputBody = '{
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "meta": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "key": "string",
      "value": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "body": "string",
  "subject": "string",
  "status": "string",
  "extId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/threads/{threadId}/mails/{messageId}/replies',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
const fetch = require('node-fetch');
const inputBody = {
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "meta": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "key": "string",
      "value": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "body": "string",
  "subject": "string",
  "status": "string",
  "extId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/threads/{threadId}/mails/{messageId}/replies',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /threads/{threadId}/mails/{messageId}/replies

Permissions
ReplyMail
3

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
{
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "meta": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "key": "string",
      "value": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "body": "string",
  "subject": "string",
  "status": "string",
  "extId": "string"
}

Parameters

Name In Type Required Description
threadId path string true none
messageId path string true none
replyAll query boolean false none
body body object false none
» attachments body [AttachmentPartial] false [(tsType: Partial, schemaOptions: { partial: true })]
»» AttachmentPartial body AttachmentPartial false (tsType: Partial, schemaOptions: { partial: true })
»»» deleted body boolean false none
»»» deletedOn body string(date-time)¦null false none
»»» deletedBy body string¦null false none
»»» createdOn body string(date-time) false none
»»» modifiedOn body string(date-time) false none
»»» createdBy body string false none
»»» modifiedBy body string false none
»»» id body string false none
»»» name body string false none
»»» path body string false none
»»» thumbnail body string false none
»»» mime body string false none
»»» extId body string false none
»»» extMetadata body object false none
»»» messageId body string false none
» meta body [MetaPartial] false [(tsType: Partial, schemaOptions: { partial: true })]
»» MetaPartial body MetaPartial false (tsType: Partial, schemaOptions: { partial: true })
»»» deleted body boolean false none
»»» deletedOn body string(date-time)¦null false none
»»» deletedBy body string¦null false none
»»» createdOn body string(date-time) false none
»»» modifiedOn body string(date-time) false none
»»» createdBy body string false none
»»» modifiedBy body string false none
»»» id body string false none
»»» key body string false none
»»» value body string false none
»»» extId body string false none
»»» extMetadata body object false none
»»» messageId body string false none
» body body string true none
» subject body string false none
» status body string true none
» extId body string false none

Responses

Status Meaning Description Schema
200 OK Message is replied back to the sender None

Schemas

idResponse

1
false

Properties

None

composeMailBody

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
{
  "threadId": "string",
  "groups": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "party": "string",
      "type": "from",
      "isImportant": true,
      "storage": "draft",
      "visibility": "read",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string",
      "threadId": "string"
    }
  ],
  "attachments": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "meta": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "key": "string",
      "value": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ],
  "body": "string",
  "subject": "string",
  "status": "string",
  "extId": "string",
  "extMetadata": {}
}

Properties

Name Type Required Restrictions Description
threadId string false none none
groups [GroupPartial] true none [(tsType: Partial, schemaOptions: { partial: true })]
attachments [AttachmentPartial] false none [(tsType: Partial, schemaOptions: { partial: true })]
meta [MetaPartial] false none [(tsType: Partial, schemaOptions: { partial: true })]
body string true none none
subject string false none none
status string true none none
extId string false none none
extMetadata object false none none

Attachment

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "path": "string",
  "thumbnail": "string",
  "mime": "string",
  "extId": "string",
  "extMetadata": {},
  "messageId": "string"
}

Attachment

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
name string true none none
path string true none none
thumbnail string true none none
mime string true none none
extId string false none none
extMetadata object false none none
messageId string false none none

AttachmentPartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "path": "string",
  "thumbnail": "string",
  "mime": "string",
  "extId": "string",
  "extMetadata": {},
  "messageId": "string"
}

AttachmentPartial

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
name string false none none
path string false none none
thumbnail string false none none
mime string false none none
extId string false none none
extMetadata object false none none
messageId string false none none

IdArraysPartial

1
2
3
4
5
6
7
8
{
  "messageIds": [
    "string"
  ],
  "threadIds": [
    "string"
  ]
}

IdArraysPartial

Properties

Name Type Required Restrictions Description
messageIds [string] false none none
threadIds [string] false none none

IdArrays

1
2
3
4
5
6
7
8
{
  "messageIds": [
    "string"
  ],
  "threadIds": [
    "string"
  ]
}

IdArrays

Properties

Name Type Required Restrictions Description
messageIds [string] false none none
threadIds [string] false none none

MetaPartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "key": "string",
  "value": "string",
  "extId": "string",
  "extMetadata": {},
  "messageId": "string"
}

MetaPartial

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
key string false none none
value string false none none
extId string false none none
extMetadata object false none none
messageId string false none none

GroupPartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "party": "string",
  "type": "from",
  "isImportant": true,
  "storage": "draft",
  "visibility": "read",
  "extId": "string",
  "extMetadata": {},
  "messageId": "string",
  "threadId": "string"
}

GroupPartial

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
party string false none none
type string false none none
isImportant boolean false none none
storage string false none none
visibility string false none none
extId string false none none
extMetadata object false none none
messageId string false none none
threadId string false none none

Enumerated Values

Property Value
type from
type to
type cc
type bcc
storage draft
storage send
storage inbox
storage trash
visibility read
visibility new
visibility unread
visibility important
visibility not-important

Attachment add response schema

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "items": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string"
    }
  ]
}

Attachment add response schema

Properties

Name Type Required Restrictions Description
items [Attachment] false none none

AttachmentExcluding_deleted_WithRelations

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
{
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "name": "string",
  "path": "string",
  "thumbnail": "string",
  "mime": "string",
  "extId": "string",
  "extMetadata": {},
  "messageId": "string",
  "message": {
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "sender": "string",
    "subject": "string",
    "body": "string",
    "status": "draft",
    "extId": "string",
    "extMetadata": {},
    "threadId": "string",
    "attachment": [
      {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "name": "string",
        "path": "string",
        "thumbnail": "string",
        "mime": "string",
        "extId": "string",
        "extMetadata": {},
        "messageId": "string",
        "message": {},
        "foreignKey": null
      }
    ],
    "foreignKey": null,
    "group": [
      {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "party": "string",
        "type": "from",
        "isImportant": true,
        "storage": "draft",
        "visibility": "read",
        "extId": "string",
        "extMetadata": {},
        "messageId": "string",
        "threadId": "string",
        "message": {},
        "foreignKey": null,
        "thread": {
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "subject": "string",
          "messageCounts": 0,
          "extId": "string",
          "extMetadata": {},
          "message": [
            {}
          ],
          "foreignKey": null,
          "group": [
            {}
          ]
        }
      }
    ],
    "meta": [
      {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "key": "string",
        "value": "string",
        "extId": "string",
        "extMetadata": {},
        "messageId": "string",
        "message": {},
        "foreignKey": null
      }
    ],
    "thread": {
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "subject": "string",
      "messageCounts": 0,
      "extId": "string",
      "extMetadata": {},
      "message": [
        {}
      ],
      "foreignKey": null,
      "group": [
        {
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "party": "string",
          "type": "from",
          "isImportant": true,
          "storage": "draft",
          "visibility": "read",
          "extId": "string",
          "extMetadata": {},
          "messageId": "string",
          "threadId": "string",
          "message": {},
          "foreignKey": null,
          "thread": {}
        }
      ]
    }
  },
  "foreignKey": null
}

AttachmentExcluding_deleted_WithRelations

Properties

Name Type Required Restrictions Description
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
name string true none none
path string true none none
thumbnail string true none none
mime string true none none
extId string false none none
extMetadata object false none none
messageId string false none none
message MessageExcluding_deleted_WithRelations false none (tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })
foreignKey any false none none

ThreadExcluding_deleted_WithRelations

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
{
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "subject": "string",
  "messageCounts": 0,
  "extId": "string",
  "extMetadata": {},
  "message": [
    {
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "sender": "string",
      "subject": "string",
      "body": "string",
      "status": "draft",
      "extId": "string",
      "extMetadata": {},
      "threadId": "string",
      "attachment": [
        {
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "name": "string",
          "path": "string",
          "thumbnail": "string",
          "mime": "string",
          "extId": "string",
          "extMetadata": {},
          "messageId": "string",
          "message": {},
          "foreignKey": null
        }
      ],
      "foreignKey": null,
      "group": [
        {
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "party": "string",
          "type": "from",
          "isImportant": true,
          "storage": "draft",
          "visibility": "read",
          "extId": "string",
          "extMetadata": {},
          "messageId": "string",
          "threadId": "string",
          "message": {},
          "foreignKey": null,
          "thread": {
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "subject": "string",
            "messageCounts": 0,
            "extId": "string",
            "extMetadata": {},
            "message": [],
            "foreignKey": null,
            "group": [
              {}
            ]
          }
        }
      ],
      "meta": [
        {
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "key": "string",
          "value": "string",
          "extId": "string",
          "extMetadata": {},
          "messageId": "string",
          "message": {},
          "foreignKey": null
        }
      ],
      "thread": {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "subject": "string",
        "messageCounts": 0,
        "extId": "string",
        "extMetadata": {},
        "message": [],
        "foreignKey": null,
        "group": [
          {
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "party": "string",
            "type": "from",
            "isImportant": true,
            "storage": "draft",
            "visibility": "read",
            "extId": "string",
            "extMetadata": {},
            "messageId": "string",
            "threadId": "string",
            "message": {},
            "foreignKey": null,
            "thread": {}
          }
        ]
      }
    }
  ],
  "foreignKey": null,
  "group": [
    {
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "party": "string",
      "type": "from",
      "isImportant": true,
      "storage": "draft",
      "visibility": "read",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string",
      "threadId": "string",
      "message": {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "sender": "string",
        "subject": "string",
        "body": "string",
        "status": "draft",
        "extId": "string",
        "extMetadata": {},
        "threadId": "string",
        "attachment": [
          {
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "name": "string",
            "path": "string",
            "thumbnail": "string",
            "mime": "string",
            "extId": "string",
            "extMetadata": {},
            "messageId": "string",
            "message": {},
            "foreignKey": null
          }
        ],
        "foreignKey": null,
        "group": [
          {}
        ],
        "meta": [
          {
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "key": "string",
            "value": "string",
            "extId": "string",
            "extMetadata": {},
            "messageId": "string",
            "message": {},
            "foreignKey": null
          }
        ],
        "thread": {
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "subject": "string",
          "messageCounts": 0,
          "extId": "string",
          "extMetadata": {},
          "message": [
            {}
          ],
          "foreignKey": null,
          "group": []
        }
      },
      "foreignKey": null,
      "thread": {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "subject": "string",
        "messageCounts": 0,
        "extId": "string",
        "extMetadata": {},
        "message": [
          {
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "sender": "string",
            "subject": "string",
            "body": "string",
            "status": "draft",
            "extId": "string",
            "extMetadata": {},
            "threadId": "string",
            "attachment": [
              {
                "deletedOn": "2019-08-24T14:15:22Z",
                "deletedBy": "string",
                "createdOn": "2019-08-24T14:15:22Z",
                "modifiedOn": "2019-08-24T14:15:22Z",
                "createdBy": "string",
                "modifiedBy": "string",
                "id": "string",
                "name": "string",
                "path": "string",
                "thumbnail": "string",
                "mime": "string",
                "extId": "string",
                "extMetadata": {},
                "messageId": "string",
                "message": {},
                "foreignKey": null
              }
            ],
            "foreignKey": null,
            "group": [
              {}
            ],
            "meta": [
              {
                "deletedOn": "2019-08-24T14:15:22Z",
                "deletedBy": "string",
                "createdOn": "2019-08-24T14:15:22Z",
                "modifiedOn": "2019-08-24T14:15:22Z",
                "createdBy": "string",
                "modifiedBy": "string",
                "id": "string",
                "key": "string",
                "value": "string",
                "extId": "string",
                "extMetadata": {},
                "messageId": "string",
                "message": {},
                "foreignKey": null
              }
            ],
            "thread": {}
          }
        ],
        "foreignKey": null,
        "group": []
      }
    }
  ]
}

ThreadExcluding_deleted_WithRelations

Properties

Name Type Required Restrictions Description
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
subject string true none none
messageCounts number false none none
extId string false none none
extMetadata object false none none
message [MessageExcluding_deleted_WithRelations] false none [(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })]
foreignKey any false none none
group [GroupExcluding_deleted_WithRelations] false none [(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })]

GroupExcluding_deleted_WithRelations

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
{
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "party": "string",
  "type": "from",
  "isImportant": true,
  "storage": "draft",
  "visibility": "read",
  "extId": "string",
  "extMetadata": {},
  "messageId": "string",
  "threadId": "string",
  "message": {
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "sender": "string",
    "subject": "string",
    "body": "string",
    "status": "draft",
    "extId": "string",
    "extMetadata": {},
    "threadId": "string",
    "attachment": [
      {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "name": "string",
        "path": "string",
        "thumbnail": "string",
        "mime": "string",
        "extId": "string",
        "extMetadata": {},
        "messageId": "string",
        "message": {},
        "foreignKey": null
      }
    ],
    "foreignKey": null,
    "group": [
      {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "party": "string",
        "type": "from",
        "isImportant": true,
        "storage": "draft",
        "visibility": "read",
        "extId": "string",
        "extMetadata": {},
        "messageId": "string",
        "threadId": "string",
        "message": {},
        "foreignKey": null,
        "thread": {
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "subject": "string",
          "messageCounts": 0,
          "extId": "string",
          "extMetadata": {},
          "message": [
            {}
          ],
          "foreignKey": null,
          "group": [
            {}
          ]
        }
      }
    ],
    "meta": [
      {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "key": "string",
        "value": "string",
        "extId": "string",
        "extMetadata": {},
        "messageId": "string",
        "message": {},
        "foreignKey": null
      }
    ],
    "thread": {
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "subject": "string",
      "messageCounts": 0,
      "extId": "string",
      "extMetadata": {},
      "message": [
        {}
      ],
      "foreignKey": null,
      "group": [
        {
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "party": "string",
          "type": "from",
          "isImportant": true,
          "storage": "draft",
          "visibility": "read",
          "extId": "string",
          "extMetadata": {},
          "messageId": "string",
          "threadId": "string",
          "message": {},
          "foreignKey": null,
          "thread": {}
        }
      ]
    }
  },
  "foreignKey": null,
  "thread": {
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "subject": "string",
    "messageCounts": 0,
    "extId": "string",
    "extMetadata": {},
    "message": [
      {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "sender": "string",
        "subject": "string",
        "body": "string",
        "status": "draft",
        "extId": "string",
        "extMetadata": {},
        "threadId": "string",
        "attachment": [
          {
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "name": "string",
            "path": "string",
            "thumbnail": "string",
            "mime": "string",
            "extId": "string",
            "extMetadata": {},
            "messageId": "string",
            "message": {},
            "foreignKey": null
          }
        ],
        "foreignKey": null,
        "group": [
          {
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "party": "string",
            "type": "from",
            "isImportant": true,
            "storage": "draft",
            "visibility": "read",
            "extId": "string",
            "extMetadata": {},
            "messageId": "string",
            "threadId": "string",
            "message": {},
            "foreignKey": null,
            "thread": {}
          }
        ],
        "meta": [
          {
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "key": "string",
            "value": "string",
            "extId": "string",
            "extMetadata": {},
            "messageId": "string",
            "message": {},
            "foreignKey": null
          }
        ],
        "thread": {}
      }
    ],
    "foreignKey": null,
    "group": [
      {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "party": "string",
        "type": "from",
        "isImportant": true,
        "storage": "draft",
        "visibility": "read",
        "extId": "string",
        "extMetadata": {},
        "messageId": "string",
        "threadId": "string",
        "message": {
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "sender": "string",
          "subject": "string",
          "body": "string",
          "status": "draft",
          "extId": "string",
          "extMetadata": {},
          "threadId": "string",
          "attachment": [
            {
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "name": "string",
              "path": "string",
              "thumbnail": "string",
              "mime": "string",
              "extId": "string",
              "extMetadata": {},
              "messageId": "string",
              "message": {},
              "foreignKey": null
            }
          ],
          "foreignKey": null,
          "group": [
            {}
          ],
          "meta": [
            {
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "key": "string",
              "value": "string",
              "extId": "string",
              "extMetadata": {},
              "messageId": "string",
              "message": {},
              "foreignKey": null
            }
          ],
          "thread": {}
        },
        "foreignKey": null,
        "thread": {}
      }
    ]
  }
}

GroupExcluding_deleted_WithRelations

Properties

Name Type Required Restrictions Description
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
party string true none none
type string true none none
isImportant boolean false none none
storage string false none none
visibility string false none none
extId string false none none
extMetadata object false none none
messageId string false none none
threadId string false none none
message MessageExcluding_deleted_WithRelations false none (tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })
foreignKey any false none none
thread ThreadExcluding_deleted_WithRelations false none (tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })

Enumerated Values

Property Value
type from
type to
type cc
type bcc
storage draft
storage send
storage inbox
storage trash
visibility read
visibility new
visibility unread
visibility important
visibility not-important

MetaExcluding_deleted_WithRelations

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
{
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "key": "string",
  "value": "string",
  "extId": "string",
  "extMetadata": {},
  "messageId": "string",
  "message": {
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "sender": "string",
    "subject": "string",
    "body": "string",
    "status": "draft",
    "extId": "string",
    "extMetadata": {},
    "threadId": "string",
    "attachment": [
      {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "name": "string",
        "path": "string",
        "thumbnail": "string",
        "mime": "string",
        "extId": "string",
        "extMetadata": {},
        "messageId": "string",
        "message": {},
        "foreignKey": null
      }
    ],
    "foreignKey": null,
    "group": [
      {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "party": "string",
        "type": "from",
        "isImportant": true,
        "storage": "draft",
        "visibility": "read",
        "extId": "string",
        "extMetadata": {},
        "messageId": "string",
        "threadId": "string",
        "message": {},
        "foreignKey": null,
        "thread": {
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "subject": "string",
          "messageCounts": 0,
          "extId": "string",
          "extMetadata": {},
          "message": [
            {}
          ],
          "foreignKey": null,
          "group": [
            {}
          ]
        }
      }
    ],
    "meta": [
      {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "key": "string",
        "value": "string",
        "extId": "string",
        "extMetadata": {},
        "messageId": "string",
        "message": {},
        "foreignKey": null
      }
    ],
    "thread": {
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "subject": "string",
      "messageCounts": 0,
      "extId": "string",
      "extMetadata": {},
      "message": [
        {}
      ],
      "foreignKey": null,
      "group": [
        {
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "party": "string",
          "type": "from",
          "isImportant": true,
          "storage": "draft",
          "visibility": "read",
          "extId": "string",
          "extMetadata": {},
          "messageId": "string",
          "threadId": "string",
          "message": {},
          "foreignKey": null,
          "thread": {}
        }
      ]
    }
  },
  "foreignKey": null
}

MetaExcluding_deleted_WithRelations

Properties

Name Type Required Restrictions Description
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
key string true none none
value string false none none
extId string false none none
extMetadata object false none none
messageId string false none none
message MessageExcluding_deleted_WithRelations false none (tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })
foreignKey any false none none

MessageExcluding_deleted_WithRelations

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
{
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "sender": "string",
  "subject": "string",
  "body": "string",
  "status": "draft",
  "extId": "string",
  "extMetadata": {},
  "threadId": "string",
  "attachment": [
    {
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "name": "string",
      "path": "string",
      "thumbnail": "string",
      "mime": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string",
      "message": {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "sender": "string",
        "subject": "string",
        "body": "string",
        "status": "draft",
        "extId": "string",
        "extMetadata": {},
        "threadId": "string",
        "attachment": [],
        "foreignKey": null,
        "group": [
          {
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "party": "string",
            "type": "from",
            "isImportant": true,
            "storage": "draft",
            "visibility": "read",
            "extId": "string",
            "extMetadata": {},
            "messageId": "string",
            "threadId": "string",
            "message": {},
            "foreignKey": null,
            "thread": {
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "subject": "string",
              "messageCounts": 0,
              "extId": "string",
              "extMetadata": {},
              "message": [
                {}
              ],
              "foreignKey": null,
              "group": [
                {}
              ]
            }
          }
        ],
        "meta": [
          {
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "key": "string",
            "value": "string",
            "extId": "string",
            "extMetadata": {},
            "messageId": "string",
            "message": {},
            "foreignKey": null
          }
        ],
        "thread": {
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "subject": "string",
          "messageCounts": 0,
          "extId": "string",
          "extMetadata": {},
          "message": [
            {}
          ],
          "foreignKey": null,
          "group": [
            {
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "party": "string",
              "type": "from",
              "isImportant": true,
              "storage": "draft",
              "visibility": "read",
              "extId": "string",
              "extMetadata": {},
              "messageId": "string",
              "threadId": "string",
              "message": {},
              "foreignKey": null,
              "thread": {}
            }
          ]
        }
      },
      "foreignKey": null
    }
  ],
  "foreignKey": null,
  "group": [
    {
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "party": "string",
      "type": "from",
      "isImportant": true,
      "storage": "draft",
      "visibility": "read",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string",
      "threadId": "string",
      "message": {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "sender": "string",
        "subject": "string",
        "body": "string",
        "status": "draft",
        "extId": "string",
        "extMetadata": {},
        "threadId": "string",
        "attachment": [
          {
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "name": "string",
            "path": "string",
            "thumbnail": "string",
            "mime": "string",
            "extId": "string",
            "extMetadata": {},
            "messageId": "string",
            "message": {},
            "foreignKey": null
          }
        ],
        "foreignKey": null,
        "group": [],
        "meta": [
          {
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "key": "string",
            "value": "string",
            "extId": "string",
            "extMetadata": {},
            "messageId": "string",
            "message": {},
            "foreignKey": null
          }
        ],
        "thread": {
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "subject": "string",
          "messageCounts": 0,
          "extId": "string",
          "extMetadata": {},
          "message": [
            {}
          ],
          "foreignKey": null,
          "group": [
            {}
          ]
        }
      },
      "foreignKey": null,
      "thread": {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "subject": "string",
        "messageCounts": 0,
        "extId": "string",
        "extMetadata": {},
        "message": [
          {
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "sender": "string",
            "subject": "string",
            "body": "string",
            "status": "draft",
            "extId": "string",
            "extMetadata": {},
            "threadId": "string",
            "attachment": [
              {
                "deletedOn": "2019-08-24T14:15:22Z",
                "deletedBy": "string",
                "createdOn": "2019-08-24T14:15:22Z",
                "modifiedOn": "2019-08-24T14:15:22Z",
                "createdBy": "string",
                "modifiedBy": "string",
                "id": "string",
                "name": "string",
                "path": "string",
                "thumbnail": "string",
                "mime": "string",
                "extId": "string",
                "extMetadata": {},
                "messageId": "string",
                "message": {},
                "foreignKey": null
              }
            ],
            "foreignKey": null,
            "group": [],
            "meta": [
              {
                "deletedOn": "2019-08-24T14:15:22Z",
                "deletedBy": "string",
                "createdOn": "2019-08-24T14:15:22Z",
                "modifiedOn": "2019-08-24T14:15:22Z",
                "createdBy": "string",
                "modifiedBy": "string",
                "id": "string",
                "key": "string",
                "value": "string",
                "extId": "string",
                "extMetadata": {},
                "messageId": "string",
                "message": {},
                "foreignKey": null
              }
            ],
            "thread": {}
          }
        ],
        "foreignKey": null,
        "group": [
          {}
        ]
      }
    }
  ],
  "meta": [
    {
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "key": "string",
      "value": "string",
      "extId": "string",
      "extMetadata": {},
      "messageId": "string",
      "message": {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "sender": "string",
        "subject": "string",
        "body": "string",
        "status": "draft",
        "extId": "string",
        "extMetadata": {},
        "threadId": "string",
        "attachment": [
          {
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "name": "string",
            "path": "string",
            "thumbnail": "string",
            "mime": "string",
            "extId": "string",
            "extMetadata": {},
            "messageId": "string",
            "message": {},
            "foreignKey": null
          }
        ],
        "foreignKey": null,
        "group": [
          {
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "party": "string",
            "type": "from",
            "isImportant": true,
            "storage": "draft",
            "visibility": "read",
            "extId": "string",
            "extMetadata": {},
            "messageId": "string",
            "threadId": "string",
            "message": {},
            "foreignKey": null,
            "thread": {
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "subject": "string",
              "messageCounts": 0,
              "extId": "string",
              "extMetadata": {},
              "message": [
                {}
              ],
              "foreignKey": null,
              "group": [
                {}
              ]
            }
          }
        ],
        "meta": [],
        "thread": {
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "subject": "string",
          "messageCounts": 0,
          "extId": "string",
          "extMetadata": {},
          "message": [
            {}
          ],
          "foreignKey": null,
          "group": [
            {
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "party": "string",
              "type": "from",
              "isImportant": true,
              "storage": "draft",
              "visibility": "read",
              "extId": "string",
              "extMetadata": {},
              "messageId": "string",
              "threadId": "string",
              "message": {},
              "foreignKey": null,
              "thread": {}
            }
          ]
        }
      },
      "foreignKey": null
    }
  ],
  "thread": {
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "subject": "string",
    "messageCounts": 0,
    "extId": "string",
    "extMetadata": {},
    "message": [
      {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "sender": "string",
        "subject": "string",
        "body": "string",
        "status": "draft",
        "extId": "string",
        "extMetadata": {},
        "threadId": "string",
        "attachment": [
          {
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "name": "string",
            "path": "string",
            "thumbnail": "string",
            "mime": "string",
            "extId": "string",
            "extMetadata": {},
            "messageId": "string",
            "message": {},
            "foreignKey": null
          }
        ],
        "foreignKey": null,
        "group": [
          {
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "party": "string",
            "type": "from",
            "isImportant": true,
            "storage": "draft",
            "visibility": "read",
            "extId": "string",
            "extMetadata": {},
            "messageId": "string",
            "threadId": "string",
            "message": {},
            "foreignKey": null,
            "thread": {}
          }
        ],
        "meta": [
          {
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "key": "string",
            "value": "string",
            "extId": "string",
            "extMetadata": {},
            "messageId": "string",
            "message": {},
            "foreignKey": null
          }
        ],
        "thread": {}
      }
    ],
    "foreignKey": null,
    "group": [
      {
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "party": "string",
        "type": "from",
        "isImportant": true,
        "storage": "draft",
        "visibility": "read",
        "extId": "string",
        "extMetadata": {},
        "messageId": "string",
        "threadId": "string",
        "message": {
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "sender": "string",
          "subject": "string",
          "body": "string",
          "status": "draft",
          "extId": "string",
          "extMetadata": {},
          "threadId": "string",
          "attachment": [
            {
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "name": "string",
              "path": "string",
              "thumbnail": "string",
              "mime": "string",
              "extId": "string",
              "extMetadata": {},
              "messageId": "string",
              "message": {},
              "foreignKey": null
            }
          ],
          "foreignKey": null,
          "group": [
            {}
          ],
          "meta": [
            {
              "deletedOn": "2019-08-24T14:15:22Z",
              "deletedBy": "string",
              "createdOn": "2019-08-24T14:15:22Z",
              "modifiedOn": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "modifiedBy": "string",
              "id": "string",
              "key": "string",
              "value": "string",
              "extId": "string",
              "extMetadata": {},
              "messageId": "string",
              "message": {},
              "foreignKey": null
            }
          ],
          "thread": {}
        },
        "foreignKey": null,
        "thread": {}
      }
    ]
  }
}

MessageExcluding_deleted_WithRelations

Properties

Name Type Required Restrictions Description
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
sender string true none none
subject string true none none
body string true none none
status string true none none
extId string false none none
extMetadata object false none none
threadId string false none none
attachment [AttachmentExcluding_deleted_WithRelations] false none [(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })]
foreignKey any false none none
group [GroupExcluding_deleted_WithRelations] false none [(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })]
meta [MetaExcluding_deleted_WithRelations] false none [(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })]
thread ThreadExcluding_deleted_WithRelations false none (tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })

Enumerated Values

Property Value
status draft
status send

Message

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "sender": "string",
  "subject": "string",
  "body": "string",
  "status": "draft",
  "extId": "string",
  "extMetadata": {},
  "threadId": "string"
}

Message

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
sender string true none none
subject string true none none
body string true none none
status string true none none
extId string false none none
extMetadata object false none none
threadId string false none none

Enumerated Values

Property Value
status draft
status send

Thread

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "subject": "string",
  "messageCounts": 0,
  "extId": "string",
  "extMetadata": {}
}

Thread

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
subject string true none none
messageCounts number false none none
extId string false none none
extMetadata object false none none