User Additional Email Recipients

List User Additional Email Recipients

SDK Method

UserAdditionalEmailRecipient.List();

Return Object

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

using FilesCom.Models;

var parameters = new Dictionary<string, object>();
parameters.Add("user_id", (Int64?) 1);

try
{
    var userAdditionalEmailRecipientIterator = UserAdditionalEmailRecipient.List(parameters);
    foreach (UserAdditionalEmailRecipient userAdditionalEmailRecipient in userAdditionalEmailRecipientIterator.ListAutoPaging()) {
        // Operate on userAdditionalEmailRecipient
    }
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

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

using FilesCom.Models;

try
{
    var userAdditionalEmailRecipient = await UserAdditionalEmailRecipient.Find(id);
    // Operate on userAdditionalEmailRecipient
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

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

using FilesCom.Models;

var parameters = new Dictionary<string, object>();
parameters.Add("email", "user-copy@example.com");

try
{
    var userAdditionalEmailRecipient = await UserAdditionalEmailRecipient.Create(parameters);
    // Operate on userAdditionalEmailRecipient
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

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

using FilesCom.Models;

var parameters = new Dictionary<string, object>();
parameters.Add("email", "user-copy@example.com");

try
{
    // Find the userAdditionalEmailRecipient object by its id.
    var userAdditionalEmailRecipient = await UserAdditionalEmailRecipient.Find(id);
    await userAdditionalEmailRecipient.Update(parameters);
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

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

using FilesCom.Models;

try
{
    // Find the userAdditionalEmailRecipient object by its id.
    var userAdditionalEmailRecipient = await UserAdditionalEmailRecipient.Find(id);
    await userAdditionalEmailRecipient.Delete();
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

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