listLMEmailRestrictions

List the email restrictions for a pool.

Parameters:

Field
Type
Required Description
sessionid String yes The sessionid returned by loginLMLicensee()
licensee String yes The company code (not the company name) for the Licensee.
customer String yes The company code (not the company name) for the Customer.
pool String yes The name of the customer's pool. If the pool does not have a name, then passing "Pool ##" where ## is the pool number will also work.
emailPattern String no An email pattern to search for. The possible values for this are
  • null, which will list all email restrictions
  • an email address, which will list a single restriction
  • a string with one or more asterisks, which will find all restrictions that match the pattern


Return values: An AccessRestrictionList structure:

Field
Type
Description
fault FaultData If an error has occurred on the server, this will contain information about the error. This field will be null if no error occurred.
restrictions Array of AccessRestriction The restriction data - will be null if there are no matching restrictions


AccessRestriction

Field
Type
Description
accessName String The restriction's email address
accessType AccessRestrictionType I (Include) or E (Exclude)


Example:

NitroAdminAccessServiceLocator service = new NitroAdminAccessServiceLocator();
NitroAdminAccess server = service.getNitroAdminAccess();

AccessRestrictionList ret = server.listLMEmailRestrictons(sessionid, "smith", "cust1", "my first pool", "*@smith.com");
if (ret.getFault()!=null) {
	System.err.println("Error: " + ret.getFault().getFaultString());
	return;
}
if (ret.getRestrictions()!=null) {
        AccessRestriction restriction;
        for (int i=0; i<rest.length; i++) {
                restriction = ret.getRestrictions(i);
                System.out.println("     " + restriction.getAccessType().toString() + "  " + restriction.getAccessName());
        }
}
Comments