emailOrgUsers

Function

Attempts to email members of the requesting user's organization.

  • emailOrgUsers(users: IUser[], email: IEmail, authentication: IAuthenticationManager, isOrgAdmin: boolean) : Promise<ICreateOrgNotificationResult>

Parameters

Parameter Type Default Notes
users Required IUser[]

Users to email (must be in the same org as the requesting user)

email Required IEmail
authentication Required IAuthenticationManager
isOrgAdmin Required boolean

// Whether the requesting user in an org admin

Returns

A promise that resolves to the result of the transaction (null if no users are passed in)

Promise<ICreateOrgNotificationResult>
Property Type Notes

Function defined in packages/common/src/groups/add-users-workflow/workflow-sections/email-org-users.ts:20