getAttachments method
Get email attachments
Get all attachments in paginated response. Each entity contains meta data for the attachment such as name
and content-type
. Use the attachmentId
and the download endpoints to get the file contents.
Parameters:
-
int page: Optional page index for list pagination
-
int size: Optional page size for list pagination
-
String sort: Optional createdAt sort direction ASC or DESC
-
String fileNameFilter: Optional file name and content type search filter
-
DateTime since: Filter by created at after the given timestamp
-
DateTime before: Filter by created at before the given timestamp
Implementation
Future<PageAttachmentEntity?> getAttachments({ int? page, int? size, String? sort, String? fileNameFilter, DateTime? since, DateTime? before, }) async {
final response = await getAttachmentsWithHttpInfo( page: page, size: size, sort: sort, fileNameFilter: fileNameFilter, since: since, before: before, );
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), 'PageAttachmentEntity',) as PageAttachmentEntity;
}
return null;
}