User Tools

Site Tools


api:mailbox:getfile

API : Mailbox GetFile

Introduction

This request will return the specified file that is part of a mailbox message.

Request

URL https://api.telecomx.dk/mailbox/MESSAGE_ID/FILE_ID
Method GET
Access level RESELLER_ADMIN with PORTING feature.
Param MESSAGE_ID Id of the message (24 hex-char string)
FILE_ID Id of the file (24 hex-char string)
Query forcedownload When requesting a file from a browser and the file is an image or a pdf, then it will be shown in the browser. If the file should be downloaded instead, this is set to true.

Query example

https://api.telecomx.dk/mailbox/1234567890ABCDEF12345678/1234567890ABCDEF12345670
https://api.telecomx.dk/mailbox/1234567890ABCDEF12345678/1234567890ABCDEF12345670?forcedownload=true

Response

The file will be returned.

Errors

Error code Message Description
400 bad_request Id not found in request URI
400 bad_request File not found in request URI
404 file File not found
403 access_denied Insufficient access level
500 internal_error <Unspecified>
api/mailbox/getfile.txt · Last modified: 2023/10/30 14:03 by Per Møller

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki