jira.js
    Preparing search index...

    Function notify

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

      Parameters

      • client: Client
      • parameters: {
            htmlBody?: string;
            issueIdOrKey: string;
            restrict?: {
                groups?: { name?: string; self?: string; [key: string]: unknown }[];
                permissions?: {
                    description?: string;
                    id?: string;
                    key?: string;
                    name?: string;
                    type?: string & {} | "PROJECT" | "GLOBAL";
                    [key: string]: unknown;
                }[];
                [key: string]: unknown;
            };
            subject?: string;
            textBody?: string;
            to?: {
                assignee?: boolean;
                groups?: { name?: string; self?: string; [key: string]: unknown }[];
                reporter?: boolean;
                users?: {
                    active?: boolean;
                    avatarUrls?: Record<string, string>;
                    displayName?: string;
                    emailAddress?: string;
                    key?: string;
                    name?: string;
                    self?: string;
                    timeZone?: string;
                    [key: string]: unknown;
                }[];
                voters?: boolean;
                watchers?: boolean;
                [key: string]: unknown;
            };
        }
        • OptionalhtmlBody?: string
        • issueIdOrKey: string

          Issue id or key

        • Optionalrestrict?: {
              groups?: { name?: string; self?: string; [key: string]: unknown }[];
              permissions?: {
                  description?: string;
                  id?: string;
                  key?: string;
                  name?: string;
                  type?: string & {} | "PROJECT" | "GLOBAL";
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          }
        • Optionalsubject?: string
        • OptionaltextBody?: string
        • Optionalto?: {
              assignee?: boolean;
              groups?: { name?: string; self?: string; [key: string]: unknown }[];
              reporter?: boolean;
              users?: {
                  active?: boolean;
                  avatarUrls?: Record<string, string>;
                  displayName?: string;
                  emailAddress?: string;
                  key?: string;
                  name?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              }[];
              voters?: boolean;
              watchers?: boolean;
              [key: string]: unknown;
          }
      • Optionaloptions: RequestOptions

      Returns Promise<void>