Enters a request in the Administration Requests database to configure an agent in a mail database on a user's home server.

Defined in

NotesAdministrationProcess

Syntax

noteID$ = notesAdministrationProcess.ConfigureMailAgent( username$ , agentname$ [ , activatable ] [ , enable ] )

Parameters

username$

String. The full hierarchical name (can be abbreviated) of the user.

String. The name of the agent.

Boolean. True (default) to make the agent activatable.

Boolean. True (default) to enable the agent.

noteID$

String. The note ID of an entry created in the Administration Requests database.

This method specifies username as the value of "Run on behalf of" under the security tab in the Agent Properties box. This is useful to allow scheduled agents on a mail database to run under the authority of the mail user. If activatable is True, users with Editor access can enable and disable the agent without resigning it.

After the agent is configured, you can use NotesAgent to reset activatable and enable.

Language cross-reference

configureMailAgent in Java AdministrationProcess class

Example

Glossary

Help on Help

Open Full Help Window

Glossary

Help on Help