Class ProjectEmailService

This resource represents the email address used to send a project's notifications. Use it to get and set the project's sender email address.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-email

Hierarchy

CommonHttpService
- ProjectEmailService

Index

Constructors

Methods

getProjectEmail updateProjectEmail initialize

Constructors

constructor

new ProjectEmailService(getClientInstance): ProjectEmailService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns ProjectEmailService
Inherited from CommonHttpService.constructor

Methods

getProjectEmail

getProjectEmail(params): Promise<ProjectEmailAddress>
Returns the project's sender email address.

Permissions required: Browse projects project permission for the project.
Parameters
- params: {
  projectId: number;
  }
  - projectId: number
    The project ID.
Returns Promise<ProjectEmailAddress>
Returned if the request is successful.

example:
```
{
  "emailAddress": "jira@example.customdomain.com",
  "emailAddressStatus": [
    "Email address or domain not verified."
  ]
}
```
Path
GET /rest/api/3/project/{projectId}/email @scopes-current manage:jira-project @scopes-beta read:project.email:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-email#api-rest-api-3-project-projectid-email-get

updateProjectEmail

updateProjectEmail(params): 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.
Parameters
- params: {
  projectEmailAddress: ProjectEmailAddress;
  projectId: number;
  }
  - projectEmailAddress: ProjectEmailAddress
    The project's sender email address to be set.
    
    Example
  - projectId: number
    The project ID.
Returns Promise<void>
Returned if the project's sender email address is successfully set.

Path
PUT /rest/api/3/project/{projectId}/email @scopes-current manage:jira-project @scopes-beta write:project.email:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-email#api-rest-api-3-project-projectid-email-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize