User Additional Email Recipients

List User Additional Email Recipients

SDK Function

UserAdditionalEmailRecipient.list()

Return Object

ListIterator<UserAdditionalEmailRecipient>

Authorization Requirement

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

Function Arguments

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

Additional Arguments

Example Request

import com.files.ListIterator;
import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.UserAdditionalEmailRecipient;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  parameters.put("user_id", 1);
  
  ListIterator<UserAdditionalEmailRecipient> userAdditionalEmailRecipients = UserAdditionalEmailRecipient.list(parameters);
  for (UserAdditionalEmailRecipient userAdditionalEmailRecipient : userAdditionalEmailRecipients.listAutoPaging()) {
    // Operate on userAdditionalEmailRecipient
  }
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Show User Additional Email Recipient

SDK Function

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.

Function Arguments

ArgumentDescription
id
int64
Required		User Additional Email Recipient ID.

Example Request

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.UserAdditionalEmailRecipient;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  UserAdditionalEmailRecipient userAdditionalEmailRecipient = UserAdditionalEmailRecipient.find(id, parameters);
  // Operate on userAdditionalEmailRecipient
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Create User Additional Email Recipient

SDK Function

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.

Function 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 com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.UserAdditionalEmailRecipient;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  parameters.put("email", "user-copy@example.com");
  
  UserAdditionalEmailRecipient userAdditionalEmailRecipient = UserAdditionalEmailRecipient.create(parameters);
  // Operate on userAdditionalEmailRecipient
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Update User Additional Email Recipient

SDK Function

userAdditionalEmailRecipient.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.

Attribute Setters

SetterDescription
setEmail
string		Additional email recipient address

Example Request

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.UserAdditionalEmailRecipient;

try {
  // Find the userAdditionalEmailRecipient object by its id.
  UserAdditionalEmailRecipient userAdditionalEmailRecipient = UserAdditionalEmailRecipient.find(id, null);
  HashMap<String, Object> parameters = new HashMap<>();
  parameters.put("email", "user-copy@example.com");
  userAdditionalEmailRecipient.update(parameters);
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Delete User Additional Email Recipient

SDK Function

userAdditionalEmailRecipient.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 com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.UserAdditionalEmailRecipient;

try {
  // Find the userAdditionalEmailRecipient object by its id.
  UserAdditionalEmailRecipient userAdditionalEmailRecipient = UserAdditionalEmailRecipient.find(id, null);
  userAdditionalEmailRecipient.delete(null);
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

The UserAdditionalEmailRecipient Object

Some of the functions 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