Class: Pop3

@nginstack/engine/lib/mail/Pop3~ Pop3


new Pop3(host, port, useSsl)

Classe que implementa o protocolo POP3 - Post Office Protocol Version 3(RFC 1939)

Parameters:
Name Type Description
host string

Nome do host ou número de IP da máquina hospedeira servidor de Pop3.

port number

Número da porta que o servidor de Pop3 está ouvindo requisições

useSsl boolean

Se habilitada a comunicação entre este cliente e o servidor de Pop3 será segura.

See:
Example
var pop3 = new Pop3("pop.gmail.com", 995, true)
pop3.login("enginePop3", "xxxxxx")
var mailSource = pop3.retrieve( 1 )

var mailMessage = new MailMessage()
mailMessage.decode( mailSource )

var parte1 = mailMessage.messagesParts[0].content
var parte2 = mailMessage.messagesParts[1].content
var parte3 = mailMessage.messagesParts[2].content

Members


authCommand :string

Define a forma de autenticação junto ao servidor de Pop3. Os possíveis valores são:

  1. 'PASS' - Forma menos segura, pois envia a senha do usuário sem criptografia. Todo servidor de Pop3 implementa esta forma de autenticação
  2. 'APOP' - Forma mais segura, pois envia a senha do usuário. Nem todo servidor de Pop3 implementa este tipo de autenticação
Type:
  • string

fullResult :string

Obtém o resultado devolvido pelo servidor de Pop3, excluindo a linha que indica se a operação foi executada com sucesso.

Type:
  • string

host :string

Nome do host ou número de IP da máquina hospedeira servidor de Pop3.
(somente leitura)

Type:
  • string

port :number

Número da porta que o servidor de Pop3 está ouvindo requisições.
(somente leitura)

Type:
  • number

resultString :string

Obtém a linha que indica se a operação foi executada com sucesso no servidor de Pop3.

Type:
  • string

timeout :number

Tempo limite para aguardar resposta de requisições ao servidor de Pop3.
A unidade de medida é milissegundos e o valor default é 60000ms.

Type:
  • number

useSsl :boolean

Indica que a conexão com o servidor Pop3 é segura.
(somente leitura)

Type:
  • boolean

Methods


delete(messageNumber)

Marca uma mensagem no servidor de Pop3 como excluída. A efetivação da deleção é realizada no logout()
O comando delete() não necessariamente apaga a mensagem do servidor de Pop3. Em alguns servidores a mensagem é apenas marcada como lida.

Parameters:
Name Type Description
messageNumber number

Número da mensagem no servidor Pop3.

Example
var pop3 = new Pop3( "pop.gmail.com", 995, true )
 pop3.login( "enginePop3", "xxxxxx" )
 pop3.delete(1)

list( [messageNumber])

Lista o número da mensagem e o seu respectivo tamanho em bytes em um Array. Retorna um Array de Objects, onde cada Object contém as propriedades:

  • messageNumber - Quantidade de mensagens no servidor de Pop3
  • messageSize - Somatório dos tamanhos de todas as mensagens no servidor de Pop3
Parameters:
Name Type Argument Description
messageNumber number <optional>

Número da mensagem no servidor Pop3.

Example
var pop3 = new Pop3( "pop.gmail.com", 995, true )
 pop3.login( "enginePop3", "xxxxxx" )
 var list = pop3.list()
 var result = ""
 for(var i=0; i < list.length; i++) {
   result += "tamanho da mensagem " + list[i].messageNumber +
       " em bytes = " + list[i].messageSize + " bytes.\r\n"
 }

login(username, password)

Realiza a autenticação do usuário no servidor de Pop3.

Parameters:
Name Type Description
username string

Nome do usuário no servidor de Pop3.

password string

Senha do usuário no servidor de Pop3.

Returns:

true, indicando que a autenticação foi realizada com sucesso, false, caso o contrário.

Type
boolean
Example
var pop3 = new Pop3( "pop.gmail.com", 995, true )
 pop3.login( "enginePop3", "xxxxxx" )

logout()

Fecha a sessão com o servidor de Pop3 e efetiva a marcação de mensagens como lidas ou excluída.

Returns:

true, caso a sessão seja fechada com sucesso, false, caso o contrário.

Type
boolean

noop()

O servidor de Pop3 não faz nada, apenas retorna com uma resposta positiva.

Returns:

true, caso o servidor de pop3 retorne positivamente, false, caso ocorre algum erro na comunicação com o servidor de Pop3.

Type
boolean

reset()

Se qualquer mensagem for marcada como excluída pelo servidor de Pop3, elas são desmarcadas.

Returns:

true, caso a operação de reset() seja executada com sucesso no servidor Pop3, false, caso o contrário.

Type
boolean

retrieve(messageNumber)

Obtém o conteúdo de uma mensagem do servidor de Pop3 e marca a mensagem como lida.

Parameters:
Name Type Description
messageNumber number

Número da mensagem no servidor Pop3.

Example
var pop3 = new Pop3( "pop.gmail.com", 995, true )
 pop3.login( "enginePop3", "xxxxxx" )
 pop3.retrieve(1)
 var mailSource = pop3.fullResult

status()

Obtém a quantidade de mensagens não lidas no servidor e o tamanho total das mensagens em bytes. Retorna um Object com as propriedades:

  • messagesCount - Quantidade de mensagens no servidor de Pop3
  • messagesSize - Somatório dos tamanhos de todas as mensagens no servidor de Pop3
Note que as mensagens marcadas como excluídas não são contabilizadas pelo status()
Example
var pop3 = new Pop3( "pop.gmail.com", 995, true )
 pop3.login( "enginePop3", "xxxxxx" )
 var status = pop3.status()
 var result = "Qtde Messages " + status.messagesCount + " - Tamanho: " + status.messagesSize