Message Commands

You can use the command line to perform the following actions on messages:

  • Deleting Multiple Messages That Have Not Been Updated
  • Deleting Permissions to Change and Delete Messages

Deleting Messages That Have Not Been Updated in Bulk

You can delete multiple unnecessary messages that have not been updated.
By specifying the criterion date for deletion, you can delete all messages that have not been updated since the specified date.
When you delete a message, the notifications and attachments for the message are also deleted.

Command
delete_messages.csp
Parameters
Parameters Required item Description
exec   Deletes the data.
If omitted, the number of messages to be deleted is displayed. Data are not deleted.
before   The input type of this argument is a string (one line). Type YYYY-MM-DD.
Specify the date that the data to delete based on.
Deletes messages that have not been updated since the specified date.
max_count   The input type of this argument is an integer.
Specify the maximum number of messages you want to delete.
To use this argument, you must use exec.
max_duration   The input type of this argument is an integer.
Specify the maximum amount of time to perform the deletion process in minutes. If the deletion process continues after the specified period of time, the process ends.
To use this argument, you must use exec.
  • Minimum value: 1
  • Maximum value: 2147483647
help   Displays help for this command.
Execution Example

Assuming the example setting below, the command usage is as follows:

  • Delete data before: May 30, 2011
  • The maximum duration of the deletion process: 3 hours (180 minutes)

On Windows:

.\grn.exe -C -q code\command\delete_messages.csp exec before=2011-05-30 max_duration=180
On Linux:
./grn.cgi -C -q code/command/delete_messages.csp exec before=2011-05-30 max_duration=180

Deleting Permissions to Edit or Delete Messages

Deletes permissions that are set to the receiving users of the messages to change and delete them.
Delete permission is a permission given to users who is set to "Allowd users" in "Users who can edit/delete" to delete messages from the recipient's inbox. For details on how to view users who have been granted permissions, see View Recipient Details.

Command
delete_messages_maintainer.csp
Parameters
Parameters Required item Description
exec   Deletes permissions.
If omitted, displays the number of messages from which the permissions will be deleted. Data are not deleted.
before   The input type of this argument is a string (one line). Type YYYY-MM-DD.
Specify the date that the data to delete based on.
Deletes permissions granted before the specified date.
help   Displays help for this command.
Execution Example

Assuming the example setting below, the command usage is as follows:

  • Delete data before: May 30, 2011

On Windows:

.\grn.exe -C -q code\command\delete_messages_maintainer.csp before=2011-05-30 exec
On Linux:
./grn.cgi -C -q code/command/delete_messages_maintainer.csp before=2011-05-30 exec