SMTPConfig
Definição da configuração do SMTP.
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.
getBcc
getBcc() : string
Description
Returns email addresses in the BCC (Blind Carbon Copy) field.
Return
( string )
The email addresses.
getCc
getCc() : string
Description
Returns email addresses in the CC (Carbon Copy) field
Return
( string )
The email addresses.
getFrom
getFrom() : string
Description
Returns the sender email address of the current configuration.
Return
( string )
Email address.
getHTML
getHTML() : string
Description
Returns the HTML code of the email message.
Return
( string )
The HTML code.
getHost
getHost() : string
Description
Returns the current configuration host.
Return
( string )
Host of the current configuration.
getMultipartSubtype
getMultipartSubtype() : string
Description
Returns the subtype of the multipart email message.
Return
( string )
Message subtype.
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.
getReplyTo
getReplyTo() : string
Description
Returns the email addresses specified in the Reply-To field.
Return
( string )
The email addresses.
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.
getSubject
getSubject() : string
Description
Returns the email message subject.
Return
( string )
The email subject.
getSubjectPrefix
getSubjectPrefix() : string
Description
Returns the email message subject prefix.
Return
( string )
The subject prefix.
getText
getText() : string
Description
Returns the text of the email message.
Return
( string )
The text message.
getTo
getTo() : string
Description
Returns the recipient's email address from the current configuration.
Return
( string )
Email address.
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) : SMTPConfig
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
( SMTPConfig )
Current SMTPConfig object.
setAuthNTLMDomain
setAuthNTLMDomain(authNTLMDomain: string) : SMTPConfig
Description
Defines the NTLM domain in the current configuration.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| authNTLMDomain | string | The NTLM domain. |
Return
( SMTPConfig )
Current SMTPConfig object.
setBcc
setBcc(bcc: string) : SMTPConfig
Description
Defines the email addresses in the BCC (Blind Carbon Copy) field.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| bcc | string | The email addresses. |
Return
( SMTPConfig )
Current SMTPConfig object.
setCc
setCc(cc: string) : SMTPConfig
Description
Defines email addresses in the CC (Carbon Copy) field.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| cc | string | The email addresses. |
Return
( SMTPConfig )
Current SMTPConfig object.
setDebug
setDebug(debug: boolean) : SMTPConfig
Description
Defines whether the current object is in debug mode active.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| debug | boolean | Whether it is active or not. |
Return
( SMTPConfig )
Current SMTPConfig object.
setEnabled
setEnabled(enabled: boolean) : SMTPConfig
Description
Defines whether the current configuration is active.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| enabled | boolean | Whether it is active or not. |
Return
( SMTPConfig )
Current SMTPConfig object.
setFrom
setFrom(from: string) : SMTPConfig
Description
Defines the sender email address of the current configuration.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| from | string | Email address. |
Return
( SMTPConfig )
Current SMTPConfig object.
setHTML
setHTML(html: string) : SMTPConfig
Description
Defines the HTML code that will build the body of the email message.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| html | string | The HTML code. |
Return
( SMTPConfig )
Current SMTPConfig object.
setHost
setHost(host: string) : SMTPConfig
Description
Defines the host of the current configuration.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| host | string | Host to be defined. |
Return
( SMTPConfig )
Current SMTPConfig object.
setMultipartSubtype
setMultipartSubtype(multipartSubtype: string) : SMTPConfig
Description
Defines the subtype of the multipart email message.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| multipartSubtype | string | Message subtype. |
Return
( SMTPConfig )
Current SMTPConfig object.
setPassword
setPassword(password: string) : SMTPConfig
Description
Defines the current configuration password.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| password | string | Password. |
Return
( SMTPConfig )
Current SMTPConfig object.
setPort
setPort(port: int) : SMTPConfig
Description
Defines the port of the current configuration.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| port | int | Port to be defined. |
Return
( SMTPConfig )
Current SMTPConfig object.
setProtocol
setProtocol(protocol: string) : SMTPConfig
Description
Defines the protocol used in the current configuration.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| protocol | string | Protocol to be defined. |
Return
( SMTPConfig )
Current SMTPConfig object.
setQuitWait
setQuitWait(quitWait: boolean) : SMTPConfig
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
( SMTPConfig )
Current SMTPConfig object.
setReplyTo
setReplyTo(replyTo: string) : SMTPConfig
Description
Defines the email addresses specified in the Reply-To field.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| replyTo | string | The email addresses. |
Return
( SMTPConfig )
Current SMTPConfig object.
setSSL
setSSL(ssl: boolean) : SMTPConfig
Description
Defines whether SSL is enabled in the current configuration.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| ssl | boolean | Whether or not it is active. |
Return
( SMTPConfig )
Current SMTPConfig object.
setSocketFactoryClass
setSocketFactoryClass(socketFactoryClass: string) : SMTPConfig
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
( SMTPConfig )
Current SMTPConfig object.
setSocketFactoryFallback
setSocketFactoryFallback(ssl: boolean) : SMTPConfig
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
( SMTPConfig )
Current SMTPConfig object.
setSocketFactoryPort
setSocketFactoryPort(socketFactoryPort: int) : SMTPConfig
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
( SMTPConfig )
Current SMTPConfig object.
setSubject
setSubject(subject: string) : SMTPConfig
Description
Defines the email message subject.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| subject | string | The email subject. |
Return
( SMTPConfig )
Current SMTPConfig object.
setSubjectPrefix
setSubjectPrefix(subjectPrefix: string) : SMTPConfig
Description
Defines the email message subject prefix.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| subjectPrefix | string | The subject prefix. |
Return
( SMTPConfig )
Current SMTPConfig object.
setTLS
setTLS(ssl: boolean) : SMTPConfig
Description
Defines whether TLS is enabled in the current configuration.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| ssl | boolean | Whether or not it is active. |
Return
( SMTPConfig )
Current SMTPConfig object.
setText
setText(text: string) : SMTPConfig
Description
Defines the text of the email message.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| text | string | The text message. |
Return
( SMTPConfig )
Current SMTPConfig object.
setTo
setTo(to: string) : SMTPConfig
Description
Defines the recipient's email address of the current configuration.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| to | string | Email address. |
Return
( SMTPConfig )
Current SMTPConfig object.
setUsername
setUsername(username: string) : SMTPConfig
Description
Defines the current configuration username.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| username | string | Username. |
Return
( SMTPConfig )
Current SMTPConfig object.