getInboxesWithHttpInfo method
List Inboxes and email addresses
List the inboxes you have created. Note use of the more advanced getAllInboxes
is recommended and allows paginated access using a limit and sort parameter.
Note: This method returns the HTTP Response
.
Parameters:
-
int size: Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated
getAllEmails
for larger queries. -
String sort: Optional createdAt sort direction ASC or DESC
-
DateTime since: Optional filter by created after given date time
-
bool excludeCatchAllInboxes: Optional exclude catch all inboxes
-
DateTime before: Optional filter by created before given date time
Implementation
Future<Response> getInboxesWithHttpInfo({ int? size, String? sort, DateTime? since, bool? excludeCatchAllInboxes, DateTime? before, }) async {
// ignore: prefer_const_declarations
final path = r'/inboxes';
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
if (size != null) {
queryParams.addAll(_queryParams('', 'size', size));
}
if (sort != null) {
queryParams.addAll(_queryParams('', 'sort', sort));
}
if (since != null) {
queryParams.addAll(_queryParams('', 'since', since));
}
if (excludeCatchAllInboxes != null) {
queryParams.addAll(_queryParams('', 'excludeCatchAllInboxes', excludeCatchAllInboxes));
}
if (before != null) {
queryParams.addAll(_queryParams('', 'before', before));
}
const contentTypes = <String>[];
return apiClient.invokeAPI(
path,
'GET',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}