Overview
Visão geral shows the unread mail of the last 30 days.
- The headline line counts the unread mail and the mail that is unread for more than 15 days. Abrir caixa de entrada opens the unread mail.
- Não lidos há mais de 3 dias, Não lidos há mais de 7 dias and Não lidos há mais de 15 dias each open the matching unread mail in Caixa de entrada.
- The fold Recebidos por tipo shows the mail by type, the activity by day and Remetentes no período.
GET /api/v1/correios/dashboard/summary and GET /api/v1/correios/dashboard/categories. Both need plugin-bc-correios-viewer-group.
Mail folders
Caixa de entrada, Enviados, Arquivados and Cancelados list the mail of one folder.
- The columns include Assunto, Tipo, Remetente or Destino, Anexos and the date. Enviados also shows Transmissão.
- Buscar correios searches the subject, the sender and the content.
- Filter by Tipo (Resolução, Circular, Comunicado or Outro), Leitura (except in Enviados) and the period.
- Restaurar in the menu of a row of Arquivados moves the mail back to Caixa de entrada. Enviados and Cancelados offer no action on a row.
GET /api/v1/correios/mails, which needs plugin-bc-correios-viewer-group.
Mail detail
A row opens the mail. The screen has three tabs.
- Conteúdo shows the body of the mail.
- Anexos lists the attachments. A click downloads one with
GET /api/v1/correios/mails/{id}/attachments/{attachmentId}. - Resumo IA shows the status and the insight of the AI analysis. Reanalisar asks for a new analysis with
POST /api/v1/correios/mails/{id}/reanalyze. It needs an AI provider in Configurações.
- Opening an unread mail marks it as read with
PUT /api/v1/correios/mails/{id}/read. - Responder opens Escrever correio as a reply to the mail. A sent message has no Responder.
- Arquivar moves a mail of Caixa de entrada to Arquivados with
PUT /api/v1/correios/mails/{id}/archive. Restaurar moves it back withPUT /api/v1/correios/mails/{id}/restore. Both change the local copy of the mail only.
GET /api/v1/correios/mails/{id} and GET /api/v1/correios/mails/{id}/ai-status read the mail. plugin-bc-correios-viewer-group can read, download and mark as read. Arquivar, Restaurar and Reanalisar need plugin-bc-correios-contributor-group.
Compose
Escrever correio sends a message to a BACEN department. Fill in Assunto and Mensagem. Destino (opcional) overrides the default destination, and Palavras-chave (opcional) takes up to 10 keywords, separated by commas. Revisar envio opens the review. After you confirm, Cabine sends the message with
POST /api/v1/correios/mails/send. It needs plugin-bc-correios-contributor-group.
Audit
Auditoria lists the audit trail of the institution with the columns Quando, Ação, Correio and Operador. Filter by Ação and Período. Exportar CSV and Exportar PDF download the trail of the selected period. They need a period. Cabine calls
GET /api/v1/correios/audit and GET /api/v1/correios/audit/export. Both need plugin-bc-correios-viewer-group.
Settings
Configurações has four sections.
- Credenciais: Usuário Sisbacen, Senha Sisbacen and Destino padrão (BCB). For a stored secret, choose Manter, Substituir or Remover. Testar credenciais tests the saved credentials with
POST /api/v1/correios/settings/test-connectionand shows the Pastas autorizadas. - Coleta: Intervalo de coleta is 5, 15, 30 or 60 minutes.
- IA: Provedor, Modelo, Endpoint, Prompt de sistema and Chave da API (BYOK). Testar provedor calls
POST /api/v1/correios/settings/test-ai-connection. - Retenção: Retenção (dias) takes from 1825 to 36500 days. A shorter period lets Lerian BC Correios delete the mail and attachments older than the new period at its next retention run. Cabine saves it with
PATCH /api/v1/correios/settings/retention.
PATCH /api/v1/correios/settings. When no settings exist, the screen shows a first-run form, and Criar configuração creates them with POST /api/v1/correios/settings.
Cabine reads the settings with GET /api/v1/correios/settings, which needs plugin-bc-correios-viewer-group. Saving or creating the settings and both tests need plugin-bc-correios-editor-group.

