IMAP_MsgLst

4D Internet Commands v16

IMAP_MsgLst


IMAP_MsgLst ( imap_ID ; primeMsg ; ultimaMsg ; arrayCabeMsg ; arrayNumMsg ; arrayIdMsg ; arrayValorMsg ) -> 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
arrayCabeMsg	Array string	Array de cabeçalhos a recuperar
arrayNumMsg	Array inteiro longo	Array dos números de mensagens
arrayIdMsg	Array inteiro longo	Array ID únicos
arrayValorMsg	2D String array, Array texto 2D	Array 2D dos valores dos cabeçalhos
Resultado	Inteiro	Código de erro

Descrição

O comando IMAP_MsgLst se utiliza para obter informação específica sobre o conteúdo das caixas de correio. Permite ao usuário solicitar colunas específicas da lista de mensagens. Este comando só pode devolver os valores dos cabeçalhos, não pode ser utilizado para recuperar o corpo de uma mensagem. O conteúdo dos cabeçalhos é decodificado automaticamente e convertido se é necessário (ver a descrição do comando POP3_Charset para obter mais informação sobre a decodificação e as regras de conversão).

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 todos 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.

arrayCabeMsg é um array alfanumérico ou texto que lista os cabeçalhos a recuperar.

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

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

arrayValorMsg recebe os dados para cada cabeçalho especificado por arrayCabeMsg. A cada cabeçalho solicitado lhe corresponde uma linha do array arrayValorMsg.

Exemplo

 aHeaders{1}:="Date:"

 aHeaders{2}:="From:"

 aHeaders{3}:="Subject:"

 IMAP_MsgLst(IMAP_ID;vStart;vEnd;aHeaders;aMsgNum;aMsgId;aValues)

aValues{1}{1} contém por exemplo “Quinta, 19 de novembro 00:24:02 -0800”
aValues{2}{1} contém por exemplo “Jack@4d.com”
aValues{3}{1} contém por exemplo “Chame a sua esposa”

Os erros são tratados desta forma:

1) Só são devolvidos os códigos de erro relacionados com a comunicação. Se o comando não pode completar sua tarefa devido a um erro (rede, sintaxes, servidor, etc.), é devolvido o código de erro correspondente.

2) Se uma mensagem dentro do intervalo especificado de mensagens não existe ou contém um erro:

Não é criado nenhum elemento do array para essa mensagem.
Não é devolvido nenhum código de erro.

3) A impossibilidade de localizar um ou vários cabeçalhos em uma mensagem não constitui um erro:

Um elemento do array é criado para a mensagem.
Os elementos dos arrays aMsgNum e aMsgId contém os valores apropriados.
Para cada cabeçalho que não existe na mensagem, será devolvida uma cadeia vazia nesse elemento do array.
Não é devolvido nenhum código de erro.

Ver também

IMAP_MsgLstInfo