com.mailslurp.apis

Class AttachmentControllerApi

java.lang.Object

com.mailslurp.apis.AttachmentControllerApi

public class AttachmentControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AttachmentControllerApi()
AttachmentControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
List<String>	uploadAttachment(UploadAttachmentOptions uploadOptions) Upload an attachment for sending using base64 file encoding.
okhttp3.Call	uploadAttachmentAsync(UploadAttachmentOptions uploadOptions, ApiCallback<List<String>> _callback) Upload an attachment for sending using base64 file encoding.
List<String>	uploadAttachmentBytes(String string, String filename, byte[] byteArray) Upload an attachment for sending using file byte stream input octet stream.
okhttp3.Call	uploadAttachmentBytesAsync(String string, String filename, byte[] byteArray, ApiCallback<List<String>> _callback) Upload an attachment for sending using file byte stream input octet stream.
okhttp3.Call	uploadAttachmentBytesCall(String string, String filename, byte[] byteArray, ApiCallback _callback) Build call for uploadAttachmentBytes
ApiResponse<List<String>>	uploadAttachmentBytesWithHttpInfo(String string, String filename, byte[] byteArray) Upload an attachment for sending using file byte stream input octet stream.
okhttp3.Call	uploadAttachmentCall(UploadAttachmentOptions uploadOptions, ApiCallback _callback) Build call for uploadAttachment
ApiResponse<List<String>>	uploadAttachmentWithHttpInfo(UploadAttachmentOptions uploadOptions) Upload an attachment for sending using base64 file encoding.
List<String>	uploadMultipartForm(File file, String contentType, String filename, String xFilename) Upload an attachment for sending using a Multipart Form request.
okhttp3.Call	uploadMultipartFormAsync(File file, String contentType, String filename, String xFilename, ApiCallback<List<String>> _callback) Upload an attachment for sending using a Multipart Form request.
okhttp3.Call	uploadMultipartFormCall(File file, String contentType, String filename, String xFilename, ApiCallback _callback) Build call for uploadMultipartForm
ApiResponse<List<String>>	uploadMultipartFormWithHttpInfo(File file, String contentType, String filename, String xFilename) Upload an attachment for sending using a Multipart Form request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttachmentControllerApi

public AttachmentControllerApi()

AttachmentControllerApi

public AttachmentControllerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

uploadAttachmentCall

public okhttp3.Call uploadAttachmentCall(UploadAttachmentOptions uploadOptions,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for uploadAttachment

Parameters:

uploadOptions - uploadOptions (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

uploadAttachment

public List<String> uploadAttachment(UploadAttachmentOptions uploadOptions)
                              throws ApiException

Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment. Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.

Parameters:

uploadOptions - uploadOptions (required)

Returns:

List<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

uploadAttachmentWithHttpInfo

public ApiResponse<List<String>> uploadAttachmentWithHttpInfo(UploadAttachmentOptions uploadOptions)
                                                       throws ApiException

Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment. Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.

Parameters:

uploadOptions - uploadOptions (required)

Returns:

ApiResponse<List<String>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

uploadAttachmentAsync

public okhttp3.Call uploadAttachmentAsync(UploadAttachmentOptions uploadOptions,
                                          ApiCallback<List<String>> _callback)
                                   throws ApiException

Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment. (asynchronously) Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.

Parameters:

uploadOptions - uploadOptions (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

uploadAttachmentBytesCall

public okhttp3.Call uploadAttachmentBytesCall(String string,
                                              String filename,
                                              byte[] byteArray,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for uploadAttachmentBytes

Parameters:

string - Optional contentType for file. For instance `application/pdf` (optional)

filename - Optional filename to save upload with (optional)

byteArray - Byte array request body (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

uploadAttachmentBytes

public List<String> uploadAttachmentBytes(String string,
                                          String filename,
                                          byte[] byteArray)
                                   throws ApiException

Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment. Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.

Parameters:

string - Optional contentType for file. For instance `application/pdf` (optional)

filename - Optional filename to save upload with (optional)

byteArray - Byte array request body (optional)

Returns:

List<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

uploadAttachmentBytesWithHttpInfo

public ApiResponse<List<String>> uploadAttachmentBytesWithHttpInfo(String string,
                                                                   String filename,
                                                                   byte[] byteArray)
                                                            throws ApiException

Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment. Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.

Parameters:

string - Optional contentType for file. For instance `application/pdf` (optional)

filename - Optional filename to save upload with (optional)

byteArray - Byte array request body (optional)

Returns:

ApiResponse<List<String>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

uploadAttachmentBytesAsync

public okhttp3.Call uploadAttachmentBytesAsync(String string,
                                               String filename,
                                               byte[] byteArray,
                                               ApiCallback<List<String>> _callback)
                                        throws ApiException

Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment. (asynchronously) Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.

Parameters:

string - Optional contentType for file. For instance `application/pdf` (optional)

filename - Optional filename to save upload with (optional)

byteArray - Byte array request body (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

uploadMultipartFormCall

public okhttp3.Call uploadMultipartFormCall(File file,
                                            String contentType,
                                            String filename,
                                            String xFilename,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for uploadMultipartForm

Parameters:

file - file (required)

contentType - Optional content type of attachment (optional)

filename - Optional name of file (optional)

xFilename - Optional content type header of attachment (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

uploadMultipartForm

public List<String> uploadMultipartForm(File file,
                                        String contentType,
                                        String filename,
                                        String xFilename)
                                 throws ApiException

Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment. Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.

Parameters:

file - file (required)

contentType - Optional content type of attachment (optional)

filename - Optional name of file (optional)

xFilename - Optional content type header of attachment (optional)

Returns:

List<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

uploadMultipartFormWithHttpInfo

public ApiResponse<List<String>> uploadMultipartFormWithHttpInfo(File file,
                                                                 String contentType,
                                                                 String filename,
                                                                 String xFilename)
                                                          throws ApiException

Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment. Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.

Parameters:

file - file (required)

contentType - Optional content type of attachment (optional)

filename - Optional name of file (optional)

xFilename - Optional content type header of attachment (optional)

Returns:

ApiResponse<List<String>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

uploadMultipartFormAsync

public okhttp3.Call uploadMultipartFormAsync(File file,
                                             String contentType,
                                             String filename,
                                             String xFilename,
                                             ApiCallback<List<String>> _callback)
                                      throws ApiException

Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment. (asynchronously) Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.

Parameters:

file - file (required)

contentType - Optional content type of attachment (optional)

filename - Optional name of file (optional)

xFilename - Optional content type header of attachment (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-