CakemailInstall

Summary

List senders associated with a specified account or the authenticated account.

Inputs

• accountId — Optional: Specify an account ID for multi-tenant operations.
• returnAll — Whether to return all results or only up to a given limit.
• limit (required) — Max number of results to return, applicable if returnAll is false.
• additionalFields — Collection of additional optional parameters, such as sorting.

Output shape

a list of sender objects

Returns a list of senders with details such as name and email. If returnAll is set to false, respects limit for the number of senders returned.

Examples

Example 1: List all senders for the authenticated account.

Set returnAll to true.

Example 2: List a limited number of senders, sorted by name.

Set returnAll to false and provide a limit of desired results, with sorting options.