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.
40 lines (39 loc) • 2.21 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 uploading files for attachments. When sending emails with the API that require attachments first upload each attachment. Then use the returned attachment ID in your `SendEmailOptions` when sending an email. This way you can use attachments multiple times once they have been uploaded.
* @export
* @interface UploadAttachmentOptions
*/
export interface UploadAttachmentOptions {
/**
* Optional contentType for file. For instance `application/pdf`
* @type {string}
* @memberof UploadAttachmentOptions
*/
contentType?: string | null;
/**
* Optional filename to save upload with. Will be the name that is shown in email clients
* @type {string}
* @memberof UploadAttachmentOptions
*/
filename?: string | null;
/**
* Base64 encoded string of file contents. Typically this means reading the bytes or string content of a file and then converting that to a base64 encoded string. For examples of how to do this see https://www.mailslurp.com/guides/base64-file-uploads/
* @type {string}
* @memberof UploadAttachmentOptions
*/
base64Contents: string;
}
export declare function UploadAttachmentOptionsFromJSON(json: any): UploadAttachmentOptions;
export declare function UploadAttachmentOptionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): UploadAttachmentOptions;
export declare function UploadAttachmentOptionsToJSON(value?: UploadAttachmentOptions | null): any;