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
| Field | Description |
|---|---|
| UserId int64 | User ID. Provide a value of 0 to operate the current session's user. |
Additional Arguments
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
| Field | Description |
|---|---|
| Id int64 Required | User Additional Email Recipient ID. |
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
| Field | Description |
|---|---|
| UserId int64 | User ID. Provide a value of 0 to operate the current session's user. |
| Email string Required | Additional email recipient address |
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
| Field | Description |
|---|---|
| Id int64 Required | User Additional Email Recipient ID. |
| Email string | Additional email recipient address |
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
| Field | Description |
|---|---|
| Id int64 Required | User Additional Email Recipient ID. |
The UserAdditionalEmailRecipient Object
Some of the methods above return a UserAdditionalEmailRecipient object. The attributes of this object are listed below.
| Attribute | Description |
|---|---|
| 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 |