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

Método:	Expresso.login	Criar sessão autenticada no Expresso
Parâmetros:	-user -password -auth	-Login do Usuario. -Senha do usuario. -Autenticacao existente, caso ja esteja logado.
Retorno:	-auth	-auth: Chave de autenticacao do expresso (KP3 do usuario).

Método:	Expresso.logout	Finalizar sessão autenticada no Expresso
Parâmetros:	-auth	-Autenticacao existente, necessaria para destruir a sessao do usuario.
Retorno:	-hasLogout	-hasLogout:(Boolean 0 ou 1 indicando se o logout foi realizado com sucesso)

Método:	Mail.getUserFolders	Listar pastas de Email
Parâmetros:	-auth -search -page -resultsPerPage	auth:Autenticacao do usuario. search:filtro por nome de pasta page:pagina atual resultsPerPage:Numero de resultados a retornar por pagina.
Retorno:	-folders(folderName,folderID,folderType,folderParentID,folderHasChildren,qtdMessages,qtdUnreadMessages,percentUsageOfTotalQuota,diskSize)	-folders:Array com todas as pastas retornadas. folderName:Nome da pasta. folderID:Caminho da pasta folderType:(1-Caixa de Entrada,2-Enviadas,3-Rascunhos,4-Lixeira,5-Pasta Comum,6-Pasta Compartilhada) folderHasChildren:(Boolean 0 ou 1)Indica se a pasta possui sub-pastas ou nao. qtdMessages:Quantidade de Mensagens na pasta. qtdUnreadMessages:Quantidade de Mensagens nao lidas. percentUsageOfTotalQuota:Percentual utilizado da quota do usuario para esta pasta. diskSize:Tamanho total da pasta utilizado do disco em Bytes.

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