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.
52 lines (51 loc) • 2.63 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.
*/
/**
* Options for updating inbox properties
* @export
* @interface UpdateInboxOptions
*/
export interface UpdateInboxOptions {
/**
* Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search
* @type {string}
* @memberof UpdateInboxOptions
*/
name?: string | null;
/**
* Description of an inbox for labelling and searching purposes
* @type {string}
* @memberof UpdateInboxOptions
*/
description?: string | null;
/**
* Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
* @type {Array<string>}
* @memberof UpdateInboxOptions
*/
tags?: Array<string> | null;
/**
* Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.
* @type {Date}
* @memberof UpdateInboxOptions
*/
expiresAt?: Date | null;
/**
* Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering
* @type {boolean}
* @memberof UpdateInboxOptions
*/
favourite?: boolean | null;
}
export declare function UpdateInboxOptionsFromJSON(json: any): UpdateInboxOptions;
export declare function UpdateInboxOptionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateInboxOptions;
export declare function UpdateInboxOptionsToJSON(value?: UpdateInboxOptions | null): any;