RESTAPI:Recipient Notification Mail: Unterschied zwischen den Versionen

Aktuelle Version vom 17. Juli 2024, 12:41 Uhr

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.

@@ Zeile 1: / Zeile 1: @@
+{{InfoBox|title=Minimum REST API Version|content=This endpoint requires at least the [[{{NAMESPACE}}:Version_1.10|Cryptshare REST API version 1.10]].}}
+{{InfoBox|title=|content=Please note that the Cryptshare Server only allows this operation for a verified sender email address (see [[{{NAMESPACE}}:About_Verifications|Verification]]).}}
-{{InfoBox|title=|content=Please note that the Cryptshare Server only allows this operation for a verified sender email address (see [[{{NAMESPACE}}:About_Verifications|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.
-This API endpoint allows a user to request an email associated with a particular transfer, which will be sent by the server to the recipient's email address. 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.
+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 ===
+=== REST API to get the recipient notification mail of the transfer ===
 POST https://&#x3C;your-url&#x3E;/api/users/&#x3C;sender-email-address&#x3E;/transfers/&#x3C;tracking-id&#x3E;/emails/recipients/&#x3C;transfer-id>
-The input accepts following properties
+The request accepts following properties
 {| class="wikitable"
-|+
+|+The request body
 !Description
 !Property
+!Type
 |-
-|The recipients which will be included in the email along with the recipients of the transfer.
+|Additional recipients object that are not part of the Cryptshare transfer, but that should be mentioned in the email.
 |additionalRecipients
+|RecipientsDto
+|}
+{| class="wikitable"
+|+ RecipientsDto
+!Description
+!Property
+!Type
 |-
-|The section for includng the mail of the 'to' recipients
+|The section for including the mail of the 'to' recipients
-|to
+| to
+| List of RecipientDto
 |-
-|The section for includng the mail of the 'cc' recipients
+|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
+|}
+{| class="wikitable"
+|+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.
-The response of this request is in text/html;charset=utf-8 format, rather than JSON. The response email will contain the download button, reply button but not the notification mails which are in the bcc.