Function: notify()

function notify(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/server/api/issues.ts:694

Sends a notification (email) to the list or recipients defined in the request.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ htmlBody?: string; issueIdOrKey: string; restrict?: { groups?: object[]; permissions?: object[]; }; subject?: string; textBody?: string; to?: { assignee?: boolean; groups?: object[]; reporter?: boolean; users?: object[]; voters?: boolean; watchers?: boolean; }; }	-
parameters.htmlBody?	string	-
parameters.issueIdOrKey?	string	Issue id or key
parameters.restrict?	{ groups?: object[]; permissions?: object[]; }	-
parameters.restrict.groups?	object[]	-
parameters.restrict.permissions?	object[]	-
parameters.subject?	string	-
parameters.textBody?	string	-
parameters.to?	{ assignee?: boolean; groups?: object[]; reporter?: boolean; users?: object[]; voters?: boolean; watchers?: boolean; }	-
parameters.to.assignee?	boolean	-
parameters.to.groups?	object[]	-
parameters.to.reporter?	boolean	-
parameters.to.users?	object[]	-
parameters.to.voters?	boolean	-
parameters.to.watchers?	boolean	-
options?	RequestOptions	-

Returns

Promise<void>