Mail

Mail

Conjunto de operações que permitem a criação de um widget de Mail para a gestão de mensagens e de contactos associados a um endereço SAPO

Subscrição gratuita

Descrição Técnica

Serviço Mail

Esta API permite gerir o serviço WebMail bem como o de contactos, ambos disponíveis no mesmo endpoint: http://services.sapo.pt/Mail Assim, será possível com esta API gerir quer a caixa de correio quer os contactos dos utilizadores.

Manual de Referência da API

Serviço Operação Descrição
Mail AddContact Adiciona um contacto à lista de contactos dos utilizadores
DeleteContact Remove um contacto da lista de contactos dos utilizadores
GetComposeURL Retorna o link para login e entrada directa na janela de compose do webmail SAPO
GetContact Devolve um contacto da lista de contactos dos utilizadores
GetLastMails Devolve os últimos emails das caixas de correio dos utilizadores (vistas, recentes, respondidas, de, data, assunto, tamanho)
GetLoginURL Retorna o link para login no webmail SAPO
GetMailbox Devolve o estado e os últimos emails das caixas de correio dos utilizadores
GetMessageURL Devolve o link para login no Webmail do SAPO com entrada directa para o email com o id indicado
GetStatus Devolve o estado das caixas de correio dos utilizadores (total, recentes e não vistas)
ListAllContacts Devolve uma lista com informação sobre os contactos (ContactId, Name, Alias, Email, HomeAddress, WorkAddress, WorkPhone, CellPhone, Fax, Title, Company, Notes, PGPPublicKey, SMimePublicKey, FreeBusyURL)
SearchContacts Devolve uma lista de contactos dada uma expressão de pesquisa
SetContact Actualiza um contacto da lista de contactos dos utilizadores

Serviço Mail

AddContact

Adiciona um contacto à lista de contactos dos utilizadores

Parâmetros do pedido

Contact : Contact (opcional)

Parâmetros de resposta

AddContactResult : string (opcional)
Voltar ao topo

DeleteContact

Remove um contacto da lista de contactos dos utilizadores

Parâmetros do pedido

ContactID : string (opcional)

Parâmetros de resposta

DeleteContactResult : boolean (opcional)
Voltar ao topo

GetComposeURL

Retorna o link para login e entrada directa na janela de compose do webmail SAPO

Parâmetros do pedido

site : string (mandatório)
mailto : string (opcional)

Parâmetros de resposta

GetComposeURLResult : string (mandatório)
Voltar ao topo

GetContact

Devolve um contacto da lista de contactos dos utilizadores

Parâmetros do pedido

ContactID : string (opcional)

Parâmetros de resposta

GetContactResult : Contact (opcional)
Voltar ao topo

GetLastMails

Devolve os últimos emails das caixas de correio dos utilizadores (vistas, recentes, respondidas, de, data, assunto, tamanho)

Parâmetros do pedido

page : int (opcional)
limit : int (opcional)
site : string (opcional)

Parâmetros de resposta

GetLastMailsResult : ArrayOfLastMail (opcional)
Voltar ao topo

GetLoginURL

Retorna o link para login no webmail SAPO

Parâmetros do pedido

site : string (mandatório)
mobile : boolean (opcional)

Parâmetros de resposta

GetLoginURLResult : string (mandatório)
Voltar ao topo

GetMailbox

Devolve o estado e os últimos emails das caixas de correio dos utilizadores

Parâmetros do pedido

page : int (opcional)
limit : int (opcional)
site : string (opcional)

Parâmetros de resposta

GetMailboxResult : Mailbox (opcional)
Voltar ao topo

GetMessageURL

Devolve o link para login no Webmail do SAPO com entrada directa para o email com o id indicado

Parâmetros do pedido

site : string (mandatório)
msgid : int (mandatório)

Parâmetros de resposta

GetMessageURLResult : string (mandatório)
Voltar ao topo

GetStatus

Devolve o estado das caixas de correio dos utilizadores (total, recentes e não vistas)

Parâmetros do pedido

site : string (opcional)

Parâmetros de resposta

GetStatusResult : Status (opcional)
Voltar ao topo

ListAllContacts

Devolve uma lista com informação sobre os contactos (ContactId, Name, Alias, Email, HomeAddress, WorkAddress, WorkPhone, CellPhone, Fax, Title, Company, Notes, PGPPublicKey, SMimePublicKey, FreeBusyURL)

Parâmetros de resposta

ListAllContactsResult : ArrayOfContact (opcional)
Voltar ao topo

SearchContacts

Devolve uma lista de contactos dada uma expressão de pesquisa

Parâmetros do pedido

SearchExpression : string (opcional)

Parâmetros de resposta

SearchContactsResult : ArrayOfContact (opcional)
Voltar ao topo

SetContact

Actualiza um contacto da lista de contactos dos utilizadores

Parâmetros do pedido

ContactID : string (opcional)
Contact : Contact (opcional)

Parâmetros de resposta

SetContactResult : boolean (opcional)
Voltar ao topo

Mail Entidades

ArrayOfContact

Nome do atributo Descrição
ContactInfo : ContactInfo
Lista de Contact : Contact
Voltar ao topo

ArrayOfLastMail

Nome do atributo Descrição
PageInfo : PageInfo
Lista de LastMail : LastMail
Voltar ao topo

Contact

Nome do atributo Descrição
ContactId : string
Name : string
Alias : string
Email : string
HomeAddress : string
WorkAddress : string
HomePhone : string
WorkPhone : string
CellPhone : string
Fax : string
Title : string
Company : string
Notes : string
PGPPublicKey : string
SMimePublicKey : string
FreeBusyURL : string
Voltar ao topo

ContactInfo

Nome do atributo Descrição
RecordsCount : int
SearchExpression : string (opcional)
Voltar ao topo

LastMail

Nome do atributo Descrição
MessageId : int
FromName : string
FromEMail : string
Subject : string
Date : string
Size : int
Seen : boolean
Recent : boolean
Answered : boolean
Deleted : boolean
Flagged : boolean
Token : string (opcional)
Voltar ao topo

Mailbox

Nome do atributo Descrição
Status : Status
ArrayOfLastMail : ArrayOfLastMail
Voltar ao topo

PageInfo

Nome do atributo Descrição
PageNumber : int
RecordsCount : int
MaxRecords : int
Voltar ao topo

Status

Nome do atributo Descrição
Total : int
Unseen : int
Recent : int
Token : string (opcional)
Voltar ao topo

Autenticação da API SOAP

Autenticação de um pedido SOAP

Cada pedido deverá conter informação de autenticação para estabelecer a identidade de quem fez o pedido e o token de autorização chamado ESB AccessKey (chave de acesso).

ESB Access Key

Inserir caminho para obter a chave de acesso.

A autorização do uso da API é efectuada através da chave de acesso (ESBAccessKey) que é disponibilizada no final do processo de compra do produto.

Na sua área de cliente encontrará nos detalhes do produto a geração de chaves de acesso que podem ser geradas para si, para outros utilizadores da API registados no SAPO Services ou então por qualquer utilizador.

O elemento "ESBAccessKey" deverá aparecer num SOAP Header da mensagem após o SOAP Header "ESBCredentials".

Exemplo:

ESBCredentials

ESBCredentials é um tipo complexo que é usado para passar as credenciais de modo a autenticar o pedido SOAP.

Elemento Descrição
ESBUsername O email da conta usada para para acederà API.
ESBPassword A palavra-passe que corresponde à conta de email especificada em ESBUsername.
ESBToken O token de acesso que representa as credenciais (ESBUsername + ESBPassword) usadas para comprar o uso da API.

Pedido com ESBUsername e ESBPassword

Pedido com ESBToken

Usar um ESBToken ao invés do ESBUsername e ESBPassword pode ser útil se não pretende dar as suas credenciais a quem está a usar a API.

Para gerar um ESBToken deverá usar o serviço SAPO STS (Security Token Service). O ESB Token é válido por 12 horas.

Obter um ESB Token:

Resposta:

Token: id42ho234iwh234odihwdw786576413a3836467b94f8c2991f(...)wdwqdqwd

Voltar ao topo