RESTAPI:Sender Notification Mail: Unterschied zwischen den Versionen
Aus Cryptshare Documentation
K (utf-8 response type) |
Keine Bearbeitungszusammenfassung |
||
| (Eine dazwischenliegende Version desselben Benutzers wird nicht angezeigt) | |||
| 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 | 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 | POST https://<your-url>/api/users/<sender-email-address>/transfers/<tracking-id>/emails/sender | ||
The | The request accepts following properties | ||
{| class="wikitable" | {| class="wikitable" | ||
|+ | |+The request body | ||
!Description | !Description | ||
!Property | !Property | ||
!Type | |||
|- | |- | ||
|The password of the transfer. | |The password of the transfer. | ||
|password | |password | ||
|String | |||
|- | |- | ||
| | |Additional recipients object that are not part of the Cryptshare transfer, but that should be mentioned in the email. | ||
|additionalRecipients | |additionalRecipients | ||
|RecipientsDto | |||
|} | |||
{| class="wikitable" | |||
|+RecipientsDto | |||
!Description | |||
!Property | |||
!Type | |||
|- | |- | ||
|The section for | |The section for including the mail of the 'to' recipients | ||
|to | |to | ||
|List of RecipientDto | |||
|- | |- | ||
|The section for | |The section for including the mail of the 'cc' recipients | ||
|cc | |cc | ||
|List of RecipientDto | |||
|- | |- | ||
|The section for | |The section for including the mail of the 'bcc' recipients | ||
|bcc | |bcc | ||
|List of RecipientDto | |||
|} | |||
{| class="wikitable" | |||
|+RecipientDto | |||
!Description | |||
!Property | |||
!Type | |||
|- | |- | ||
|The actual email id or additional recipient | |The actual email id or additional recipient | ||
|mail | |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. | 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. | ||
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
| 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 |
| 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 |
| Description | Property | Type |
|---|---|---|
| The actual email id or additional recipient | 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.