User Additional Email Recipients

List User Additional Email Recipients

SDK Method

user_additional_email_recipient.List()

Return Values

Returns a *user_additional_email_recipient.Iter and an error. Range over All() to receive files_sdk.UserAdditionalEmailRecipient values and errors. Check each loop error before using its resource. Next() and Err() remain supported.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator, a Workspace Administrator for the relevant workspace, or a Partner Administrator for the relevant partner.

UserAdditionalEmailRecipientListParams Fields

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

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    user_additional_email_recipient "github.com/Files-com/files-sdk-go/v3/useradditionalemailrecipient"
)

userAdditionalEmailRecipientIterator, err := user_additional_email_recipient.List(files_sdk.UserAdditionalEmailRecipientListParams{UserId: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}

for userAdditionalEmailRecipient, err := range userAdditionalEmailRecipientIterator.All() {
    if err != nil {
        var respErr files_sdk.ResponseError
        if errors.As(err, &respErr) {
            fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
        } else {
            fmt.Printf("Request failed: %v\n", err)
        }
        return
    }
    fmt.Println(userAdditionalEmailRecipient)
}

Show User Additional Email Recipient

SDK Method

user_additional_email_recipient.Find()

Return Values

Returns a files_sdk.UserAdditionalEmailRecipient value and an error.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator, a Workspace Administrator for the relevant workspace, or a Partner Administrator for the relevant partner.

UserAdditionalEmailRecipientFindParams Fields

FieldDescription
Id
int64
Required
User Additional Email Recipient ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    user_additional_email_recipient "github.com/Files-com/files-sdk-go/v3/useradditionalemailrecipient"
)

userAdditionalEmailRecipient, err := user_additional_email_recipient.Find(files_sdk.UserAdditionalEmailRecipientFindParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}
fmt.Println(userAdditionalEmailRecipient)

Create User Additional Email Recipient

SDK Method

user_additional_email_recipient.Create()

Return Values

Returns a files_sdk.UserAdditionalEmailRecipient value and an error.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator, a Workspace Administrator for the relevant workspace, or a Partner Administrator for the relevant partner.

UserAdditionalEmailRecipientCreateParams Fields

FieldDescription
UserId
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 (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    user_additional_email_recipient "github.com/Files-com/files-sdk-go/v3/useradditionalemailrecipient"
)

userAdditionalEmailRecipient, err := user_additional_email_recipient.Create(files_sdk.UserAdditionalEmailRecipientCreateParams{Email: "user-copy@example.com"})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}
fmt.Println(userAdditionalEmailRecipient)

Update User Additional Email Recipient

SDK Method

user_additional_email_recipient.Update()

Return Values

Returns a files_sdk.UserAdditionalEmailRecipient value and an error.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator, a Workspace Administrator for the relevant workspace, or a Partner Administrator for the relevant partner.

UserAdditionalEmailRecipientUpdateParams Fields

FieldDescription
Id
int64
Required
User Additional Email Recipient ID.
Email
string
Additional email recipient address

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    user_additional_email_recipient "github.com/Files-com/files-sdk-go/v3/useradditionalemailrecipient"
)

userAdditionalEmailRecipient, err := user_additional_email_recipient.Update(files_sdk.UserAdditionalEmailRecipientUpdateParams{
  Id: 1,
  Email: "user-copy@example.com",
})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}
fmt.Println(userAdditionalEmailRecipient)

Delete User Additional Email Recipient

SDK Method

user_additional_email_recipient.Delete()

Return Values

Returns an error, or nil on success.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator, a Workspace Administrator for the relevant workspace, or a Partner Administrator for the relevant partner.

UserAdditionalEmailRecipientDeleteParams Fields

FieldDescription
Id
int64
Required
User Additional Email Recipient ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    user_additional_email_recipient "github.com/Files-com/files-sdk-go/v3/useradditionalemailrecipient"
)

err := user_additional_email_recipient.Delete(files_sdk.UserAdditionalEmailRecipientDeleteParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}

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
UserId
int64
User ID
WorkspaceId
int64
Workspace ID (0 for default workspace).
Email
string
Additional email recipient address
CreatedAt
date-time
Created at date/time