CakemailInstall

Summary

List suppressed emails from your Cakemail account.

Inputs

• accountId — Optional: Specify an account ID for multi-tenant operations. If not provided, uses the authenticated account.
• returnAll — Whether to return all results or only up to a given limit. Defaults to false.
• limit — Max number of results to return, applicable only if returnAll is false. Defaults to 50, with a minimum of 1 and a maximum of 100.
• additionalFields — Additional fields like 'filter' and 'sort' to customize the list query. The filter can specify expressions like 'email==user@example.com' and sorting options include sorting by email or creation date.

Output shape

a list of suppressed email records

Pagination is managed through the 'returnAll' and 'limit' parameters. If 'returnAll' is true, it returns all suppressed emails; otherwise, it limits the response to the specified 'limit'.

Examples

Example 1: Retrieve all suppressed emails for the authenticated account

Set 'returnAll' to true.

Example 2: Retrieve a limited number of suppressed emails with filtering

Set 'returnAll' to false and specify 'limit' and 'filter' for desired results.