MailHole API

Attachements

| Improve this Doc View Source

ApiV1ByReceiverAddressMailsByMailGuidAttachementsByAttachementGuidGet

Get details of attachement like MIME type, hashes, download link, ...

Request
GET /api/v1/{receiverAddress}/mails/{mailGuid}/attachements/{attachementGuid}
Parameters
Name Type Value Notes
*receiverAddress string

Mail address of the original receiver
*mailGuid string

GUID that was assigned to the mail by MailHole
*attachementGuid string

GUID that was assigned to the attachement by MailHole
Responses
Status Code Description Samples
200

Found attachement
400

Any error with the specified parameters
404

Parameters were ok but no matching attachement was found
| Improve this Doc View Source

ApiV1ByReceiverAddressMailsByMailGuidAttachementsByAttachementGuidPut

Checks whether attachment was transferred successfully

Request
PUT /api/v1/{receiverAddress}/mails/{mailGuid}/attachements/{attachementGuid}
Parameters
Name Type Value Notes
*receiverAddress string
*mailGuid string
*attachementGuid string
validationRequest
Responses
Status Code Description Samples
200

Success
400

Bad Request
404

Not Found
409

Conflict

Mails

| Improve this Doc View Source

ApiV1ByReceiverAddressMailsGet

Request
GET /api/v1/{receiverAddress}/mails?offset&pageSize
Parameters
Name Type Value Notes
*receiverAddress string
*offset integer
*pageSize integer
Responses
Status Code Description Samples
200

Success
400

Bad Request
404

Not Found
500

Server Error
| Improve this Doc View Source

ApiV1ByReceiverAddressMailsCountGet

Request
GET /api/v1/{receiverAddress}/mails/count
Parameters
Name Type Value Notes
*receiverAddress string
Responses
Status Code Description Samples
200

Success
400

Bad Request
404

Not Found
500

Server Error
| Improve this Doc View Source

ApiV1ByReceiverAddressMailsByMailGuidGet

Request
GET /api/v1/{receiverAddress}/mails/{mailGuid}
Parameters
Name Type Value Notes
*receiverAddress string
*mailGuid string
Responses
Status Code Description Samples
200

Success
400

Bad Request
404

Not Found
500

Server Error
| Improve this Doc View Source

ApiV1ByReceiverAddressMailsByMailGuidDelete

Request
DELETE /api/v1/{receiverAddress}/mails/{mailGuid}
Parameters
Name Type Value Notes
*receiverAddress string
*mailGuid string
Responses
Status Code Description Samples
200

Success
400

Bad Request
404

Not Found
500

Server Error

Receivers

| Improve this Doc View Source

ApiV1ByReceiverAddressGet

Request
GET /api/v1/{receiverAddress}
Parameters
Name Type Value Notes
*receiverAddress string
Responses
Status Code Description Samples
200

Success
400

Bad Request
500

Server Error