IMAP
Recurso de consulta da caixa de e-mails através do IMAP.
close
_imap.close() : void
Descrição
Fecha e encerra a conexão com pasta IMAP atual.
Retorno
( void )
config
_imap.config() : IMAPConfig
Descrição
Inicia uma nova configuração própria.
Retorno
( IMAPConfig )
Objeto de configuração carregada a partir dos dados recebidos.
_imap.config(config: Values) : IMAPConfig
Descrição
Inicia uma nova configuração própria.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| config | Values | Estrutura de dados da definição da configuração. |
Retorno
( IMAPConfig )
Objeto de configuração carregada a partir dos dados recebidos.
_imap.config(config: IMAPConfig) : IMAP
Descrição
Define outra configuração que deve ser utilizada.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| config | IMAPConfig | Definição da nova configuração. |
Retorno
( IMAP )
Objeto IMAP atual.
connect
_imap.connect() : IMAP
Descrição
Efetua a conexão ao servidor IMAP.
Retorno
( IMAP )
Objeto IMAPClient.
deletedSize
_imap.deletedSize() : int
Descrição
Deleta as mensagens de uma pasta IMAP e retorna o tamanho (em bytes) das mensagens excluídas.
Retorno
( int )
Tamanho (em bytes) das mensagens excluídas.
enabled
_imap.enabled() : boolean
Descrição
Verifica se está habilitado.
Retorno
( boolean )
Resultado se está ou não ativado.
_imap.enabled(ativo: boolean) : IMAP
Descrição
Define se está habilitado.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| ativo | boolean | Se fica ativo ou inactivo. |
Retorno
( IMAP )
Objeto IMAP atual.
getClient
_imap.getClient() : org.netuno.psamata.mail.IMAPClient
Descrição
Retorna o objeto IMAPClient onde estão as configurações do recurso.
Retorno
( org.netuno.psamata.mail.IMAPClient )
Objeto IMAPClient.
getConfig
_imap.getConfig() : IMAPConfig
Descrição
Obtém a configuração que está a ser utilizada.
Retorno
( IMAPConfig )
Objeto da configuração ativa.
init
_imap.init() : IMAP
Descrição
Inicia uma nova instância do IMAP utilizando a configuração do IMAP da chave default.
Retorno
( IMAP )
A nova instância do recurso IMAP com base na configuração do IMAP default.
_imap.init(configKey: string) : IMAP
Descrição
Inicia uma nova instância do IMAP a partir de uma configuração específica.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| configKey | string | Chave da configuração IMAP que será utilizada. |
Retorno
( IMAP )
A nova instância do recurso IMAP com base na configuração do IMAP especificada.
_imap.init(config: IMAPConfig) : IMAP
Descrição
Inicia uma nova instância do IMAP a partir de uma configuração que é definida em um objeto de configuração própria.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| config | IMAPConfig | Configuração que será utilizada. |
Retorno
( IMAP )
A nova instância do recurso IMAP com base na configuração definida.
isEnabled
_imap.isEnabled() : boolean
Descrição
Verifica se está habilitado.
Retorno
( boolean )
Resultado se está ou não ativado.
mail
_imap.mail(posicao: int) : org.netuno.psamata.mail.Mail
Descrição
Retorna uma mensagem específica na pasta IMAP.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| posicao | int | Índice da mensagem. |
Retorno
( org.netuno.psamata.mail.Mail )
Mensagem.
mails
_imap.mails() : java.util.List<org.netuno.psamata.mail.Mail>
Descrição
Retorna todas as mensagens contidas na pasta.
Retorno
( java.util.List )
Lista de mensagens
_imap.mails(início: int, final: int) : java.util.List<org.netuno.psamata.mail.Mail>
Descrição
Retorna um intervalo específico de mensagens contidas na pasta IMAP.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| início | int | Índice da primeira mensagem. |
| final | int | Índice da última mensagem. |
Retorno
( java.util.List )
Lista de mensagens
newSize
_imap.newSize() : int
Descrição
Retorna o tamanho (em bytes) das novas mensagens (não lidas) em uma pasta IMAP.
Retorno
( int )
Tamanho (em bytes) das mensagens novas mensagens não lidas.
openFolder
_imap.openFolder(nome: string) : IMAP
Descrição
Abre a pasta INBOX do servidor (modo leitura).
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| nome | string | Nome da past INBOX. |
Retorno
( IMAP )
Recurso IMAP atual.
_imap.openFolder(nome: string, escrita: boolean) : IMAP
Descrição
Abre a pasta INBOX do servidor porém, especificando se é em modo de escrita ou não.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| nome | string | Nome da past INBOX. |
| escrita | boolean | Se é ou não em modo de escrita. |
Retorno
( IMAP )
Recurso IMAP atual.
setConfig
_imap.setConfig(config: IMAPConfig) : IMAP
Descrição
Define outra configuração que deve ser utilizada.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| config | IMAPConfig | Definição da nova configuração. |
Retorno
( IMAP )
Objeto IMAP atual.
setEnabled
_imap.setEnabled(ativo: boolean) : IMAP
Descrição
Define se está habilitado.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| ativo | boolean | Se fica ativo ou inactivo. |
Retorno
( IMAP )
Objeto IMAP atual.
size
_imap.size() : int
Descrição
Retorna o tamanho (em bytes) das mensagens de uma pasta IMAP.
Retorno
( int )
Tamanho (em bytes) das mensagens.
unreadSize
_imap.unreadSize() : int
Descrição
Retorna o tamanho (em bytes) de todas as mensagens não lidas em uma pasta IMAP.
Retorno
( int )
Tamanho (em bytes) das mensagens não lidas.
with
_imap.with(smtp: SMTP) : IMAP
Descrição
Define uma nova configuração de SMTP diferente da atual.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| smtp | SMTP | Configuração SMTP a ser usada. |
Retorno
( IMAP )
Recurso IMAP atual.