Class EmailManagementClient

이메일 관리 클라이언트

이메일 통계, 수신거부, 태그, UID 관리 기능을 제공합니다.

Example

const client = new EmailManagementClient({ accessKeyId, secretAccessKey });

// 통계 조회
const stats = await client.getStats("client-1", {
  from: "2024-01-01 00:00",
  to: "2024-01-31 23:59"
});

// 수신거부 등록
await client.createBlockReceivers("client-1", {
  blockReceiverList: [{ mailAddress: "user@example.com" }]
});

// 태그 생성
const tag = await client.createTag("client-1", { tagName: "VIP고객" });

Constructors

constructor

new EmailManagementClient(
credentials: AwesomeMessageCredentials,
): EmailManagementClient
이메일 관리 클라이언트 생성자
Parameters
- credentials: AwesomeMessageCredentials
  API 인증 크레덴셜
Returns EmailManagementClient
Overrides BaseClient.constructor

Methods

`Protected`createSendHeaders

createSendHeaders(options?: SendOptions): Record<string, string>
SendOptions에서 HTTP 헤더를 생성합니다
Parameters
- Optionaloptions: SendOptions
  발송 옵션
Returns Record<string, string>
생성된 헤더 객체

Inherited from BaseClient.createSendHeaders

`Protected`get

get<T>(path: string, headers?: Record<string, string>): Promise<T>
GET 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.get

`Protected`post

post<T>(
    path: string,
    body?: unknown,
    headers?: Record<string, string>,
): Promise<T>
POST 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalbody: unknown
  요청 본문
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.post

`Protected`postFormData

postFormData<T>(
    path: string,
    formData: FormData,
    headers?: Record<string, string>,
): Promise<T>
FormData를 사용한 POST 요청 (multipart/form-data)
Type Parameters
- T
Parameters
- path: string
  API 경로
- formData: FormData
  undici의 FormData 객체
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.postFormData

`Protected`put

put<T>(
    path: string,
    body?: unknown,
    headers?: Record<string, string>,
): Promise<T>
PUT 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalbody: unknown
  요청 본문
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.put

`Protected`delete

delete<T>(path: string, headers?: Record<string, string>): Promise<T>
DELETE 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.delete

`Protected`deleteWithBody

deleteWithBody<T>(
    path: string,
    body?: unknown,
    headers?: Record<string, string>,
): Promise<T>
DELETE 요청 (body 포함)
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalbody: unknown
  요청 본문
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.deleteWithBody

getIntegratedStats

getIntegratedStats(
externalId: string,
query: ListEmailIntegratedStatsRequest,
): Promise<ListEmailIntegratedStatsResponse>
통합 통계를 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- query: ListEmailIntegratedStatsRequest
  조회 조건
Returns Promise<ListEmailIntegratedStatsResponse>
통합 통계 데이터
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.getIntegratedStats("client-1", {
  from: "2024-01-01 00:00",
  to: "2024-01-31 23:59",
  searchType: "DATE",
  mailTypes: ["NORMAL", "MASS"]
});
```

getStats

getStats(
externalId: string,
query: ListEmailStatsRequest,
): Promise<ListEmailStatsResponse>
통계를 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- query: ListEmailStatsRequest
  조회 조건 (eventCategory 필수)
Returns Promise<ListEmailStatsResponse>
통계 데이터
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.getStats("client-1", {
  eventCategory: "MESSAGE",
  from: "2024-01-01T00:00:00.000+09:00",
  to: "2024-01-31T23:59:59.000+09:00"
});
```

getStatsTotal

getStatsTotal(
externalId: string,
query: GetEmailStatsTotalRequest,
): Promise<GetEmailStatsTotalResponse>
통계 합계를 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- query: GetEmailStatsTotalRequest
  조회 조건 (eventCategory 필수)
Returns Promise<GetEmailStatsTotalResponse>
통계 합계 데이터
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.getStatsTotal("client-1", {
  eventCategory: "MESSAGE",
  from: "2024-01-01T00:00:00.000+09:00",
  to: "2024-01-31T23:59:59.000+09:00"
});
```

listBlockReceivers

listBlockReceivers(
externalId: string,
query?: ListEmailBlockReceiversRequest,
): Promise<ListEmailBlockReceiversResponse>
수신거부 목록을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- Optionalquery: ListEmailBlockReceiversRequest
  조회 조건
Returns Promise<ListEmailBlockReceiversResponse>
수신거부 목록
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.listBlockReceivers("client-1", {
  startBlockDate: "2024-01-01 00:00:00",
  endBlockDate: "2024-01-31 23:59:59",
  pageNum: 1,
  pageSize: 15
});
```

createBlockReceivers

createBlockReceivers(
externalId: string,
request: CreateEmailBlockReceiversRequest,
): Promise<void>
수신거부를 등록합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: CreateEmailBlockReceiversRequest
  수신거부 등록 요청 데이터
Returns Promise<void>
void
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.createBlockReceivers("client-1", {
  blockReceiverList: [
    { mailAddress: "user1@example.com" },
    { mailAddress: "user2@example.com" }
  ]
});
```

deleteBlockReceivers

deleteBlockReceivers(
externalId: string,
request: DeleteEmailBlockReceiversRequest,
): Promise<void>
수신거부를 삭제합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: DeleteEmailBlockReceiversRequest
  수신거부 삭제 요청 데이터
Returns Promise<void>
void
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.deleteBlockReceivers("client-1", {
  deleted: true,
  blockReceiverList: [
    { mailAddress: "user1@example.com" }
  ]
});
```

listTags(
externalId: string,
query?: ListEmailTagsRequest,
): Promise<ListEmailTagsResponse>
태그 목록을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- Optionalquery: ListEmailTagsRequest
  조회 조건
Returns Promise<ListEmailTagsResponse>
태그 목록
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.listTags("client-1", {
  pageNum: 1,
  pageSize: 15
});
```

createTag

createTag(
externalId: string,
request: CreateEmailTagRequest,
): Promise<CreateEmailTagResponse>
태그를 생성합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: CreateEmailTagRequest
  태그 생성 요청 데이터
Returns Promise<CreateEmailTagResponse>
생성된 태그 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.createTag("client-1", {
  tagName: "VIP고객"
});
// { tagId: "tag_abc123" }
```

updateTag

updateTag(
    externalId: string,
    tagId: string,
    request: UpdateEmailTagRequest,
): Promise<void>
태그를 수정합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- tagId: string
  태그 ID
- request: UpdateEmailTagRequest
  태그 수정 요청 데이터
Returns Promise<void>
void
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
NotFoundException 해당 태그를 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.updateTag("client-1", "tag_abc123", {
  tagName: "VVIP고객"
});
```

deleteTag

deleteTag(externalId: string, tagId: string): Promise<void>
태그를 삭제합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- tagId: string
  태그 ID
Returns Promise<void>
void
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
NotFoundException 해당 태그를 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.deleteTag("client-1", "tag_abc123");
```

listUids

listUids(
externalId: string,
query?: ListEmailUidsRequest,
): Promise<ListEmailUidsResponse>
UID 목록을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- Optionalquery: ListEmailUidsRequest
  조회 조건
Returns Promise<ListEmailUidsResponse>
UID 목록
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.listUids("client-1", {
  tagId: "tag_abc123",
  offset: 0,
  limit: 15
});
```

getUid

getUid(externalId: string, uid: string): Promise<GetEmailUidResponse>
UID 상세를 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- uid: string
  UID
Returns Promise<GetEmailUidResponse>
UID 상세 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
NotFoundException 해당 UID를 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await client.getUid("client-1", "user123");
```

createUids

createUids(externalId: string, request: CreateEmailUidsRequest): Promise<void>
UID를 등록합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: CreateEmailUidsRequest
  UID 등록 요청 데이터
Returns Promise<void>
void
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.createUids("client-1", {
  uids: [
    {
      uid: "user123",
      tagIds: ["tag_abc123"],
      contacts: [{ contactType: "EMAIL_ADDRESS", contact: "user@example.com" }]
    }
  ]
});
```

deleteUid

deleteUid(externalId: string, uid: string): Promise<void>
UID를 삭제합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- uid: string
  UID
Returns Promise<void>
void
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
NotFoundException 해당 UID를 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.deleteUid("client-1", "user123");
```

addEmailAddress

addEmailAddress(
    externalId: string,
    uid: string,
    emailAddress: string,
): Promise<void>
UID에 이메일 주소를 추가합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- uid: string
  UID
- emailAddress: string
  이메일 주소
Returns Promise<void>
void
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
NotFoundException 해당 UID를 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.addEmailAddress("client-1", "user123", "new@example.com");
```

deleteEmailAddress

deleteEmailAddress(
    externalId: string,
    uid: string,
    emailAddress: string,
): Promise<void>
UID에서 이메일 주소를 삭제합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- uid: string
  UID
- emailAddress: string
  이메일 주소
Returns Promise<void>
void
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
NotFoundException 해당 UID 또는 이메일 주소를 찾을 수 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await client.deleteEmailAddress("client-1", "user123", "old@example.com");
```

Properties

`Protected`credentials

credentials: AwesomeMessageCredentials

API 인증 크레덴셜

Class EmailManagementClient

Example

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns EmailManagementClient

Methods

ProtectedcreateSendHeaders

Parameters

Returns Record<string, string>

Protectedget

Type Parameters

Parameters

Returns Promise<T>

Protectedpost

Type Parameters

Parameters

Returns Promise<T>

ProtectedpostFormData

Type Parameters

Parameters

Returns Promise<T>

Protectedput

Type Parameters

Parameters

Returns Promise<T>

Protecteddelete

Type Parameters

Parameters

Returns Promise<T>

ProtecteddeleteWithBody

Type Parameters

Parameters

Returns Promise<T>

getIntegratedStats

Parameters

Returns Promise<ListEmailIntegratedStatsResponse>

Throws

Throws

Throws

Example

getStats

Parameters

Returns Promise<ListEmailStatsResponse>

Throws

Throws

Throws

Example

getStatsTotal

Parameters

Returns Promise<GetEmailStatsTotalResponse>

Throws

Throws

Throws

Example

listBlockReceivers

Parameters

Returns Promise<ListEmailBlockReceiversResponse>

Throws

Throws

Throws

Example

createBlockReceivers

Parameters

Returns Promise<void>

Throws

Throws

Throws

Example

deleteBlockReceivers

Parameters

Returns Promise<void>

Throws

Throws

Throws

Example

`Protected`createSendHeaders

`Protected`get

`Protected`post

`Protected`postFormData

`Protected`put

`Protected`delete

`Protected`deleteWithBody