Caixa postal
As caixas postais que recebem e distribuem arquivos, os arquivos recebidos e os canais por onde eles saem: e-mail, WhatsApp, S3, SFTP e Syncthing.
Famílias nesta página
| Família | Tools | read | write | destructive |
|---|---|---|---|---|
| Caixas postais | 5 | 2 | 2 | 1 |
| Arquivos | 4 | 2 | 1 | 1 |
| Canal de e-mail | 6 | 1 | 1 | 4 |
| Canal de WhatsApp | 6 | 1 | 1 | 4 |
| Canal S3 | 6 | 1 | 2 | 3 |
| Canal SFTP | 6 | 1 | 2 | 3 |
| Canal Syncthing | 8 | 1 | 2 | 5 |
Caixas postais
Escopo: banking/mailbox.entries
| Tool | Tipo | Permissão | Espelha | O que faz |
|---|---|---|---|---|
banking_mailbox_entry_list | read | mailbox.entries.basic | GET /v2/mailbox/entries | Lists the mailbox entries (caixas postais) of the account, most recent first. |
banking_mailbox_entry_get | read | mailbox.entries.basic | GET /v2/mailbox/entries/:uid | Returns every field of one mailbox entry, with the configuration of its channels, in the same shape as the API v2. |
banking_mailbox_entry_create | write | mailbox.entries.create | POST /v2/mailbox/entries | Creates a mailbox entry (caixa postal) on the account. |
banking_mailbox_entry_update | write | mailbox.entries.update | PUT /v2/mailbox/entries/:uid | Changes the fields given of one mailbox entry; fields left out keep their value. |
banking_mailbox_entry_delete | destructive | mailbox.entries.destroy | DELETE /v2/mailbox/entries/:uid | Deletes a mailbox entry together with its channels. |
Arquivos
Escopo: banking/mailbox.files
| Tool | Tipo | Permissão | Espelha | O que faz |
|---|---|---|---|---|
banking_mailbox_file_list | read | mailbox.files.basic | GET /v2/mailbox/files | Lists the files received and sent by the mailbox entries of the account, most recent first, without their content. |
banking_mailbox_file_get | read | mailbox.files.basic | GET /v2/mailbox/files/:uid | Returns the metadata of one mailbox file (not its content), in the same shape as the API v2. |
banking_mailbox_file_update | write | mailbox.files.update | PUT /v2/mailbox/files/:uid | Changes the name, external ID, custom data or tags of one mailbox file; its content is not changed. |
banking_mailbox_file_delete | destructive | mailbox.files.destroy | DELETE /v2/mailbox/files/:uid | Deletes a mailbox file and its content. |
Canal de e-mail
Escopo: banking/mailbox.entries
| Tool | Tipo | Permissão | Espelha | O que faz |
|---|---|---|---|---|
banking_mailbox_channels_email_get | read | mailbox.entries.basic | GET /v2/mailbox/entries/:entry_uid/email | Returns the e-mail channel of a mailbox entry, with its status (pending, active, updating_password or inactive), in the same shape as the API v2. |
banking_mailbox_channels_email_create | destructive | mailbox.entries.create | POST /v2/mailbox/entries/:entry_uid/email | Adds an e-mail channel to a mailbox entry: files e-mailed from the inbox addresses arrive in the entry, and files the entry sends are e-mailed to the outbox addresses. |
banking_mailbox_channels_email_update | destructive | mailbox.entries.update | PUT /v2/mailbox/entries/:entry_uid/email | Replaces the inbox and/or outbox address lists of the e-mail channel of a mailbox entry. |
banking_mailbox_channels_email_delete | destructive | mailbox.entries.destroy | DELETE /v2/mailbox/entries/:entry_uid/email | Deletes the e-mail channel of a mailbox entry; files stop arriving through it. |
banking_mailbox_channels_email_activate | write | mailbox.entries.update | PUT /v2/mailbox/entries/:entry_uid/email/activate | Activates the e-mail channel of a mailbox entry, so files start arriving and leaving through it. |
banking_mailbox_channels_email_deactivate | destructive | mailbox.entries.update | PUT /v2/mailbox/entries/:entry_uid/email/deactivate | Deactivates the e-mail channel of a mailbox entry: files stop arriving and leaving through it. |
Canal de WhatsApp
Escopo: banking/mailbox.entries
| Tool | Tipo | Permissão | Espelha | O que faz |
|---|---|---|---|---|
banking_mailbox_channels_whatsapp_get | read | mailbox.entries.basic | GET /v2/mailbox/entries/:entry_uid/whatsapp | Returns the WhatsApp channel of a mailbox entry, with its status (pending, active, updating_password or inactive), in the same shape as the API v2. |
banking_mailbox_channels_whatsapp_create | destructive | mailbox.entries.create | POST /v2/mailbox/entries/:entry_uid/whatsapp | Adds a WhatsApp channel to a mailbox entry: files sent by the inbox phones arrive in the entry, and files the entry sends are delivered to the outbox phones. |
banking_mailbox_channels_whatsapp_update | destructive | mailbox.entries.update | PUT /v2/mailbox/entries/:entry_uid/whatsapp | Replaces the inbox and/or outbox phone lists of the WhatsApp channel of a mailbox entry. |
banking_mailbox_channels_whatsapp_delete | destructive | mailbox.entries.destroy | DELETE /v2/mailbox/entries/:entry_uid/whatsapp | Deletes the WhatsApp channel of a mailbox entry; files stop arriving through it. |
banking_mailbox_channels_whatsapp_activate | write | mailbox.entries.update | PUT /v2/mailbox/entries/:entry_uid/whatsapp/activate | Activates the WhatsApp channel of a mailbox entry, so files start arriving and leaving through it. |
banking_mailbox_channels_whatsapp_deactivate | destructive | mailbox.entries.update | PUT /v2/mailbox/entries/:entry_uid/whatsapp/deactivate | Deactivates the WhatsApp channel of a mailbox entry: files stop arriving and leaving through it. |
Canal S3
Escopo: banking/mailbox.entries
| Tool | Tipo | Permissão | Espelha | O que faz |
|---|---|---|---|---|
banking_mailbox_channels_s3_get | read | mailbox.entries.basic | GET /v2/mailbox/entries/:entry_uid/s3 | Returns the S3 channel of a mailbox entry, with its status (pending, active, updating_password or inactive), in the same shape as the API v2. |
banking_mailbox_channels_s3_create | destructive | mailbox.entries.create | POST /v2/mailbox/entries/:entry_uid/s3 | Adds an S3 channel to a mailbox entry. |
banking_mailbox_channels_s3_delete | destructive | mailbox.entries.destroy | DELETE /v2/mailbox/entries/:entry_uid/s3 | Deletes the S3 channel of a mailbox entry; files stop arriving through it. |
banking_mailbox_channels_s3_activate | write | mailbox.entries.update | PUT /v2/mailbox/entries/:entry_uid/s3/activate | Activates the S3 channel of a mailbox entry, so files start arriving and leaving through it. |
banking_mailbox_channels_s3_deactivate | destructive | mailbox.entries.update | PUT /v2/mailbox/entries/:entry_uid/s3/deactivate | Deactivates the S3 channel of a mailbox entry: files stop arriving and leaving through it. |
banking_mailbox_channels_s3_fetch | write | mailbox.entries.update | PUT /v2/mailbox/entries/:entry_uid/s3/fetch | Pulls the files waiting in the S3 inbox of a mailbox entry. |
Canal SFTP
Escopo: banking/mailbox.entries
| Tool | Tipo | Permissão | Espelha | O que faz |
|---|---|---|---|---|
banking_mailbox_channels_sftp_get | read | mailbox.entries.basic | GET /v2/mailbox/entries/:entry_uid/sftp | Returns the SFTP channel of a mailbox entry, with its status (pending, active, updating_password or inactive), in the same shape as the API v2. |
banking_mailbox_channels_sftp_create | destructive | mailbox.entries.create | POST /v2/mailbox/entries/:entry_uid/sftp | Adds an SFTP channel to a mailbox entry. |
banking_mailbox_channels_sftp_delete | destructive | mailbox.entries.destroy | DELETE /v2/mailbox/entries/:entry_uid/sftp | Deletes the SFTP channel of a mailbox entry; files stop arriving through it. |
banking_mailbox_channels_sftp_activate | write | mailbox.entries.update | PUT /v2/mailbox/entries/:entry_uid/sftp/activate | Activates the SFTP channel of a mailbox entry, so files start arriving and leaving through it. |
banking_mailbox_channels_sftp_deactivate | destructive | mailbox.entries.update | PUT /v2/mailbox/entries/:entry_uid/sftp/deactivate | Deactivates the SFTP channel of a mailbox entry: files stop arriving and leaving through it. |
banking_mailbox_channels_sftp_fetch | write | mailbox.entries.update | PUT /v2/mailbox/entries/:entry_uid/sftp/fetch | Pulls the files waiting in the SFTP inbox of a mailbox entry. |
Canal Syncthing
Escopo: banking/mailbox.entries
| Tool | Tipo | Permissão | Espelha | O que faz |
|---|---|---|---|---|
banking_mailbox_channels_syncthing_get | read | mailbox.entries.basic | GET /v2/mailbox/entries/:entry_uid/syncthing | Returns the Syncthing channel of a mailbox entry, with its status (pending, active, updating_password or inactive), in the same shape as the API v2. |
banking_mailbox_channels_syncthing_create | destructive | mailbox.entries.create | POST /v2/mailbox/entries/:entry_uid/syncthing | Adds a Syncthing channel to a mailbox entry, syncing its inbox and outbox folders with the client device given. |
banking_mailbox_channels_syncthing_update | destructive | mailbox.entries.update | PUT /v2/mailbox/entries/:entry_uid/syncthing | Changes the device name and/or device ID of the Syncthing channel of a mailbox entry. |
banking_mailbox_channels_syncthing_delete | destructive | mailbox.entries.destroy | DELETE /v2/mailbox/entries/:entry_uid/syncthing | Deletes the Syncthing channel of a mailbox entry; files stop arriving through it. |
banking_mailbox_channels_syncthing_activate | write | mailbox.entries.update | PUT /v2/mailbox/entries/:entry_uid/syncthing/activate | Activates the Syncthing channel of a mailbox entry, so files start arriving and leaving through it. |
banking_mailbox_channels_syncthing_deactivate | destructive | mailbox.entries.update | PUT /v2/mailbox/entries/:entry_uid/syncthing/deactivate | Deactivates the Syncthing channel of a mailbox entry: files stop arriving and leaving through it. |
banking_mailbox_channels_syncthing_resend_invites | destructive | mailbox.entries.update | PUT /v2/mailbox/entries/:entry_uid/syncthing/resend_invites | Shares the inbox and outbox folders with the client device again, sending new Syncthing invites to it, even when the channel is already active. |
banking_mailbox_channels_syncthing_update_status | write | mailbox.entries.update | PUT /v2/mailbox/entries/:entry_uid/syncthing/update_status | Asks the Syncthing server for the current connection status of the client device. |
Os campos de cada recurso estão na Referência da API. Uma tool que você não pode rodar não aparece em tools/list; se uma daqui não está lá, veja Autenticação.