RESTAPI:Recipient Notification Mail

Aus Cryptshare Documentation
Wechseln zu:Navigation, Suche
Minimum REST API Version
This endpoint requires at least the Cryptshare REST API version 1.10.
Please note that the Cryptshare Server only allows this operation for a verified sender email address (see Verification).

This API endpoint allows a user to request an email associated with a particular transfer, which was already sent by the server to the recipient's email address, when during transfer session configuration the setting "sendRecipientNotification" was set to true.

The request must be made by the same user who initiated the transfer to ensure authenticity. The user has the option to include additional recipient email addresses to be included in the email along with the original recipients of the transfer.

REST API to get the recipient notification mail of the transfer

POST https://<your-url>/api/users/<sender-email-address>/transfers/<tracking-id>/emails/recipients/<transfer-id>


The request accepts following properties

The request body
Description Property Type
Additional recipients object that are not part of the Cryptshare transfer, but that should be mentioned in the email. additionalRecipients RecipientsDto
RecipientsDto
Description Property Type
The section for including the mail of the 'to' recipients to List of RecipientDto
The section for including the mail of the 'cc' recipients cc List of RecipientDto
The section for including the mail of the 'bcc' recipients bcc List of RecipientDto
RecipientDto
Description Property Type
The actual email id or additional recipient mail String

The response of this request is in text/html;charset=utf-8 format, rather than JSON. The response email will contain the download button, the reply button but not the email addresses which are in the bcc.