Skip to content

Function: getProjectEmail() ​

ts
function getProjectEmail(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  emailAddress?: string;
  emailAddressStatus?: string[];
}>;

Defined in: src/cloud/api/projectEmail.ts:12

Returns the project's sender email address.

Permissions required: Browse projects project permission for the project.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ projectId: number; }-
parameters.projectIdnumberThe project ID.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; emailAddress?: string; emailAddressStatus?: string[]; }>