e2e-mailbox/dist/lib/services/mailboxService.d.ts

E2E test your email notification system using GuerrillaMail API.

import { EmailResponse, MailboxProvider } from '../types';
declare abstract class MailboxService {
    abstract API_URL: string;
    abstract PROVIDER: MailboxProvider;
    sleep(timeInMs: number): Promise<void>;
    /** --- Public Functions --- */
    /**
     * Initialize a session and set the client with an email address.
     * @returns email address
     */
    abstract createEmailAddress(): Promise<string>;
    /**
     * Get the current list of emails from the email inbox.
     * @returns Array of emails
     */
    abstract fetchEmailList(): Promise<EmailResponse[]>;
    /**
     * Forget the current email address.
     * @param emailAddress
     * @returns True on success, false on failure
     */
    abstract forgetEmailAddress(emailAddress: string): Promise<boolean | undefined>;
    /**
     * Delete a specific email by ID.
     * @param emailId
     * @returns true on success, false on failure
     */
    abstract deleteEmailById(emailId: string): Promise<boolean | undefined>;
    /**
     * Get the contents of an email. All HTML in the body of the email is filtered.
     * Eg, Javascript, applets, iframes, etc is removed. Subject and email excerpt are escaped using HTML Entities.
     * Only emails owned by the current session id can be fetched.
     * @param emailId
     * @returns
     */
    abstract fetchEmailById(emailId: string): Promise<EmailResponse | undefined>;
    /**
     * Send an email to this mailbox. Only works for the DeveloperMail provider.
     * @param subject
     * @param body
     * @returns A `boolean` representing success or failure.
     */
    abstract sendSelfMail(subject: string, body: string): Promise<boolean>;
}
export default MailboxService;