IMAP
Mailbox query capability through IMAP.
close
_imap.close() : void
Description
Closes and terminates the connection to the current IMAP folder.
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
Description
Makes the connection to the IMAP server.
Return
( IMAP )
IMAPClient object.
deletedSize
_imap.deletedSize() : int
Description
Deletes messages from an IMAP folder and returns the size (in bytes) of deleted messages.
Return
( int )
Size (in bytes) of deleted messages.
enabled
_imap.enabled() : boolean
Description
Checks if it is enabled.
Return
( boolean )
Result whether or not it is activated.
_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
Description
Returns the IMAPClient object where the resource settings are located.
Return
( org.netuno.psamata.mail.IMAPClient )
IMAPClient object.
getConfig
_imap.getConfig() : IMAPConfig
Description
Gets the configuration that is being used.
Return
( IMAPConfig )
Object of the active configuration.
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.
mail
_imap.mail(position: int) : org.netuno.psamata.mail.Mail
Description
Returns a specific message in the IMAP folder.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| position | int | Message index |
Return
( org.netuno.psamata.mail.Mail )
Message.
mails
_imap.mails() : java.util.List<org.netuno.psamata.mail.Mail>
Description
Returns all messages contained in the folder.
Return
( java.util.List )
Message list.
_imap.mails(start: int, start: int) : java.util.List<org.netuno.psamata.mail.Mail>
Description
Returns a specific range of messages contained in the IMAP folder.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| start | int | First message index |
| start | int | Index of last message. |
Return
( java.util.List )
Message list.
newSize
_imap.newSize() : int
Description
Returns the size (in bytes) of new (unread) messages in an IMAP folder.
Return
( int )
Size (in bytes) of messages new unread messages.
openFolder
_imap.openFolder(name: string) : IMAP
Description
Opens the server's INBOX folder (reading mode).
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| name | string | INBOX folder name. |
Return
( IMAP )
Current IMAP feature.
_imap.openFolder(name: string, write: boolean) : IMAP
Description
Opens the server's INBOX folder, however, specifying whether it is in writing mode or not.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| name | string | INBOX folder name. |
| write | boolean | Whether or not it is in writing mode. |
Return
( IMAP )
Current IMAP feature.
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
Description
Returns the size (in bytes) of messages in an IMAP folder.
Return
( int )
The size (in bytes) of messages.
unreadSize
_imap.unreadSize() : int
Description
Returns the size (in bytes) of all unread messages in an IMAP folder.
Return
( int )
Size (in bytes) of unread messages.
with
_imap.with(smtp: SMTP) : IMAP
Description
Defines a new SMTP configuration different from the current one.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| smtp | SMTP | SMTP configuration to be used. |
Return
( IMAP )
Current IMAP feature.