User Additional Email Recipients

List User Additional Email Recipients

SDK Method

UserAdditionalEmailRecipient.list()

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.

Additional Arguments

Example Request

import UserAdditionalEmailRecipient from 'files.com/lib/models/UserAdditionalEmailRecipient';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const userAdditionalEmailRecipients = await UserAdditionalEmailRecipient.list({
    user_id: 1,
  });
  for (const userAdditionalEmailRecipient of userAdditionalEmailRecipients) {
    // Operate on userAdditionalEmailRecipient
  }
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Show User Additional Email Recipient

SDK Method

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

import UserAdditionalEmailRecipient from 'files.com/lib/models/UserAdditionalEmailRecipient';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const userAdditionalEmailRecipient = await UserAdditionalEmailRecipient.find(id);
  // Operate on userAdditionalEmailRecipient
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Create User Additional Email Recipient

SDK Method

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

import UserAdditionalEmailRecipient from 'files.com/lib/models/UserAdditionalEmailRecipient';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const userAdditionalEmailRecipient = await UserAdditionalEmailRecipient.create({
    email: "user-copy@example.com",
  });
  // Operate on userAdditionalEmailRecipient
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Update User Additional Email Recipient

SDK Method

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.

Method Arguments

ArgumentDescription
email
string		Additional email recipient address

Example Request

import UserAdditionalEmailRecipient from 'files.com/lib/models/UserAdditionalEmailRecipient';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  // Find the userAdditionalEmailRecipient object by its id.
  const userAdditionalEmailRecipient = await UserAdditionalEmailRecipient.find(id);
  await userAdditionalEmailRecipient.update({
    email: "user-copy@example.com",
  });
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Delete User Additional Email Recipient

SDK Method

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 UserAdditionalEmailRecipient from 'files.com/lib/models/UserAdditionalEmailRecipient';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  // Find the userAdditionalEmailRecipient object by its id.
  const userAdditionalEmailRecipient = await UserAdditionalEmailRecipient.find(id);
  await userAdditionalEmailRecipient.delete();
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw 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