Desativar o Drive de uma caixa postal pela API
Defina o Drive como completo, apenas anexos ou desativado com uma chamada REST ou ferramenta MCP, para uma caixa postal, um domínio ou toda a conta.
Detalhes do artigo
Tipo, dificuldade, planos e data da última atualização.
▼
Detalhes do artigo
Tipo, dificuldade, planos e data da última atualização.
- Tipo
- Referência
- Dificuldade
- Intermediário
- Planos
- Starter · Pro · Agency
- Última atualização
- 10 de set de 2026
O armazenamento é compartilhado por toda a conta. Portanto, quando uma pessoa trata o Drive como armazenamento pessoal na nuvem, ela consome o espaço de que todos os outros precisam para o e-mail. Cada caixa postal tem um nível drive_access que decide quanto do Drive seu usuário pode acessar. Esta página é a referência de comandos para configurar esse nível.
A mesma configuração fica no painel, em Caixas postais → (uma caixa postal) → Limites. Ela está disponível em todos os planos e não tem custo adicional.
Os três níveis
| Valor | Drive no webmail | Envio de arquivo acima do limite de anexo | Sincronização com um computador |
|---|---|---|---|
full |
Sim: navegar, enviar, compartilhar e pesquisar | É enviado como link de download e mantido indefinidamente | Sim |
attachments_only |
Não | Continua sendo enviado como link de download; essa cópia é excluída após o período de retenção | Não |
disabled |
Não | É recusado: o remetente é informado de que o arquivo é grande demais | Não |
full é o padrão e é o nível de todas as caixas postais existentes. O recebimento nunca é afetado: um anexo grande que alguém envie para a caixa postal abre no webmail como sempre, em qualquer nível.
Escopo necessário
mailboxes:write, o mesmo escopo que atualiza qualquer outro campo da caixa postal. Os dois endpoints abaixo aceitam um cabeçalho Idempotency-Key e podem ser repetidos com segurança.
Uma caixa postal
curl -s -X PATCH "https://trekmail.net/api/v1/mailboxes/{MAILBOX_ID}" \
-H "Authorization: Bearer tm_live_your_token" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: drive-access-{MAILBOX_ID}-off" \
-d '{"drive_access":"disabled"}'
A caixa postal atualizada é retornada com o novo nível:
{ "data": { "id": 1701, "email": "sam@example.com", "drive_access": "disabled", "...": "..." } }
drive_access também é retornado por GET /api/v1/mailboxes/{id} e pelo endpoint de listagem. Assim, você pode auditar o valor configurado sem alterar nada.
Várias caixas postais de uma vez
curl -s -X POST "https://trekmail.net/api/v1/mailboxes:drive-access" \
-H "Authorization: Bearer tm_live_your_token" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: drive-access-domain-123-off" \
-d '{"domain_id":123,"drive_access":"disabled"}'
Forneça exatamente um seletor:
| Seletor | Quando usar |
|---|---|
"mailbox_ids": [12, 34] |
Um grupo específico, com até 1000 por chamada |
"domain_id": 123 |
Um domínio inteiro; use quando um domínio corresponder a um cliente |
"all": true |
Todas as caixas postais da conta |
A resposta informa o que aconteceu:
{ "data": { "drive_access": "disabled", "matched": 24, "updated": 21, "skipped_shared": 3 } }
matched é o número de caixas postais encontradas pelo seletor, e updated é o número que realmente mudou. Caixas postais que já estão no nível solicitado são encontradas, mas não atualizadas. Por isso, repetir a chamada é inofensivo. Isso é útil ao aplicar periodicamente um padrão às caixas postais novas.
Aplicação a novas caixas postais
A criação de caixas postais não aceita drive_access; as novas caixas começam com full. Para provisionar uma caixa postal que nunca teve Drive, crie-a e depois defina o nível:
# 1. Create the mailbox. The server generates the one-time password and returns it once.
curl -s -X POST "https://trekmail.net/api/v1/mailboxes" \
-H "Authorization: Bearer tm_live_your_token" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: create-mailbox-sam" \
-d '{"domain_id":123,"local_part":"sam","password_mode":"generated_one_time"}'
# 2. Turn off Drive using the id returned above.
curl -s -X PATCH "https://trekmail.net/api/v1/mailboxes/1701" \
-H "Authorization: Bearer tm_live_your_token" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: drive-access-1701-off" \
-d '{"drive_access":"disabled"}'
Se você criar caixas postais em lotes, o padrão mais simples é criar todas elas e depois fazer uma única chamada em massa com domain_id.
Com um agente MCP
set_mailboxes_drive_access(domain_id=123, drive_access="disabled")
A ferramenta aceita os mesmos três seletores que o endpoint REST e retorna as mesmas contagens. Para uma única caixa postal, update_mailbox(mailbox_id=1701, drive_access="disabled") também funciona.
Caixas postais compartilhadas
O endpoint individual recusa caixas postais compartilhadas com 422 drive_access_not_applicable. O endpoint em massa ignora essas caixas, mas ainda as inclui na contagem. Ninguém entra diretamente em uma caixa postal compartilhada: sua equipe a abre a partir da própria caixa postal, portanto o nível da caixa desse membro é aplicado. Uma pessoa cujo Drive foi desativado não pode acessar os arquivos de uma caixa compartilhada nem usá-la para contornar a configuração.
O que uma caixa postal restrita vê
A restrição é aplicada em todos os lugares, e não apenas ocultada na interface:
- o espaço do Drive não aparece em
GET /api/v1/drive/spaces - os arquivos respondem com
404quando solicitados por id - não é possível criar um dispositivo de sincronização para ela;
POST /api/v1/drive/devicesretorna422 drive_disabled - no webmail, não há Drive na barra lateral, envio por arrastar e soltar nem resultados do Drive na pesquisa
Nada é excluído quando você muda o nível. Os arquivos já armazenados continuam onde estão e a pessoa simplesmente não consegue acessá-los. Isso também significa que desativar o Drive não devolve o espaço por conta própria. A guia Limites do painel mostra o que uma caixa postal está armazenando e pode excluir esses arquivos permanentemente caso você queira recuperar o espaço.
Erros que podem ocorrer
| Resposta | Significado |
|---|---|
422 drive_access_not_applicable |
A caixa postal é compartilhada; defina o nível nas caixas postais dos membros |
Erro de validação 422 |
Há mais de um seletor, ou nenhum, no endpoint em massa |
403 |
O token não tem mailboxes:write |
Artigos relacionados
Vá para guias próximos que dão continuidade ao fluxo de trabalho.