IMAP_GetMessage

4D Internet Commands v16

IMAP_GetMessage


IMAP_GetMessage ( imap_ID ; numMsg ; offset ; longitude ; parteMsg ; textoMsg {; actSeen} ) -> Resultado

Parâmetro	Tipo	Descrição
imap_ID	Inteiro longo	Referencia de conexão IMAP
numMsg	Inteiro longo	Número de mensagem
offset	Inteiro longo	Caracter a partir do qual começar a recuperação
longitude	Inteiro longo	Número de caracteres a reenviar
parteMsg	Inteiro	0 = Mensagem inteiro, 1 = Cabeçalho unicamente, 2 = Corpo unicamente
textoMsg	Texto	Texto da mensagem
actSeen	Inteiro	0 = Atualizar marcador \Seen; 1= Não atualizar o marcador \Seen
Resultado	Inteiro	Código de erro

Descrição

O comando IMAP_GetMessage devolve o texto completo da mensagem identificado por numMsg na caixa de correio atual definido por IMAP_SetCurrentMB. A menos que seja especificado o contrário pelo comando IMAP_SetPrefs, serão eliminados os caracteres de salto de linha na mensagem.

O comando IMAP_GetMessage devolve toda mensagem, incluindo a informação do cabeçalho ou unicamente uma parte da mensagem (cabeçalho ou corpo) em função do valor do parâmetro parteMsg.

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. Este número representa a posição de uma mensagem dentro da lista atual das mensagens. Atenção, o numMsg de uma mensagem não é um valor estável, difere de uma sessão a outra.

offset é um valor inteiro longo que indica a posição do caractere a partir do qual começar a leitura. Na maioria dos casos passe zero neste parâmetro.

O parâmetro longitude é um valor inteiro longo que indica o número de caracteres a recuperar além da posição offset. Dado que a longitude máxima de uma variável de tipo texto 4D está limitada a 32.000 caracteres, o parâmetro longitude deve ser inferior a 32.000. As partes de mensagens a recuperar cujo tamanho seja maior que 32 K devem ser guardadas no disco mediante o comando IMAP_Download.

parteMsg indica a parte da mensagem a recuperar. Podem passar os valores 0, 1 ou 2:

0 = Todo a mensagem,
1 = Só o cabeçalho,
2 = Corpo unicamente (ou seja a partir do primeiro Texto/plano encontrado).

Quando recupera a mensagem inteiro ou unicamente o cabeçalho, recupera texto bruto não decodificado. Por outra parte, ao recuperar só o corpo, o texto obtido se decodifica automaticamente e caso seja necessário se converte (ver POP3_Charset para obter mais informação sobre as regras de decodificação e conversão).

actSeen é um valor inteiro que indica se o marcador \Seen deve ser agregado ou não aos marcadores da mensagem. Este parâmetro é opcional e se utiliza o valor por padrão se não passa este parâmetro.

0 = Adicionar o marcador \Seen (valor por padrão);
1= Não adicionar o marcador \Seen;

textoMsg é uma variável texto que recebe o texto recuperado.

Ver também

IMAP_Download
IMAP_Login
IMAP_SetCurrentMB
IMAP_SetPrefs