IMAP_GetMBStatus

4D Internet Commands v16

IMAP_GetMBStatus


IMAP_GetMBStatus ( imap_ID ; nomCaixaCorreio ; numMsg ; numNovaMsg ; numMsgNaoLido ; unicoIDB ) -> Resultado

Parâmetro	Tipo	Descrição
imap_ID	Inteiro longo	Referencia de conexão IMAP
nomCaixaCorreio	Texto	Nome da caixa de correio
numMsg	Inteiro longo	Número de mensagens na caixa de correio especificada
numNovaMsg	Inteiro longo	Número de mensagens com o marcador \Recent
numMsgNaoLido	Inteiro longo	Número de mensagens sem o marcador \Seen
unicoIDB	Inteiro longo	Número de identificação único da caixa de correio especificada
Resultado	Inteiro	Código de erro

Descrição

O comando IMAP_GetMBStatus devolve o estado dos parâmetros da caixa de correio especificada por nomCaixaCorreio. Não muda a caixa de correio atual (ver IMAP_SetCurrentMB), nem afeta o estado das mensagens na caixa especificada (particularmente, geralmente não apaga os marcadores \Recent, mas isto pode variar em função dos parâmetros do servidor IMAP4). Este comando alternativo permite obter o estado dos parâmetros sem desativar a caixa de correio atual.

Este comando é particularmente útil para:

Verificar ou recuperar o número de identificação único de uma caixa de correio,
Verificar as mensagens recentes ou não lidas de uma caixa de correio sem abrir uma sessão especifica.

Importante: Lhe recomendamos não chamar o comando IMAP_GetMBStatus utilizando a caixa de correio atual. Desta maneira, pode encontrar problemas e a informação devolvida pode não estar sincronizada com o estado da caixa de correio atual (particularmente para os novos e-mails).

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

nomCaixaCorreio é o nome completo da caixa de correio existente para o que deseja obter os parâmetros de estado.

Nota: A diferença do comando IMAP_ListMBs, o parâmetro nomCaixaCorreio não aceita caracteres coringa.

numMsg devolve o número de mensagens na caixa de correio atual (devolve -1 no caso de erro).

numNovaMsg devolve o número de mensagens recentes na caixa de correio atual (devolve -1 no caso de erro).

numMsgNaoLido devolve o número de mensagens não lidos na caixa de correio atual (devolve -1 no caso de erro)

unicoIDB devolve o número de identificação único da caixa de correio (devolve -1 no caso de erro).

Com o protocolo IMAP4, o nome da caixa de correio não é suficiente para identificar a uma caixa de correio. Portanto, um identificador único valor é associado a cada caixa de mensagem. Este identificador é particularmente valioso para a sincronização de tarefas.
Desta forma, pode comprovar se a caixa de correio "A" foi renomeado como "B" ou eliminado, simplesmente verificando seu número de identificação único.
Por outra parte, este identificador permite comprovar se uma caixa de mensagem chamado "A" foi eliminado e se criou outra caixa de mensagem "A".

Ver também

IMAP_GetFlags
IMAP_ListMBs
IMAP_SetCurrentMB
IMAP_SetFlags