IMAP_CopyToMB

4D v19

IMAP_CopyToMB


IMAP_CopyToMB ( imap_ID ; primeMsg ; ultimaMsg ; nomCaixCoObjet ; apagarMsg ) -> 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
nomCaixCoObjet	Texto	Nome da caixa de correio de destino
apagarMsg	Inteiro	0= Não eliminar da caixa de correio fonte, 1= Eliminar da caixa de correio fonte
Resultado	Inteiro	Código de erro

Descrição

O comando IMAP_CopyToMB copia as mensagens no intervalo de primeMsg a ultimaMsg ao final da caixa de correio de destino nomCaIxCoObjet. Os marcadores e datas internas das mensagens geralmente se conservam na caixa de correio de destino, em função da implementação do servidor IMAP.

Depois da copia, as mensagens originais não são eliminadas da caixa de correio fonte. Se deseja eliminar eles, pode utilizar um dos seguintes três processos:

Utilizar o comando IMAP_Delete,
Passar o valor 1 no parâmetro opcional apagarMsg,
localizar o marcador IMAP_SetFlags (\Deleted): as mensagens são eliminadas quando é fechada a sessão.

Nota: O parâmetro apagarMsg obriga a execução de IMAP_Delete; portanto, a eliminação incluirá as mensagens entre primeMsg e ultimoMsg e TODAS as mensagens com o marcador \Deleted.

Se a caixa de correio de destino não existe, é devolvido um erro.

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 copiar. 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 identificado por imap_ID.

ultimaMsg é um número inteiro longo que indica o número da último mensagem a copiar. 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 identificada por imap_ID.

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 ultimaMsg. Em caso de que isto passe, o comando não faz nada.

nomCaixCoObjet é o nome completo da caixa de correio aonde vão ser copiadas as mensagens.

O parâmetro opcional apagarMsg permite indicar se deseja eliminar a mensagem da caixa de correio de origem.
• 0= Não eliminar as mensagens (valor por padrão);
• 1= Apagar as mensagens.

Se omitido apagarMsg é utilizado o valor por padrão.

Se a copia falha, a mensagem não é eliminada da caixa de correio de origem.

Se o usuário não tem direitos de acesso suficientes para eliminar as mensagens, é gerada uma mensagem de erro.

Ver também

IMAP_CreateMB
IMAP_ListMBs
IMAP_RenameMB