| |
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 indicates that
the default port number for this service should be used to
establish the connection. If the secure port number is specified,
an implicit 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 an OAuth 2.0 authentication method, this
property should specify the access 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
connection will be established. This argument is constructed by
using a bitwise operator with any of the following values:
| Value |
Description |
| imapOptionNone |
No connection options specified. A standard connection to
the server will be established using the specified host name
and port number. |
| imapOptionIdentify |
This option specifies the client should identify itself
to the server. If enabled, the client will send the ID command
to the server as defined in RFC 2971. This option has no effect
if the server does not support the ID command. |
| &H400 |
imapOptionTunnel |
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 |
imapOptionTrustedSite |
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 the TLS protocol. |
| &H1000 |
imapOptionSecureExplicit |
This option specifies that a secure connection should be
established with the server and requires that the server
support the TLS protocol. This option initiates
the secure session using the STARTTLS command. |
| &H2000 |
imapOptionSecureImplicit |
This option specifies the client should attempt to
establish a secure connection with the server. The server must
support secure connections using the TLS
protocol, and the secure session must be negotiated immediately
after the connection has been established. |
| &H8000 |
imapOptionSecureFallback |
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 |
imapOptionPreferIPv6 |
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,
BearerToken Property,
HostAddress Property,
HostName Property,
Options Property,
RemotePort Property,
Disconnect Method,
OnConnect Event
|
|