RESTAPI:Recipient NotificationMail From Sender Point Of View: Unterschied zwischen den Versionen
Aus Cryptshare Documentation
K (Initial content) |
K (description update about bcc) |
||
| Zeile 1: | Zeile 1: | ||
{{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 will be | This API endpoint allows a user to request an email associated with a particular transfer, which will be received at the recipient end, but from the sender's point of view. 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 sender notification mail 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/ | POST https://<your-url>/api/users/<sender-email-address>/transfers/<tracking-id>/emails/sent | ||
| Zeile 24: | Zeile 25: | ||
|The section for includng the mail of the 'cc' recipients | |The section for includng the mail of the 'cc' recipients | ||
|cc | |cc | ||
|- | |- | ||
|The actual email id or additional recipient | |The actual email id or additional recipient | ||
| Zeile 32: | Zeile 30: | ||
|} | |} | ||
The response of this request is in text/html;charset=iso-8859-1 format, rather than JSON. | The response of this request is in text/html;charset=iso-8859-1 format, rather than JSON. The response email will not contain the download button, or the notification mails which are in the bcc. | ||
Version vom 9. Juli 2024, 06:13 Uhr
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 will be received at the recipient end, but from the sender's point of view. 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 sender notification mail of the transfer
POST https://<your-url>/api/users/<sender-email-address>/transfers/<tracking-id>/emails/sent
The input accepts following properties
| Description | Property |
|---|---|
| The password of the transfer. | password |
| The recipients which will be included in the email along with the recipients of the transfer. | additionalRecipients |
| The section for includng the mail of the 'to' recipients | to |
| The section for includng the mail of the 'cc' recipients | cc |
| The actual email id or additional recipient |
The response of this request is in text/html;charset=iso-8859-1 format, rather than JSON. The response email will not contain the download button, or the notification mails which are in the bcc.