TOTVSTEC

Árvore de páginas

Carregando...
Tempo aproximado para leitura: 2 minutos

Remove permanentemente na pasta informada todas as mensagens que contenham a flag <Deleted> definidas.

Sintaxe

Purge( < cFolder > )

Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

cFolder

caractere

Indica o nome da pasta que será realizado o purge.

X


Retorno

Nome

Tipo

Descrição

nRet

numérico

Retorna 0 (zero) quando a operação é completada com sucesso; caso contrário, retornará um código de erro.

Observações

  • Para realizar o purge não é preciso estar posicionado na pasta.
  • Utilize esse método somente para conexão IMAP.
  • Caso a conexão utilizada não seja IMAP, será retornado 1 (Operation failed).

Exemplos

#INCLUDE "TOTVS.CH"
#DEFINE EMAIL_ACCOUNT   'p10teste'
#DEFINE EMAIL_PASSWORD  '123'
#DEFINE EMAIL_SERVER    'mail.totvs.com.br'

User Function mail004()
  Local oMail := TMailMng():New( 1, 3, 3 )
  Local nRet := 0
  Local nNumMsg := 0
  
  oMail:cUser := EMAIL_ACCOUNT
  oMail:cPass := EMAIL_PASSWORD
  oMail:cSrvAddr := EMAIL_SERVER
  
  nRet := oMail:Connect()
  if nRet <> 0
    conout( nret )
    conout( oMail:GetErrorString( nret ) )
    return
  endif
  
  nRet := oMail:Purge( "myfolder" )
  if nRet <> 0
    conout( nRet )
    conout( oMail:GetErrorString( nRet ) )
  endif
  
  oMail:Disconnect()
return
  • Sem rótulos