List SMTP Passwords method 🪪 Sub-Accounts

Retrieves details of all SMTP passwords associated with the specified sub-account. For security, the full SMTP password is not returned; only the password ID and a partially redacted version are provided.

Usage

modular.ts

import { MailChannelsClient, SubAccounts } from 'mailchannels-sdk'

const mailchannels = new MailChannelsClient('your-api-key')
const subAccounts = new SubAccounts(mailchannels)

const { data, error } = await subAccounts.listSmtpPasswords('validhandle123')

full.ts

import { MailChannels } from 'mailchannels-sdk'

const mailchannels = new MailChannels('your-api-key')

const { data, error } = await mailchannels.subAccounts.listSmtpPasswords('validhandle123')

Params

• handle string required: The handle of the sub-account to retrieve the SMTP passwords for.

Response

• data SubAccountsSmtpPassword[] | null nullable
  • enabled boolean guaranteed: Whether the SMTP password is enabled.
  • id number guaranteed: The SMTP password ID for the sub-account.
  • smtpPassword string guaranteed: SMTP password for the sub-account.
• error ErrorResponse | null nullable: Error information if the operation failed.
  • message string guaranteed: A human-readable description of the error.
  • statusCode number | null nullable: The HTTP status code from the API, or null if the error is not related to an HTTP request. This field is intended for diagnostic use only and should not be relied upon.
  • type string guaranteed: A string identifier for the type of error. This field is intended for diagnostic use only and should not be relied upon.

Type declarations

Signature

async function listSmtpPasswords (handle: string): Promise<SubAccountsListSmtpPasswordResponse>

Response type declarations

interface ErrorResponse {
  message: string;
  statusCode: number | null;
  type: ErrorType;
}

type DataResponse<T> = {
  data: T;
  error: null;
} | {
  data: null;
  error: ErrorResponse;
};

SMTP Password type declarations

interface SubAccountsSmtpPassword {
  enabled: boolean;
  id: number;
  smtpPassword: string;
}

type SubAccountsListSmtpPasswordResponse = DataResponse<SubAccountsSmtpPassword[]>;

Source

Source • Playground • Docs • Tests