MoveMailUser (NotesAdministrationProcess - LotusScript®)
Enters a request in the Administration Requests database to move a user's mail file.
Defined in
Syntax
noteID$ = notesAdministrationProcess .MoveMailUser( username$ , newhomeserver$ , newhomeservermailpath$ [ , usescos ] [ , newclusterreplicaarray$ ] [ , deleteoldclusterreplicas ] )
Parameters
username$
String. The full hierarchical name (can be abbreviated) of the user.
newhomeserver$
String. The full hierarchical name (can be abbreviated) of the new home server for the user's mail file.
newhomeservermailpath$
String. 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.
usescos
Boolean. Optional. If True, the new mail file makes use of the shared mail feature. Defaults to False.
newclusterreplicaarray$
Array of type String. Optional. Replicas of the mail file in the same cluster as the new home server. The array 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.
deleteoldclusterreplicas$
Boolean. Optional. If True, deletes existing replicas of the mail file on servers in the same cluster as the existing home server. Defaults to False. Used only if the user is being moved off a cluster.
Return value
noteID$
String. The note ID of an entry created in the Administration Requests database.