RESTAPI:Sender 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 sender's email address, when during transfer session configuration the setting "sendUploadSummary" 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 the transfer password in the email by specifying it in the request, and they can also specify additional recipient email addresses to be included in the email along with the original recipients of the transfer.

REST API to get the sender notification mail of the transfer

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

The request accepts following properties

The request body
Description	Property	Type
The password of the transfer.	password	String
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 will contain the revoke button and also all the emails including those who 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]]).}}
-This API endpoint allows a user to request an email associated with a particular transfer, which will be sent by the server to the sender'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 the transfer password in the email by specifying it in the request, and they can also specify additional recipient email addresses to be included in the email along with the original recipients of the transfer. The response of this request is in text/html;charset=iso-8859-1 format, rather than JSON.
+This API endpoint allows a user to request an email associated with a particular transfer, which was already sent by the server to the sender's email address, when during transfer session configuration the setting "sendUploadSummary" was set to true.
-=== Api to get the sender notification mail 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 the transfer password in the email by specifying it in the request, and they can also specify additional recipient email addresses to be included in the email along with the original recipients of the transfer.
+=== REST API to get the sender notification mail of the transfer ===
 POST https://<your-url>/api/users/<sender-email-address>/transfers/<tracking-id>/emails/sender
-The input accepts following paramters
+The request accepts following properties
 {| class="wikitable"
-|+
+|+The request body
 !Description
 !Property
+!Type
 |-
-|Whether a transfer with the requested sender-recipient combination would be allowed or not.
+|The password of the transfer.
-|allowed
+|password
+|String
 |-
-|The evaluated policy settings of the matching policy rules. This is only set the transfer would be allowed at all.
+|Additional recipients object that are not part of the Cryptshare transfer, but that should be mentioned in the email.
-|settings
+|additionalRecipients
-|-
+|RecipientsDto
-|List of all recipients to which the given sender is not allowed to perform a transfer. This is only set if the transfer would not be allowed.
-|failedRecipients
 |}
-In other cases, a result object is returned with the following information:
 {| class="wikitable"
-|+
+|+RecipientsDto
 !Description
 !Property
+!Type
 |-
-|Whether a transfer with the requested sender-recipient combination would be allowed or not.
+|The section for including the mail of the 'to' recipients
-|allowed
+|to
+|List of RecipientDto
 |-
-|The evaluated policy settings of the matching policy rules. This is only set the transfer would be allowed at all.
+|The section for including the mail of the 'cc' recipients
-|settings
+|cc
+|List of RecipientDto
+|-
+|The section for including the mail of the 'bcc' recipients
+|bcc
+|List of RecipientDto
+|}
+{| class="wikitable"
+|+RecipientDto
+!Description
+!Property
+!Type
 |-
-|List of all recipients to which the given sender is not allowed to perform a transfer. This is only set if the transfer would not be allowed.
+|The actual email id or additional recipient
-|failedRecipients
+|mail
+|String
 |}
+The response of this request is in text/html;charset=utf-8 format, rather than JSON. The response will contain the revoke button and also all the emails including those who are in the bcc.