This method is used to determine whether one or more intended recipients of a secure mail package are registered with the system prior to sending the package. Its use is not mandatory, but is recommended.
Request Parameters
| Parameter |
Type |
Requirement |
Description |
|---|
| username |
xsd:string |
mandatory – cannot be null or empty |
The username of the registered user who will send a package |
| password |
xsd:string |
mandatory – cannot be null or empty |
The password of the registered user who will send a package |
| encodedPassword |
xsd:boolean |
optional – can be null (indicates false) |
Indicates whether the password parameter is MD5 encoded |
| emailIDs |
xsd:string |
mandatory – cannot be null or empty |
An array of email addresses of the intended recipients |
Reponse
- Type: xsd:string
- Possible return values:
- “YES” - all of the intended recipients are registered with the system
- “NO” - one or more of the intended recipients are not registered with the system. This will be followed by a semi-colon separated list of the email IDs of the unregistered users (e.g. “NO : user1@wkfs.com;user2@wkfs.com”)
- “ERROR” - an error occurred. This will be followed by a description of the error (e.g. “ERROR : No emailIDs provided”)
