moveMailUser (NotesAdministrationProcess - JavaScript™)

Enters a request in the Administration Requests database to move a user's mail file.

Defined in

NotesAdministrationProcess

Syntax

moveMailUser(username:string, newhomeserver:string, newhomeservermailpath:string) : string

moveMailUser(username:string, newhomeserver:string, newhomeservermailpath:string, usescos:boolean, newclusterreplicas:any, deleteoldclusterreplicas: boolean) : string

Parameter Description
String username The full hierarchical name (can be abbreviated) of the user.
String newhomeserver The full hierarchical name (can be abbreviated) of the new home server for the user's mail file.
String newhomeservermailpath The path name of the new directory or folder for the user's mail file relative to the server's data directory. The path name does not include the file name.
boolean usescos
  • true if the new mail file makes use of the shared mail feature
  • false (default) if the new mail file does not make use of the shared mail feature
java.util.Vector newclusterreplicas Replicas of the mail file in the same cluster as the new home server. The vector must consist of pairs of elements. The first element of the pair specifies the name of a server in the same cluster as the new home server. The second element specifies the path in the same form as the new home server mail path.
boolean deleteoldclusterreplicas Used only if the user is being moved off a cluster.
  • true to delete existing replicas of the mail file on servers in the same cluster as the existing home server
  • false (default) to not delete existing replicas of the mail file on servers in the same cluster as the existing home server
Return value Description
String The note ID of an entry created in the Administration Requests database.

Language cross-reference

moveMailUser in LotusScript® NotesAdministrationProcess class

moveMailUser in Java™ AdministrationProcess class