IMAP_Download

4D Internet Commands v16

IMAP_Download


IMAP_Download ( imap_ID ; numMsg ; cabeApenas ; nomeArquivo ; actSeen ) -> Resultado

Parâmetro	Tipo	Descrição
imap_ID	Inteiro longo	Referencia de conexão IMAP
numMsg	Inteiro longo	Número da mensagem
cabeApenas	Inteiro	0 = Mensagem inteiro, 1 = Cabeçalho unicamente
nomeArquivo	Texto	Nome do arquivo local
		Nome do arquivo local utilizado
actSeen	Inteiro	0 = Adicionar marcador \Seen; 1= Não adicionar o marcador \Seen
Resultado	Inteiro	Código de erro

Descrição

O comando IMAP_Download está desenhado para recuperar uma mensagem de um servidor IMAP, gravando no disco local. Toda mensagem IMAP que contém arquivos adjuntos ou cujo tamanho é maior a 32 K deve ser descarregado com este comando. Os arquivos adjuntos só podem ser extraídos das mensagens recuperadas desta maneira.

imap_ID é uma referencia inteiro longo a uma conexão aberta criada com IMAP_Login.

numMsg é um valor inteiro longo que indica qual mensagem na caixa de correio recuperar. numMsg representa a posição de uma mensagem dentro da lista atual de mensagens. O numMsg de uma mensagem não é um valor estável, difere de uma sessão a outra.

cabeApenas é um valor inteiro que indica se deve recuperar todo a mensagem ou só a informação do cabeçalho.

nomArquivo contém o nome do arquivo e a rota de acesso opcional onde deseja guardar a mensagem. Este valor pode ser especificado de três formas diferentes:

"" = Guarda o arquivo na pasta definida por IMAP_SetPrefs, com o nome "temp1" (se um arquivo com o mesmo nome já existe, os nomes de arquivo "temp2", "temp3", etc. serão utilizados até que se encontre um nome de arquivo sem utilizar).
"NomeArquivo" = Guarda o arquivo na pasta definida por IMAP_SetPrefs com o nome nomeArquivo.
"Rota:nomeArquivo" = Guarda o arquivo na rota especificada com o nome nomeArquivo.

Nos dois primeiros casos, se IMAP_SetPrefs, não especifica nenhuma pasta, a mensagem será guardada na mesma pasta que a estrutura da base de dados (com 4D autônomo) ou na pasta 4D Client (com 4D Server).

Depois de que o arquivo é guardado no disco, o nome final do arquivo é devolvido no parâmetro nomeArquivo. Se tenta chamar a IMAP_Download com um nome de arquivo que já existe dentro da pasta de descarrega, o nome é incrementado numericamente e seu novo valor como é guardado no disco será devolvido à variável nomeArquivo.

actSeen é um valor inteiro que indica se o marcador \Seen deve ser agregado à lista de marcadores da mensagem. Este parâmetro é opcional e se utiliza um valor por padrão se não é passado este parâmetro:

0 = Adicionar o marcador \Seen
1 = Não adicionar o marcador \Seen

O valor por padrão é 0 o que significa implicitamente, adicionar o marcador \Seen.

Ver também

IMAP_GetMessage
IMAP_SetPrefs