Inbox Registrations

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

List Inbox Registrations

SDK Method

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.

InboxRegistrationListParams Fields

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

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    inbox_registration "github.com/Files-com/files-sdk-go/v3/inboxregistration"
)

inboxRegistrationIterator, err := inbox_registration.List(files_sdk.InboxRegistrationListParams{FolderBehaviorId: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

for inboxRegistrationIterator.Next() {
    inboxRegistration := inboxRegistrationIterator.inboxRegistration()
}
err = inboxRegistrationIterator.Err()
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

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
ClickwrapBody
string		Clickwrap text that was shown to the registrant
FormFieldSetId
int64		Id of associated form field set
FormFieldData
object		Data for form field set with form field ids as keys and user data as values
InboxId
int64		Id of associated inbox
InboxRecipientId
int64		Id of associated inbox recipient
InboxTitle
string		Title of associated inbox
CreatedAt
date-time		Registration creation date/time