Table of Contents

inbox

Free

Description

Opens the PDM inbox or sends a message as the logged-in user.

Syntax

inbox -filePath -name -value

Use -id as an alternative to -filePath for the same operand. A required target still needs one selector, even though each alternative is optional individually. See File IDs and paths for selection rules and command-specific exceptions.

Parameters

Parameter Alias Required Description
-filePath No Associated file
-name No Name of the user to send the message to.
-value -val No Message: supports evaluation against the filePath.
-id No Positive PDM file ID instead of -filePath, identifying the same file that -filePath describes (including a macro, input CSV or existing output file). Requires a connected vault. Shared files with multiple locations require an exact -filePath. Resolving the ID itself does not download, check out or check in the file; the requested command still performs its normal operation.

Examples

inbox -message 'File checked in successfully'
# inbox