sendShareEmail method
Send a mail notification again for a share. The mail_send option must be enabled for the given share.
Returns a Future containing a DynamiteResponse
with the status code, deserialized body and headers.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
id
the share ID.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 404: Share not found
- 403: You are not allowed to send mail notifications
- 400: Invalid request or wrong password
- 200: The email notification was sent successfully
See:
- $sendShareEmail_Request for the request send by this method.
- $sendShareEmail_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<ShareapiSendShareEmailResponseApplicationJson, void>> sendShareEmail({
required String id,
bool? oCSAPIRequest,
ShareapiSendShareEmailRequestApplicationJson? $body,
}) async {
final _request = $sendShareEmail_Request(
id: id,
oCSAPIRequest: oCSAPIRequest,
$body: $body,
);
final _streamedResponse = await _rootClient.httpClient.send(_request);
final _response = await _i3.Response.fromStream(_streamedResponse);
final _serializer = $sendShareEmail_Serializer();
return _i1.ResponseConverter<ShareapiSendShareEmailResponseApplicationJson, void>(_serializer).convert(_response);
}