Authenticate Method

Authenticate the client session.

Syntax

object.Authenticate( [UserName], [Password] )

Remarks

The Authenticate method is used to authenticate the current client session to the mail server, ensuring that only valid users may deliver messages through the server. This method uses the Netscape AUTH LOGIN authentication mechanism, and requires that the server support this extended SMTP command. The Extended property must be set to True before using this method. If the server does not support this type of authentication, an error will be returned.

UserName
An optional string argument which specifies the username used to authenticate the client session. If the argument is omitted, the value assigned to the UserName property will be used instead.
Password
An optional string argument which specifies the password used to authenticate the client session. If the argument is omitted, the value assigned to the Password property will be used instead.

Return Value

A value of zero is returned if the operation was successful, otherwise a non-zero error code is returned which indicates the cause of the failure.

See Also

Password Property, UserName Property, Connect Method


Copyright © 2008 Catalyst Development Corporation. All rights reserved.