new Pop3(host, port, useSsl)
Classe que implementa um cliente do protocolo POP3 - Post Office Protocol Version 3(RFC 1939)
Parameters:
Name | Type | Description |
---|---|---|
host |
string | Nome do host ou endereço IP do servidor POP3 |
port |
number | Número da porta do servidor POP3 |
useSsl |
boolean | Se true, a comunicação entre o Engine e o servidor POP3 será feita através de um canal seguro SSL/TLS. |
Example
var pop3 = new Pop3("pop.gmail.com", 995, true) pop3.login("enginePop3", "xxxxxx") var emailSource = pop3.retrieve( 1 ) var emailMessage = new EmailMessage() emailMessage.decode( mailSource ) var parte1 = emailMessage.messagesParts[0].content var parte2 = emailMessage.messagesParts[1].content var parte3 = emailMessage.messagesParts[2].content
Members
-
authCommand :AuthMode
-
Define a forma de autenticação junto ao servidor de POP3.
Type:
- AuthMode
-
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
-
<readonly> host :string
-
Nome do host ou endereço IP do servidor de POP3.
Type:
- string
-
<readonly> port :number
-
Número da porta que o servidor de POP3 está atendendo requisições.
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
-
<readonly> useSsl :boolean
-
Indica que a conexão com o servidor POP3 utiliza um canal seguro
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 se a autenticação foi realizada com sucesso
- Type
- boolean
Example
var pop3 = new Pop3( "pop.gmail.com", 995, true ) pop3.login( "enginePop3", "xxxxxx" )
-
logout()
-
Encerra a sessão com o servidor de POP3 e efetiva a marcação de mensagens como lidas ou excluída.
Returns:
true se a sessão foi encerrada com sucesso
- 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 ocorra 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
- 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.
Returns:
Um objeto com as informações do servidor. As mensagens marcadas como excluídas não são contabilizadas pelo status.
- Type
- ServerStatus
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