User Additional Email Recipients

List User Additional Email Recipients

SDK Method

\Files\Model\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

try {
  $user_additional_email_recipients = \Files\Model\UserAdditionalEmailRecipient::list([
    'user_id' => 1
  ]);
  foreach ($user_additional_email_recipients as $user_additional_email_recipient) {
    // Operate on $user_additional_email_recipient
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Show User Additional Email Recipient

SDK Method

\Files\Model\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

try {
  $user_additional_email_recipient = \Files\Model\UserAdditionalEmailRecipient::find($id);
  // Operate on $user_additional_email_recipient
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Create User Additional Email Recipient

SDK Method

\Files\Model\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

try {
  $user_additional_email_recipient = \Files\Model\UserAdditionalEmailRecipient::create([
    'email' => "user-copy@example.com"
  ]);
  // Operate on $user_additional_email_recipient
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

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

try {
  // Find the user_additional_email_recipient object by its id.
  $user_additional_email_recipient = \Files\Model\UserAdditionalEmailRecipient::find(id);
  $user_additional_email_recipient->update([
    'email' => "user-copy@example.com"
  ]);
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

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

try {
  // Find the user_additional_email_recipient object by its id.
  $user_additional_email_recipient = \Files\Model\UserAdditionalEmailRecipient::find(id);
  $user_additional_email_recipient->delete();
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

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