| |
Establish a connection with a server.
Syntax
object.Connect( [RemoteHost],
[RemotePort], [UserName], [Password],
[Timeout], [Options] )
Parameters
- RemoteHost
- A string which specifies the host name or IP address of the
server. If this argument is not specified, it defaults to the
value of the HostAddress property if it is defined.
Otherwise, it defaults to the value of the HostName
property.
- RemotePort
- A number which specifies the port to connect to on the server.
If this argument is not specified, it defaults to the value
of the RemotePort property. A value of zero specifies that
the default port number should be used. For standard connections,
the default port number is 110. For secure connections, the default
port number is 995. If the secure port number is specified, an
implicit SSL/TLS connection will be established by default.
- UserName
- A string which specifies the name of the user used to
authenticate access to the server. If this argument is not
specified, it defaults to the value of the UserName
property.
- Password
- A string which specifies the password used to authenticate the
user. If you are using the OAuth 2.0 authentication method, this
property should specify the bearer token provided by the mail service
and not the user password. Refer to the AuthType
property for more information about the supported authentication
methods. If this argument is not specified, it defaults to the
value of the BearerToken or Password
property, depending on the authentication method specified.
- Timeout
- The number of seconds that the client will wait for a response
before failing the operation. If this argument is not specified,
the value of the Timeout property will be used as the default.
- Options
- A numeric value which specifies one or more options. If this
argument is omitted or a value of zero is specified, a default,
standard connection will be established. This argument is
constructed by using a bitwise operator with any of the following
values:
| Value |
Constant |
Description |
| 0 |
popOptionNone |
No additional options are specified when establishing a
connection with the server. A standard, non-secure connection
will be used. |
| 1 |
popOptionLineBreak |
Message data that is received from the server is read as
individual lines of text terminated by a carriage return and
linefeed control sequence. This option can be useful for
applications that need to use the lower level network I/O
functions and must process the message text on a line-by-line
basis. This option is not recommended for most applications
because it can have a negative impact on performance when
retrieving large messages from the server. |
| &H400 |
popOptionTunnel |
This option specifies that a tunneled TCP connection and/or
port-forwarding is being used to establish the connection to
the server. This changes the behavior of the client with
regards to internal checks of the destination IP address and
remote port number, default capability selection and how the
connection is established. |
| &H800 |
popOptionTrustedSite |
This option specifies the server is trusted. The
server certificate will not be validated and the connection
will always be permitted. This option only affects connections
using either the SSL or TLS protocols. |
| &H1000 |
popOptionSecureExplicit |
This option specifies that a secure connection should be
established with the server and requires that the server
support either the SSL or TLS protocol. This option initiates
the secure session using the STLS command. |
| &H2000 |
popOptionSecureImplicit |
This option specifies the client should attempt to
establish a secure connection with the server. It should only
be used when the server expects an implicit SSL connection or
does not implement RFC 2595 where the STLS command is used to
negotiate a secure connection with the server. |
| &H8000 |
popOptionSecureFallback |
This option specifies the client should permit the use of
less secure cipher suites for compatibility with legacy servers.
If this option is specified, the client will allow connections
using TLS 1.0 and cipher suites that use RC4, MD5 and SHA1. |
| &H40000 |
popOptionPreferIPv6 |
This option specifies the client should prefer the use of
IPv6 if the server hostname can be resolved to both an IPv6 and
IPv4 address. This option is ignored if the local system does
not have IPv6 enabled, or when the hostname can only be resolved
to an IPv4 address. If the server hostname can only be resolved
to an IPv6 address, the client will attempt to establish a
connection using IPv6 regardless if this option has been
specified. |
Return Value
A value of zero is returned if the connection was successful.
Otherwise, a non-zero error code is returned which indicates the
cause of the failure.
See Also
AuthType Property,
HostAddress Property,
HostName Property,
Options Property,
RemotePort Property,
Disconnect Method,
OnConnect Event
|
|