IMAP
Mailbox query capability through IMAP.
close
_imap.close() : void
Return
( void )
config
_imap.config() : IMAPConfig
Description
Starts a new configuration of its own.
Return
( IMAPConfig )
Configuration object loaded from received data.
_imap.config(config: Values) : IMAPConfig
Description
Starts a new configuration of its own.
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
config | Values | Configuration definition data structure. |
Return
( IMAPConfig )
Configuration object loaded from received data.
_imap.config(config: IMAPConfig) : IMAP
Description
Define outra configuração que deve ser utilizada.
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
config | IMAPConfig | Definition of the new configuration. |
Return
( IMAP )
Current IMAP object.
connect
_imap.connect() : IMAP
Return
( IMAP )
deletedSize
_imap.deletedSize() : int
Return
( int )
enabled
_imap.enabled() : boolean
Return
( boolean )
_imap.enabled(enabled: boolean) : IMAP
Description
Sets whether it is enabled.
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
enabled | boolean | Whether it is active or inactive. |
Return
( IMAP )
Current IMAP object.
getClient
_imap.getClient() : org.netuno.psamata.mail.IMAPClient
Return
( org.netuno.psamata.mail.IMAPClient )
getConfig
_imap.getConfig() : IMAPConfig
Description
Gets the configuration that is being used.
Return
( IMAPConfig )
Object of the active configuration.
getMail
_imap.getMail(position: int) : org.netuno.psamata.mail.Mail
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
position | int |
Return
( org.netuno.psamata.mail.Mail )
getMails
_imap.getMails() : java.util.List
Return
( java.util.List )
_imap.getMails(start: int, end: int) : java.util.List
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
start | int | |
end | int |
Return
( java.util.List )
init
_imap.init() : IMAP
Description
Starts a new instance of IMAP using the IMAP configuration of the default
key.
Return
( IMAP )
The new instance of the IMAP resource based on the default
IMAP configuration.
_imap.init(configKey: string) : IMAP
Description
Starts a new instance of IMAP from a specific configuration.
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
configKey | string | Key of the IMAP configuration that will be used. |
Return
( IMAP )
The new instance of the IMAP resource based on the specified IMAP configuration.
_imap.init(config: IMAPConfig) : IMAP
Description
Starts a new instance of IMAP from a configuration that is defined in its own configuration object.
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
config | IMAPConfig | Configuration that will be used. |
Return
( IMAP )
The new instance of the IMAP resource based on the defined configuration.
isEnabled
_imap.isEnabled() : boolean
Description
Checks if it is enabled.
Return
( boolean )
Result whether or not it is activated.
_imap.mail(position: int) : org.netuno.psamata.mail.Mail
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
position | int |
Return
( org.netuno.psamata.mail.Mail )
mails
_imap.mails() : java.util.List
Return
( java.util.List )
_imap.mails(start: int, end: int) : java.util.List
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
start | int | |
end | int |
Return
( java.util.List )
newSize
_imap.newSize() : int
Return
( int )
openFolder
_imap.openFolder(name: string) : IMAP
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
name | string |
Return
( IMAP )
_imap.openFolder(name: string, write: boolean) : IMAP
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
name | string | |
write | boolean |
Return
( IMAP )
setConfig
_imap.setConfig(config: IMAPConfig) : IMAP
Description
Define outra configuração que deve ser utilizada.
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
config | IMAPConfig | Definition of the new configuration. |
Return
( IMAP )
Current IMAP object.
setEnabled
_imap.setEnabled(enabled: boolean) : IMAP
Description
Sets whether it is enabled.
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
enabled | boolean | Whether it is active or inactive. |
Return
( IMAP )
Current IMAP object.
size
_imap.size() : int
Return
( int )
unreadSize
_imap.unreadSize() : int
Return
( int )
with
_imap.with(smtp: SMTP) : IMAP
Attributes
NAME | TYPE | DESCRIPTION |
---|---|---|
smtp | SMTP |
Return
( IMAP )