IMAP_MsgLstInfo

4D v19

IMAP_MsgLstInfo


IMAP_MsgLstInfo ( imap_ID ; primeMsg ; ultimaMsg ; arrayTamMsg ; arrayNumMsg ; arrayIdMsg ) -> Resultado

Parâmetro	Tipo	Descrição
imap_ID	Inteiro longo	Referencia de conexão IMAP
primeMsg	Inteiro longo	Número da primeira mensagem
ultimaMsg	Inteiro longo	Número da última mensagem
arrayTamMsg	Array inteiro longo	Array de tamanhos
arrayNumMsg	Array inteiro longo	Array dos números de mensagens
arrayIdMsg	Array inteiro longo	Array dos ID únicos
Resultado	Inteiro	Código de erro

Descrição

O comando IMAP_MsgLstInfo devolve informação sobre um conjunto de mensagens na caixa de correio atual (definido pelo comando IMAP_SetCurrentMB). A informação é devolvida em três arrays, cada elemento dos arrays corresponde a uma mensagem. A informação é devolvida sobre o tamanho e o número da mensagem. Os arrays passados como parâmetros devem ser declarados previamente, ainda que podem ser de qualquer tamanho. O comando IMAP_MsgLstInfo redimensiona cada array ao número de mensagens recuperados.

O comando IMAP_MsgLstInfo não devolve um número de erro se não pode recuperar a informação em uma mensagem dentro da lista de mensagens atual. É produzido um erro, não é criado nenhum elemento nos arrays para a mensagem de problema. Se o comando lê todos as mensagens com êxito, arrayNumMsg deve conter valores numéricos em uma ordem sequencial. Em caso de problemas, se perderá a sequencia numérica de arrayNumMsg.

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

primeMsg é um número inteiro longo que especifica o número da primeira mensagem a examinar. O número de mensagem é um valor que representa a posição de uma mensagem na lista de todas as mensagens na caixa de correio de trabalho atual.

ultimaMsg é um número inteiro longo que indica o número da último mensagem a examinar. O número de mensagem é um valor que representa a posição de uma mensagem na lista de todos as mensagens na caixa de correio de trabalho atual.

Nota: Os comandos IMAP_Delete, IMAP_MsgLstInfo, IMAP_MsgLst, IMAP_SetFlags, IMAP_GetFlags e IMAP_CopyToMB não devolvem um erro se primeMsg é maior que a ultimaMsg. No caso de que isto passe, o comando não faz nada.

arrayTamMsg recebe o tamanho de cada mensagem entre primeMsg e ultimaMsg.

arrayNumMsg devolve os números das mensagens entre primeMsg e ultimaMsg.

arrayIdMsg recebe os identificadores únicos das mensagens entre primeMsg e ultimaMsg.

Ver também

IMAP_SetCurrentMB