Inbox Registrations

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

List Inbox Registrations

SDK Method

files_sdk.inbox_registration.list()

Return Object

ListObj[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

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

Additional Arguments

Example Request

import files_sdk

try:
  inbox_registrations = files_sdk.inbox_registration.list({
    "folder_behavior_id": 1
  })
  for inbox_registration in inbox_registrations.auto_paging_iter():
    # Operate on inbox_registration
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

The InboxRegistration Object

Some of the methods above return a InboxRegistration object. The attributes of this object are listed below.

AttributeDescription
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