ConnectCloud Developers

A stored mail (.eml, message/rfc822) of the ticket for display: headers, text, sanitised HTML and part manifest (desk:read)

GET /api/desk/v1/items/{ref}/attachments/{documentId}/mail

Module: Desk · operationId: getItemMailFile · Tag: Mail · Auth: access token (Authorization: Bearer <accessToken>)

Parsed by comms, HTML sanitised like the mail of an entry (getEntryMail). Inline images of the entry's own mail link to their stored files, others are dropped; remote images are blocked unless images=true. Only files of type message/rfc822.

Parameters

Name In Type Required Description
images query boolean true loads remote images (they can track the reader) (default false)
ref path string yes Item id or number
documentId path string yes

Responses

  • 200 The mail (application/json)
  • 400 The file is no mail (message/rfc822), too large for display (40 MB) or cannot be read (code invalid, field documentId)
  • 403 The malware scan found something (code infected)
  • 404 No such file on the ticket
  • 409 The malware scan has not cleared the file (yet): pending, or failed and scanned again later (code scan_pending; DMS answers the same as not_scanned)
  • 503 The file store or the mail parser is not configured (code unavailable)

Fields of the 200 answer:

  • blockedImages (integer): Remote images left out; images=true loads them
  • cc (array of Address): Recipients in copy
    • address (string): E-mail address
    • name (string): Display name (may be empty)
  • date (string (date-time)): Date header
  • from (Address)
    • address (string): E-mail address
    • name (string): Display name (may be empty)
  • html (string): Sanitised HTML body
  • parts (array of object): Parts of the mail (attachments and inline files)
    • contentType (string): MIME type
    • inline (boolean): An inline part
    • name (string): File name
    • size (integer): Size in bytes
  • subject (string): Subject
  • text (string): Plain-text body
  • to (array of Address): Recipients
    • address (string): E-mail address
    • name (string): Display name (may be empty)

Example 200 answer:

{
  "blockedImages": 0,
  "cc": [],
  "date": "2026-11-17T15:02:00Z",
  "from": {
    "address": "katrin.stadler@alpenhotel-seeblick.example",
    "name": "Katrin Stadler"
  },
  "html": "\u003cp\u003eVielen Dank, die Gäste sind wieder zufrieden!\u003c/p\u003e",
  "parts": [
    {
      "contentType": "text/plain",
      "inline": false,
      "name": "",
      "size": 48
    },
    {
      "contentType": "text/html",
      "inline": false,
      "name": "",
      "size": 61
    }
  ],
  "subject": "AW: [#1] WLAN in den Gästezimmern 2. OG fällt immer wieder aus",
  "text": "Vielen Dank, die Gäste sind wieder zufrieden!",
  "to": [
    {
      "address": "support@muster-it.example",
      "name": "Muster IT Support"
    }
  ]
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/desk/v1/items/string/attachments/string/mail' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI