getEmailAttachment method

Future<MultipartFile?> getEmailAttachment(
  1. String messageId,
  2. String attachmentId, {
  3. String? accountId,
  4. String? xWorkspaceID,
})

Download an attachment.

Streams the attachment binary. Response Content-Type matches the attachment's declared MIME type; Content-Disposition sets the filename.

Parameters:

  • String messageId (required): Message id the attachment belongs to.

  • String attachmentId (required): Attachment id within the message.

  • String accountId: Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with provider. If omitted on a list endpoint the call fans out across every connected account.

  • String xWorkspaceID: Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Implementation

Future<MultipartFile?> getEmailAttachment(String messageId, String attachmentId, { String? accountId, String? xWorkspaceID, }) async {
  final response = await getEmailAttachmentWithHttpInfo(messageId, attachmentId,  accountId: accountId, xWorkspaceID: xWorkspaceID, );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'MultipartFile',) as MultipartFile;

  }
  return null;
}