Inbox Registrations

An InboxRegistration is created when a user fills out the form to access the inbox.

List Inbox Registrations

SDK Method

\Files\Model\InboxRegistration::list;

Return Object

InboxRegistration[]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Folder Admin permissions.

Method Arguments

Argument	Description
folder_behavior_id int64	ID of the associated Inbox. This is required if the user is not a site admin.

Additional Arguments

Example Request

try {
  $inbox_registrations = \Files\Model\InboxRegistration::list([
    'folder_behavior_id' => 1
  ]);
  foreach ($inbox_registrations as $inbox_registration) {
    // Operate on $inbox_registration
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

The InboxRegistration Object

Some of the methods 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