IMAP
Recurso de consulta da caixa de e-mails através do IMAP.
close
_imap.close() : void
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
Retorno
( IMAP )
deletedSize
_imap.deletedSize() : int
Retorno
( int )
enabled
_imap.enabled() : boolean
Retorno
( boolean )
_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
Retorno
( org.netuno.psamata.mail.IMAPClient )
getConfig
_imap.getConfig() : IMAPConfig
Descrição
Obtém a configuração que está a ser utilizada.
Retorno
( IMAPConfig )
Objeto da configuração ativa.
getMail
_imap.getMail(position: int) : org.netuno.psamata.mail.Mail
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
position | int |
Retorno
( org.netuno.psamata.mail.Mail )
getMails
_imap.getMails() : java.util.List
Retorno
( java.util.List )
_imap.getMails(start: int, end: int) : java.util.List
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
start | int | |
end | int |
Retorno
( java.util.List )
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.
_imap.mail(position: int) : org.netuno.psamata.mail.Mail
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
position | int |
Retorno
( org.netuno.psamata.mail.Mail )
mails
_imap.mails() : java.util.List
Retorno
( java.util.List )
_imap.mails(start: int, end: int) : java.util.List
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
start | int | |
end | int |
Retorno
( java.util.List )
newSize
_imap.newSize() : int
Retorno
( int )
openFolder
_imap.openFolder(name: string) : IMAP
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
name | string |
Retorno
( IMAP )
_imap.openFolder(name: string, write: boolean) : IMAP
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
name | string | |
write | boolean |
Retorno
( IMAP )
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
Retorno
( int )
unreadSize
_imap.unreadSize() : int
Retorno
( int )
with
_imap.with(smtp: SMTP) : IMAP
Atributos
NOME | TIPO | DESCRIÇÃO |
---|---|---|
smtp | SMTP |
Retorno
( IMAP )