User Additional Email Recipients

List User Additional Email Recipients

SDK Method

Files::UserAdditionalEmailRecipient.list

Return Object

List<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

begin
  user_additional_email_recipients = Files::UserAdditionalEmailRecipient.list(
    user_id: 1
  )
  user_additional_email_recipients.auto_paging_each do |user_additional_email_recipient|
    # Operate on user_additional_email_recipient
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Show User Additional Email Recipient

SDK Method

Files::UserAdditionalEmailRecipient.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

begin
  user_additional_email_recipient = Files::UserAdditionalEmailRecipient.find(id)
  # Operate on user_additional_email_recipient
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Create User Additional Email Recipient

SDK Method

Files::UserAdditionalEmailRecipient.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

begin
  user_additional_email_recipient = Files::UserAdditionalEmailRecipient.create(
    email: "user-copy@example.com"
  )
  # Operate on user_additional_email_recipient
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

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

begin
  # Find the user_additional_email_recipient object by its id.
  user_additional_email_recipient = Files::UserAdditionalEmailRecipient.find(id)
  user_additional_email_recipient.update(
    email: "user-copy@example.com"
  )
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Delete User Additional Email Recipient

SDK Method

user_additional_email_recipient.delete

Return Object

nil

Authorization Requirement

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

Example Request

begin
  # Find the user_additional_email_recipient object by its id.
  user_additional_email_recipient = Files::UserAdditionalEmailRecipient.find(id)
  user_additional_email_recipient.delete
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

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