IMAPConfig
Configuring IMAP Configuration.
getAuthMechanisms
getAuthMechanisms() : string
Description
Returns which authentication mechanisms are being used in the current configuration.
Return
( string )
Authentication mechanisms used in the current configuration.
getAuthNTLMDomain
getAuthNTLMDomain() : string
Description
Returns the NTLM domain used in the current configuration.
Return
( string )
The NTLM domain.
getHost
getHost() : string
Description
Returns the current configuration host.
Return
( string )
Host of the current configuration.
getPassword
getPassword() : string
Description
Returns the current configuration password.
Return
( string )
Password.
getPort
getPort() : int
Description
Returns the current configuration port.
Return
( int )
Port of the current configuration.
getProtocol
getProtocol() : string
Description
Returns the name of the protocol used in the current configuration.
Return
( string )
Current configuration protocol name.
getSocketFactoryClass
getSocketFactoryClass() : string
Description
Returns the socketFactory class of the current configuration.
Return
( string )
Current configuration socketFactory class name
getSocketFactoryPort
getSocketFactoryPort() : int
Description
Returns the socketFactory port of the current configuration.
Return
( int )
Current configuration socketFactory port.
getUsername
getUsername() : string
Description
Returns the current configuration username.
Return
( string )
Username.
isDebug
isDebug() : boolean
Description
Returns whether the current object is in debug mode active.
Return
( boolean )
Whether it is active or not.
isEnabled
isEnabled() : boolean
Description
Returns whether the current configuration is active.
Return
( boolean )
Whether it is active or not.
isQuitWait
isQuitWait() : boolean
Description
Returns whether in the current configuration the client should wait for the server's response to the QUIT command before closing the connection.
Return
( boolean )
Whether or not to wait for a response.
isSSL
isSSL() : boolean
Description
Returns whether SSL is enabled in the current configuration.
Return
( boolean )
Whether or not it is active.
isSocketFactoryFallback
isSocketFactoryFallback() : boolean
Description
Returns whether the configuration should attempt to use the system default SocketFactory if the specified SocketFactory fails.
Return
( boolean )
Whether or not it will be used.
isTLS
isTLS() : boolean
Description
Returns whether TLS is enabled in the current configuration.
Return
( boolean )
Whether or not it is active.
setAuthMechanisms
setAuthMechanisms(authMechanisms: string) : IMAPConfig
Description
Defines which authentication mechanisms will be used in the current configuration.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| authMechanisms | string | Authentication mechanisms to be used in the current configuration. |
Return
( IMAPConfig )
Current IMAPConfig object.
setAuthNTLMDomain
setAuthNTLMDomain(authNTLMDomain: string) : IMAPConfig
Description
Defines the NTLM domain in the current configuration.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| authNTLMDomain | string | The NTLM domain. |
Return
( IMAPConfig )
Current IMAPConfig object.
setDebug
setDebug(debug: boolean) : IMAPConfig
Description
Defines whether the current object is in debug mode active.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| debug | boolean | Whether it is active or not. |
Return
( IMAPConfig )
Current IMAPConfig object.
setEnabled
setEnabled(enabled: boolean) : IMAPConfig
Description
Defines whether the current configuration is active.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| enabled | boolean | Whether it is active or not. |
Return
( IMAPConfig )
Current IMAPConfig object.
setHost
setHost(host: string) : IMAPConfig
Description
Defines the host of the current configuration.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| host | string | Host to be defined. |
Return
( IMAPConfig )
Current IMAPConfig object.
setPassword
setPassword(password: string) : IMAPConfig
Description
Defines the current configuration password.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| password | string | Password. |
Return
( IMAPConfig )
Current IMAPConfig object.
setPort
setPort(port: int) : IMAPConfig
Description
Defines the port of the current configuration.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| port | int | Port to be defined. |
Return
( IMAPConfig )
Current IMAPConfig object.
setProtocol
setProtocol(protocol: string) : IMAPConfig
Description
Defines the protocol used in the current configuration.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| protocol | string | Protocol to be defined. |
Return
( IMAPConfig )
Current IMAPConfig object.
setQuitWait
setQuitWait(quitWait: boolean) : IMAPConfig
Description
Defines whether in the current configuration the client must wait for the server's response to the QUIT command before closing the connection.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| quitWait | boolean | Whether or not to wait for a response. |
Return
( IMAPConfig )
Current IMAPConfig object.
setSSL
setSSL(ssl: boolean) : IMAPConfig
Description
Defines whether SSL is enabled in the current configuration.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| ssl | boolean | Whether or not it is active. |
Return
( IMAPConfig )
Current IMAPConfig object.
setSocketFactoryClass
setSocketFactoryClass(socketFactoryClass: string) : IMAPConfig
Description
Defines the name of the class to be used in the current configuration's SocketFactory.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| socketFactoryClass | string | Name of the class to be used in the current configuration's SocketFactory. |
Return
( IMAPConfig )
Current IMAPConfig object.
setSocketFactoryFallback
setSocketFactoryFallback(ssl: boolean) : IMAPConfig
Description
Defines whether the configuration should attempt to use the system default SocketFactory if the specified SocketFactory fails.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| ssl | boolean | Whether or not it will be used. |
Return
( IMAPConfig )
Current IMAPConfig object.
setSocketFactoryPort
setSocketFactoryPort(socketFactoryPort: int) : IMAPConfig
Description
Defines the port to be used in the current configuration's SocketFactory.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| socketFactoryPort | int | Port to be used in the current configuration's SocketFactory. |
Return
( IMAPConfig )
Current SMTPConfig object.
setTLS
setTLS(ssl: boolean) : IMAPConfig
Description
Defines whether TLS is enabled in the current configuration.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| ssl | boolean | Whether or not it is active. |
Return
( IMAPConfig )
Current IMAPConfig object.
setUsername
setUsername(username: string) : IMAPConfig
Description
Defines the current configuration username.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| username | string | Username. |
Return
( IMAPConfig )
Current IMAPConfig object.