Authenticates a user using the indicated userId (as an email address) and password against the users of all the hosts on the current system.
Namespace: Ipswitch.Messaging.Framework
Assembly: Ipswitch.Messaging.Framework (in Ipswitch.Messaging.Framework.dll) Version: 1.0.0.0
Syntax
Parameters
- userId
- Type: SystemString
The userId (as an email address) of the user being authenticated. Specifying a host-part in the userId will cause the userId/password to be authenticated against that host; otherwise, the userId/password will be authenticated against the primary host. - password
- Type: SystemString
The password for the user being authenticated.
Return Value
Type: UserA User instance that corresponds to the given userId/password combination.
Exceptions
Exception | Condition |
---|---|
FormatException | userId is not a valid user ID. |
HostNotFoundException | Host part of userId is not a valid host on this system. |
AuthenticationFailedException | userId and/or password does not match a user on the system. |
See Also