Class: TempMail

Defined in: src/temp-mail/tempmail.ts:46

The TempMail class provides access to the temporary email creation and inbox message retrieval utilizing the unofficial API: TempMail API .

Constructor

Creates an instance of the TempMail class.

TempMail: A new instance of the TempMail class.

static create(): Promise<TempMailResponse<TempMailCreateResult>>

Defined in: src/temp-mail/tempmail.ts:59

Generates a new temporary email address.

Promise<TempMailResponse<TempMailCreateResult>>: An object containing the generated email address and a token for accessing the inbox.

This method may throw an error on HTTP request failures or parsing issues.

static checkInbox(token: string): Promise<TempMailResponse<TempMailMessage[]>>

Defined in: src/temp-mail/tempmail.ts:91

Fetches inbox messages for a given temporary email token.

token (string): A unique identifier associated with the generated email address.

Promise<TempMailResponse<TempMailMessage[]>>: A list of inbox messages associated with the provided token.

The method throws an error if the provided token is invalid or if the request fails.


const tempEmail = await TempMail.create();
const messages = await TempMail.checkInbox(tempEmail.token);