Inbox Registrations
An InboxRegistration is created when a user fills out the form to access the inbox.
List Inbox Registrations
Command
files-cli inbox-registrations list
Output
Outputs a list of InboxRegistration objects according to the output format.
Authorization Requirement
Requires either a Site-Wide API key or User API key or session from a User with Folder Admin permissions.
Flags
| Flag | Description |
|---|---|
| --folder-behavior-id= int64 | ID of the associated Inbox. This is required if the user is not a site admin. |
Additional Arguments
The InboxRegistration Object
Some of the commands above return a InboxRegistration object. The attributes of this object are listed below.
| Attribute | Description |
|---|---|
| code string | Registration cookie code |
| name string | Registrant name |
| company string | Registrant company name |
| email string | Registrant email address |
| ip string | Registrant IP Address |
| clickwrap_body string | Clickwrap text that was shown to the registrant |
| form_field_set_id int64 | Id of associated form field set |
| form_field_data object | Data for form field set with form field ids as keys and user data as values |
| inbox_id int64 | Id of associated inbox |
| inbox_recipient_id int64 | Id of associated inbox recipient |
| inbox_title string | Title of associated inbox |
| created_at date-time | Registration creation date/time |