ConfigureMailAgent (NotesAdministrationProcess - LotusScript®)

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

Defined in



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



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.

Return value


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.

This method must be executed by the mail file owner, and was designed to allow mail file owners with Editor access to enable and disable scheduled agents in their own mail files. It will not allow a user to enable a scheduled agent in a mail file that is owned by someone else.

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

This method can be used by agents in the mail file.