Expresso Web Service

Este Draft é destinado à especificação dos requisitos referentes à implementação do Web Service do Expresso. Todas as informações contidas neste documento poderão sofrer alterações sem aviso prévio, até o fechamento do escopo deste subprojeto do Expresso.

---

1. Objetivo

---

2. Compatibilidade

API: Versões > 2.2

ExpressoMail?: Versões > 2.2

ContactCenter?: Versões > 2.2

---

3. Arquitetura

---

4. Protocolo de Comunicação

JSON-RPC versão 1.0

---

5. Recursos disponíveis

I. Criar sessão autenticada no Expresso

Método: Expresso.login Formato: json-rpc

Parâmetros:

• params: array
  • user
  • password
  • auth

Resposta:

• result: array
  • auth
• error
• id

II) Finalizar sessão autenticada no Expresso

Método: Expresso.logout Formato: json-rpc

Parâmetros:

• params: array
  • auth

Resposta:

• result: array
  • message
• error
• id

III) Listar pastas de Email

Método: Mail.getUserFolders Formato: json-rpc

Parâmetros:

• params: array
  • auth

Resposta:

• result
  • folders[]
    • folderName
    • folderID
    • folderType

1 - Caixa de Entrada 2 - Enviadas 3 - Rascunhos 4 - Lixeira 5 - Pasta Comum

• folderParentID - ID da Pasta pai.
• folderHasChildren - Indica se a pasta possui ou não uma ou mais sub-pastas (0 ou 1)
• qtdMessages - Quantidade de Mensagens da Pasta
• qtdUnreadMessages - Quantidade de Mensagens Não Lidas na Pasta
• percentUsageOfTotalQuota - Percentagem total da quota utilizada pela pasta.
• diskSize - Tamanho em Bytes do espaço utilizado em Disco.

• error
• id

IV) Listar mensagens de uma pasta de Email

Parâmetros:

• params: array
  • auth
  • folderID
  • maxResult
  • itensPerPage

• method: Mail.getUserMessages

• format: json-rpc

• id: 4

Resposta:

• result

• error

• id: 4