UNPKG

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.

237 lines (236 loc) 5.71 kB
/** * MailSlurp API * MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. 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 { EmailRecipients, Sender } from './'; /** * Sent email details * @export * @interface SentEmailDto */ export interface SentEmailDto { /** * ID of sent email * @type {string} * @memberof SentEmailDto */ id: string; /** * User ID * @type {string} * @memberof SentEmailDto */ userId: string; /** * Inbox ID email was sent from * @type {string} * @memberof SentEmailDto */ inboxId: string; /** * Domain ID * @type {string} * @memberof SentEmailDto */ domainId?: string | null; /** * Recipients email was sent to * @type {Array<string>} * @memberof SentEmailDto */ to?: Array<string> | null; /** * Sent from address * @type {string} * @memberof SentEmailDto */ from?: string | null; /** * * @type {Sender} * @memberof SentEmailDto */ sender?: Sender | null; /** * * @type {EmailRecipients} * @memberof SentEmailDto */ recipients?: EmailRecipients | null; /** * * @type {string} * @memberof SentEmailDto */ replyTo?: string | null; /** * * @type {Array<string>} * @memberof SentEmailDto */ cc?: Array<string> | null; /** * * @type {Array<string>} * @memberof SentEmailDto */ bcc?: Array<string> | null; /** * Array of IDs of attachments that were sent with this email * @type {Array<string>} * @memberof SentEmailDto */ attachments?: Array<string> | null; /** * * @type {string} * @memberof SentEmailDto */ subject?: string | null; /** * MD5 Hash * @type {string} * @memberof SentEmailDto */ bodyMD5Hash?: string | null; /** * Sent email body * @type {string} * @memberof SentEmailDto */ body?: string | null; /** * * @type {Array<string>} * @memberof SentEmailDto */ toContacts?: Array<string> | null; /** * * @type {string} * @memberof SentEmailDto */ toGroup?: string | null; /** * * @type {string} * @memberof SentEmailDto */ charset?: string | null; /** * * @type {boolean} * @memberof SentEmailDto */ isHTML?: boolean | null; /** * * @type {Date} * @memberof SentEmailDto */ sentAt: Date; /** * * @type {Date} * @memberof SentEmailDto */ createdAt: Date; /** * * @type {Array<string>} * @memberof SentEmailDto */ pixelIds?: Array<string> | null; /** * RFC 5322 Message-ID header value without angle brackets. * @type {string} * @memberof SentEmailDto */ messageId?: string | null; /** * * @type {Array<string>} * @memberof SentEmailDto */ messageIds?: Array<string> | null; /** * * @type {boolean} * @memberof SentEmailDto */ virtualSend?: boolean | null; /** * * @type {string} * @memberof SentEmailDto */ templateId?: string | null; /** * * @type {{ [key: string]: object; }} * @memberof SentEmailDto */ templateVariables?: { [key: string]: object; } | null; /** * * @type {{ [key: string]: string; }} * @memberof SentEmailDto */ headers?: { [key: string]: string; } | null; /** * MailSlurp thread ID for email chain that enables lookup for In-Reply-To and References fields. * @type {string} * @memberof SentEmailDto */ threadId?: string | null; /** * An excerpt of the body of the email message for quick preview. Takes HTML content part if exists falls back to TEXT content part if not * @type {string} * @memberof SentEmailDto */ bodyExcerpt?: string | null; /** * An excerpt of the body of the email message for quick preview. Takes TEXT content part if exists * @type {string} * @memberof SentEmailDto */ textExcerpt?: string | null; /** * Parsed value of In-Reply-To header. A Message-ID in a thread. * @type {string} * @memberof SentEmailDto */ inReplyTo?: string | null; /** * Is email favourited * @type {boolean} * @memberof SentEmailDto */ favourite?: boolean | null; /** * Size of raw email message in bytes * @type {number} * @memberof SentEmailDto */ sizeBytes?: number | null; /** * * @type {boolean} * @memberof SentEmailDto */ html?: boolean; } export declare function SentEmailDtoFromJSON(json: any): SentEmailDto; export declare function SentEmailDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): SentEmailDto; export declare function SentEmailDtoToJSON(value?: SentEmailDto | null): any;