Inbox Recipients

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

List Inbox Recipients

files-cli inbox-recipients list

Outputs a list of InboxRecipient objects according to the output format.

Available to all authenticated keys or sessions.

Flag	Description
--inbox-id= int64 Required	List recipients for the inbox with this ID.

Example Request

files-cli inbox-recipients list \
  --inbox-id=1

files-cli inbox-recipients create

Outputs a InboxRecipient object according to the output format.

Available to all authenticated keys or sessions.

Flag	Description
--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

files-cli inbox-recipients create \
  --inbox-id=1 \
  --recipient="johndoe@gmail.com"

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

Attribute	Description
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.