Inbox Recipients

An InboxRecipient is a person who has had an inbox shared with them via email invitation.

List Inbox Recipients

SDK Method

files_sdk.inbox_recipient.list()

Return Object

ListObj[InboxRecipient]

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
inbox_id
int64
Required		List recipients for the inbox with this ID.

Additional Arguments

Example Request

import files_sdk

try:
  inbox_recipients = files_sdk.inbox_recipient.list({
    "inbox_id": 1
  })
  for inbox_recipient in inbox_recipients.auto_paging_iter():
    # Operate on inbox_recipient
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)

Create Inbox Recipient

SDK Method

files_sdk.inbox_recipient.create()

Return Object

InboxRecipient

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
inbox_id
int64
Required		Inbox to share.
recipient
string
Required		Email address to share this inbox with.
name
string		Name of recipient.
company
string		Company of recipient.
note
string		Note to include in email.
share_after_create
boolean		Set to true to share the link with the recipient upon creation.

Example Request

import files_sdk

try:
  inbox_recipient = files_sdk.inbox_recipient.create({
    "inbox_id": 1,
    "recipient": "johndoe@gmail.com"
  })
  # Operate on inbox_recipient
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 InboxRecipient Object

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

AttributeDescription
company
string		The recipient's company.
name
string		The recipient's name.
note
string		A note sent to the recipient with the inbox.
recipient
string		The recipient's email address.
sent_at
date-time		When the Inbox was shared with this recipient.