Class ProjectEmail

Index

Constructors

Methods

getProjectEmail updateProjectEmail

Constructors

constructor

new ProjectEmail(client: Client): Version2.ProjectEmail
Parameters
- client: Client
Returns Version2.ProjectEmail
- Defined in src/version2/projectEmail.ts:8

Methods

getProjectEmail

getProjectEmail<T = Version2Models.ProjectEmailAddress>(
parameters: string | Version2Parameters.GetProjectEmail,
callback: Callback<T>,
): Promise<void>
Returns the project's sender email address.

Permissions required: Browse projects project permission for the project.
Type Parameters
- T = Version2Models.ProjectEmailAddress
Parameters
- parameters: string | Version2Parameters.GetProjectEmail
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/projectEmail.ts:16
getProjectEmail<T = Version2Models.ProjectEmailAddress>(
parameters: string | Version2Parameters.GetProjectEmail,
callback?: undefined,
): Promise<T>
Returns the project's sender email address.

Permissions required: Browse projects project permission for the project.
Type Parameters
- T = Version2Models.ProjectEmailAddress
Parameters
- parameters: string | Version2Parameters.GetProjectEmail
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/projectEmail.ts:26

updateProjectEmail

updateProjectEmail<T = void>(
parameters: Version2Parameters.UpdateProjectEmail,
callback: Callback<T>,
): Promise<void>
Sets the project's sender email address.

If emailAddress is an empty string, the default email address is restored.

Permissions required: Administer Jira global permission or Administer Projects project permission.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.UpdateProjectEmail
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/projectEmail.ts:53
updateProjectEmail<T = void>(
parameters: Version2Parameters.UpdateProjectEmail,
callback?: undefined,
): Promise<T>
Sets the project's sender email address.

If emailAddress is an empty string, the default email address is restored.

Permissions required: Administer Jira global permission or Administer Projects project permission.
Type Parameters
- T = void
Parameters
- parameters: Version2Parameters.UpdateProjectEmail
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/projectEmail.ts:63