Zoho: Download an email attachment

← Download attachments operations · Get started

Operation zoho.downloademailattachments

Provider route: GET /crm/v8/{module}/{recordId}/Emails/actions/download_attachments. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["downloadAttachments"]["downloadEmailAttachments"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.downloadAttachments.downloadEmailAttachments(input);
    const result = await call.wait();
    return result.bodyBytes();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.download_attachments.download_email_attachments(arguments)
        result = await call.wait()
        return result.body_bytes()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.module	string	Required within parent	Maximum length: 100
path.recordId	string	Required within parent	Maximum length: 20
query	object	Required within parent	Additional keys: not allowed
query.user_id	integer	Required within parent	Format: int64
query.message_id	string	Required within parent	Maximum length: 500
query.id	string	Required within parent	Maximum length: 1000
query.name	string	Required within parent	Maximum length: 150

Response

Response media type: application/octet-stream. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	string	Root	Represents the binary content of the requested email attachment, returned as an octet stream. Format: binary

Policy, approvals and errors

SDK function policy ID: zoho.downloademailattachments. Catalog operation: downloadEmailAttachments. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source