deleteUser (NotesAdministrationProcess - JavaScript™)

Enters a request in the Administration Requests database to delete a user.

Defined in

NotesAdministrationProcess

Syntax

deleteUser(username:string, immediate:boolean, mailfileaction:int, denygroup:string) : string

deleteUser(username:string, immediate:boolean, mailfileaction:int, denygroup:string, deletewindowsuser:boolean) : string

Parameter Description
String username The hierarchical name of the user in canonical or abbreviated form.
boolean immediate
  • true to delete all references to the user in the Domino® Directory before issuing an administration process request
  • false to let the administration process make all deletions
Note: A true setting may impact performance.
int mailfileaction Indicates the disposition of the user's mail file:
  • AdministrationProcess.MAILFILE_DELETE_ALL deletes the mail file on the user's home server and all replicas
  • AdministrationProcess.MAILFILE_DELETE_HOME deletes the mail file on the user's home server.
  • AdministrationProcess.MAILFILE_DELETE_NONE leaves the user's mail file.
String denygroup The name of an existing group of type "Deny List Only" to which the name of the deleted user is added. The empty string means do not add the user name to any group.
boolean deletewindowsuser
  • true to delete the corresponding Windows™ user
  • false (default) to not delete the corresponding Windows™ user
Return value Description
String The note ID of an entry created in the Administration Requests database.

Usage

This method triggers "Delete person in Domino® Directory," "Delete in Person documents," "Delete in Access Control List," "Delete in Reader / Author fields," "Get information for deletion," "Approve file deletion," "Request file deletion," "Delete mail file," "Delete unlinked mail file," "Approve deletion of Private Design Elements," "Request to delete Private Design Elements," and "Delete Private Design Elements" administration process requests.

Language cross-reference

deleteUser in LotusScript® NotesAdministrationProcess class

deleteUser in Java™ AdministrationProcess class