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.
134 lines (133 loc) • 4.34 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.
*/
/**
* DELIVERY_STATUS webhook payload. Sent to your webhook url endpoint via HTTP POST when an email delivery status is created. This could be a successful delivery or a delivery failure.
* @export
* @interface WebhookDeliveryStatusPayload
*/
export interface WebhookDeliveryStatusPayload {
/**
* Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
* @type {string}
* @memberof WebhookDeliveryStatusPayload
*/
messageId: string;
/**
* ID of webhook entity being triggered
* @type {string}
* @memberof WebhookDeliveryStatusPayload
*/
webhookId: string;
/**
* Name of the event type webhook is being triggered for.
* @type {string}
* @memberof WebhookDeliveryStatusPayload
*/
eventName: WebhookDeliveryStatusPayloadEventNameEnum;
/**
* Name of the webhook being triggered
* @type {string}
* @memberof WebhookDeliveryStatusPayload
*/
webhookName?: string | null;
/**
* ID of delivery status
* @type {string}
* @memberof WebhookDeliveryStatusPayload
*/
id: string;
/**
* User ID of event
* @type {string}
* @memberof WebhookDeliveryStatusPayload
*/
userId: string;
/**
* ID of sent email
* @type {string}
* @memberof WebhookDeliveryStatusPayload
*/
sentId?: string | null;
/**
* IP address of the remote Mail Transfer Agent
* @type {string}
* @memberof WebhookDeliveryStatusPayload
*/
remoteMtaIp?: string | null;
/**
* Id of the inbox
* @type {string}
* @memberof WebhookDeliveryStatusPayload
*/
inboxId?: string | null;
/**
* Mail Transfer Agent reporting delivery status
* @type {string}
* @memberof WebhookDeliveryStatusPayload
*/
reportingMta?: string | null;
/**
* Recipients for delivery
* @type {Array<string>}
* @memberof WebhookDeliveryStatusPayload
*/
recipients?: Array<string> | null;
/**
* SMTP server response message
* @type {string}
* @memberof WebhookDeliveryStatusPayload
*/
smtpResponse?: string | null;
/**
* SMTP server status
* @type {number}
* @memberof WebhookDeliveryStatusPayload
*/
smtpStatusCode?: number | null;
/**
* Time in milliseconds for delivery processing
* @type {number}
* @memberof WebhookDeliveryStatusPayload
*/
processingTimeMillis?: number | null;
/**
* Time event was received
* @type {Date}
* @memberof WebhookDeliveryStatusPayload
*/
received?: Date | null;
/**
* Email subject
* @type {string}
* @memberof WebhookDeliveryStatusPayload
*/
subject?: string | null;
}
/**
* @export
* @enum {string}
*/
export declare enum WebhookDeliveryStatusPayloadEventNameEnum {
EMAIL_RECEIVED = "EMAIL_RECEIVED",
NEW_EMAIL = "NEW_EMAIL",
NEW_CONTACT = "NEW_CONTACT",
NEW_ATTACHMENT = "NEW_ATTACHMENT",
EMAIL_OPENED = "EMAIL_OPENED",
EMAIL_READ = "EMAIL_READ",
DELIVERY_STATUS = "DELIVERY_STATUS",
BOUNCE = "BOUNCE",
BOUNCE_RECIPIENT = "BOUNCE_RECIPIENT",
NEW_SMS = "NEW_SMS"
}
export declare function WebhookDeliveryStatusPayloadFromJSON(json: any): WebhookDeliveryStatusPayload;
export declare function WebhookDeliveryStatusPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookDeliveryStatusPayload;
export declare function WebhookDeliveryStatusPayloadToJSON(value?: WebhookDeliveryStatusPayload | null): any;