User Additional Email Recipients

List User Additional Email Recipients

SDK Method

files_sdk.user_additional_email_recipient.list()

Return Object

ListObj[UserAdditionalEmailRecipient]

Authorization Requirement

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

Method Arguments

ArgumentDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.

Additional Arguments

Example Request

import files_sdk

try:
  user_additional_email_recipients = files_sdk.user_additional_email_recipient.list({
    "user_id": 1
  })
  for user_additional_email_recipient in user_additional_email_recipients.auto_paging_iter():
    # Operate on user_additional_email_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)

Show User Additional Email Recipient

SDK Method

files_sdk.user_additional_email_recipient.find()

Return Object

UserAdditionalEmailRecipient

Authorization Requirement

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

Method Arguments

ArgumentDescription
id
int64
Required		User Additional Email Recipient ID.

Example Request

import files_sdk

try:
  user_additional_email_recipient = files_sdk.user_additional_email_recipient.find(id)
  # Operate on user_additional_email_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 User Additional Email Recipient

SDK Method

files_sdk.user_additional_email_recipient.create()

Return Object

UserAdditionalEmailRecipient

Authorization Requirement

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

Method Arguments

ArgumentDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.
email
string
Required		Additional email recipient address

Example Request

import files_sdk

try:
  user_additional_email_recipient = files_sdk.user_additional_email_recipient.create({
    "email": "user-copy@example.com"
  })
  # Operate on user_additional_email_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)

Update User Additional Email Recipient

SDK Method

user_additional_email_recipient.update()

Return Object

UserAdditionalEmailRecipient

Authorization Requirement

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

Method Arguments

ArgumentDescription
email
string		Additional email recipient address

Example Request

import files_sdk

try:
  # Find the user_additional_email_recipient object by its id.
  user_additional_email_recipient = files_sdk.user_additional_email_recipient.find(id)
  user_additional_email_recipient.update({
    "email": "user-copy@example.com"
  })
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)

Delete User Additional Email Recipient

SDK Method

user_additional_email_recipient.delete()

Return Object

No return value.

Authorization Requirement

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

Example Request

import files_sdk

try:
  # Find the user_additional_email_recipient object by its id.
  user_additional_email_recipient = files_sdk.user_additional_email_recipient.find(id)
  user_additional_email_recipient.delete()
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 UserAdditionalEmailRecipient Object

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

AttributeDescription
id
int64		User additional email recipient ID
user_id
int64		User ID
workspace_id
int64		Workspace ID (0 for default workspace).
email
string		Additional email recipient address
created_at
date-time		Created at date/time