mailslurp-client
Version:
Official client for MailSlurp Email and SMS API. Create email addresses and phone numbers in Javascript without a mail server. Send and receive real emails in applications or tests.
142 lines (141 loc) • 5.35 kB
TypeScript
/**
* MailSlurp API
* MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It\'s designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
*
* The version of the OpenAPI document: 6.5.2
* Contact: contact@mailslurp.dev
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import * as runtime from '../runtime';
import { InboxDto, SimpleSendEmailOptions } from '../models';
export interface CreateNewEmailAddressRequest {
allowTeamAccess?: boolean;
useDomainPool?: boolean;
expiresAt?: Date;
expiresIn?: number;
emailAddress?: string;
inboxType?: CreateNewEmailAddressInboxTypeEnum;
description?: string;
name?: string;
tags?: Array<string>;
favourite?: boolean;
virtualInbox?: boolean;
useShortAddress?: boolean;
domainName?: string;
domainId?: string;
}
export interface CreateRandomInboxRequest {
allowTeamAccess?: boolean;
useDomainPool?: boolean;
expiresAt?: Date;
expiresIn?: number;
emailAddress?: string;
inboxType?: CreateRandomInboxInboxTypeEnum;
description?: string;
name?: string;
tags?: Array<string>;
favourite?: boolean;
virtualInbox?: boolean;
useShortAddress?: boolean;
domainName?: string;
domainId?: string;
}
export interface DeleteEmailAddressRequest {
inboxId: string;
}
export interface EmptyInboxRequest {
inboxId: string;
}
export interface SendEmailQueryRequest {
to: string;
senderId?: string;
body?: string;
subject?: string;
}
export interface SendEmailSimpleRequest {
simpleSendEmailOptions: SimpleSendEmailOptions;
}
/**
*
*/
export declare class CommonActionsControllerApi extends runtime.BaseAPI {
/**
* Returns an Inbox with an `id` and an `emailAddress`
* Create new random inbox
*/
createNewEmailAddressRaw(requestParameters: CreateNewEmailAddressRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<InboxDto>>;
/**
* Returns an Inbox with an `id` and an `emailAddress`
* Create new random inbox
*/
createNewEmailAddress(requestParameters: CreateNewEmailAddressRequest, initOverrides?: RequestInit): Promise<InboxDto>;
/**
* Returns an Inbox with an `id` and an `emailAddress`
* Create new random inbox
*/
createRandomInboxRaw(requestParameters: CreateRandomInboxRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<InboxDto>>;
/**
* Returns an Inbox with an `id` and an `emailAddress`
* Create new random inbox
*/
createRandomInbox(requestParameters: CreateRandomInboxRequest, initOverrides?: RequestInit): Promise<InboxDto>;
/**
* Deletes inbox email address
* Delete inbox email address by inbox id
*/
deleteEmailAddressRaw(requestParameters: DeleteEmailAddressRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Deletes inbox email address
* Delete inbox email address by inbox id
*/
deleteEmailAddress(requestParameters: DeleteEmailAddressRequest, initOverrides?: RequestInit): Promise<void>;
/**
* Deletes all emails
* Delete all emails in an inbox
*/
emptyInboxRaw(requestParameters: EmptyInboxRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Deletes all emails
* Delete all emails in an inbox
*/
emptyInbox(requestParameters: EmptyInboxRequest, initOverrides?: RequestInit): Promise<void>;
/**
* If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded.
* Send an email using query parameters
*/
sendEmailQueryRaw(requestParameters: SendEmailQueryRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded.
* Send an email using query parameters
*/
sendEmailQuery(requestParameters: SendEmailQueryRequest, initOverrides?: RequestInit): Promise<void>;
/**
* If no senderId or inboxId provided a random email address will be used to send from.
* Send an email
*/
sendEmailSimpleRaw(requestParameters: SendEmailSimpleRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* If no senderId or inboxId provided a random email address will be used to send from.
* Send an email
*/
sendEmailSimple(requestParameters: SendEmailSimpleRequest, initOverrides?: RequestInit): Promise<void>;
}
/**
* @export
* @enum {string}
*/
export declare enum CreateNewEmailAddressInboxTypeEnum {
HTTP_INBOX = "HTTP_INBOX",
SMTP_INBOX = "SMTP_INBOX"
}
/**
* @export
* @enum {string}
*/
export declare enum CreateRandomInboxInboxTypeEnum {
HTTP_INBOX = "HTTP_INBOX",
SMTP_INBOX = "SMTP_INBOX"
}