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
void	deleteAllAttachments() Delete all attachments
okhttp3.Call	deleteAllAttachmentsAsync(ApiCallback<Void> _callback) Delete all attachments (asynchronously)
okhttp3.Call	deleteAllAttachmentsCall(ApiCallback _callback) Build call for deleteAllAttachments
ApiResponse<Void>	deleteAllAttachmentsWithHttpInfo() Delete all attachments
void	deleteAttachment(String attachmentId) Delete an attachment
okhttp3.Call	deleteAttachmentAsync(String attachmentId, ApiCallback<Void> _callback) Delete an attachment (asynchronously)
okhttp3.Call	deleteAttachmentCall(String attachmentId, ApiCallback _callback) Build call for deleteAttachment
ApiResponse<Void>	deleteAttachmentWithHttpInfo(String attachmentId) Delete an attachment
DownloadAttachmentDto	downloadAttachmentAsBase64Encoded(String attachmentId) Get email attachment as base64 encoded string as alternative to binary responses.
okhttp3.Call	downloadAttachmentAsBase64EncodedAsync(String attachmentId, ApiCallback<DownloadAttachmentDto> _callback) Get email attachment as base64 encoded string as alternative to binary responses.
okhttp3.Call	downloadAttachmentAsBase64EncodedCall(String attachmentId, ApiCallback _callback) Build call for downloadAttachmentAsBase64Encoded
ApiResponse<DownloadAttachmentDto>	downloadAttachmentAsBase64EncodedWithHttpInfo(String attachmentId) Get email attachment as base64 encoded string as alternative to binary responses.
byte[]	downloadAttachmentAsBytes(String attachmentId) Download attachments.
okhttp3.Call	downloadAttachmentAsBytesAsync(String attachmentId, ApiCallback<byte[]> _callback) Download attachments.
okhttp3.Call	downloadAttachmentAsBytesCall(String attachmentId, ApiCallback _callback) Build call for downloadAttachmentAsBytes
ApiResponse<byte[]>	downloadAttachmentAsBytesWithHttpInfo(String attachmentId) Download attachments.
ApiClient	getApiClient()
AttachmentEntity	getAttachment(String attachmentId) Get an attachment entity
okhttp3.Call	getAttachmentAsync(String attachmentId, ApiCallback<AttachmentEntity> _callback) Get an attachment entity (asynchronously)
okhttp3.Call	getAttachmentCall(String attachmentId, ApiCallback _callback) Build call for getAttachment
AttachmentMetaData	getAttachmentInfo(String attachmentId) Get email attachment metadata information Returns the metadata for an attachment.
okhttp3.Call	getAttachmentInfoAsync(String attachmentId, ApiCallback<AttachmentMetaData> _callback) Get email attachment metadata information (asynchronously) Returns the metadata for an attachment.
okhttp3.Call	getAttachmentInfoCall(String attachmentId, ApiCallback _callback) Build call for getAttachmentInfo
ApiResponse<AttachmentMetaData>	getAttachmentInfoWithHttpInfo(String attachmentId) Get email attachment metadata information Returns the metadata for an attachment.
PageAttachmentEntity	getAttachments(Integer page, Integer size, String sort, String fileNameFilter, OffsetDateTime since, OffsetDateTime before) Get email attachments Get all attachments in paginated response.
okhttp3.Call	getAttachmentsAsync(Integer page, Integer size, String sort, String fileNameFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageAttachmentEntity> _callback) Get email attachments (asynchronously) Get all attachments in paginated response.
okhttp3.Call	getAttachmentsCall(Integer page, Integer size, String sort, String fileNameFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for getAttachments
ApiResponse<PageAttachmentEntity>	getAttachmentsWithHttpInfo(Integer page, Integer size, String sort, String fileNameFilter, OffsetDateTime since, OffsetDateTime before) Get email attachments Get all attachments in paginated response.
ApiResponse<AttachmentEntity>	getAttachmentWithHttpInfo(String attachmentId) Get an attachment entity
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
List<String>	uploadAttachment(UploadAttachmentOptions uploadAttachmentOptions) Upload an attachment for sending using base64 file encoding.
okhttp3.Call	uploadAttachmentAsync(UploadAttachmentOptions uploadAttachmentOptions, ApiCallback<List<String>> _callback) Upload an attachment for sending using base64 file encoding.
List<String>	uploadAttachmentBytes(UploadAttachmentBytesRequest uploadAttachmentBytesRequest, String contentType, String filename) Upload an attachment for sending using file byte stream input octet stream.
okhttp3.Call	uploadAttachmentBytesAsync(UploadAttachmentBytesRequest uploadAttachmentBytesRequest, String contentType, String filename, ApiCallback<List<String>> _callback) Upload an attachment for sending using file byte stream input octet stream.
okhttp3.Call	uploadAttachmentBytesCall(UploadAttachmentBytesRequest uploadAttachmentBytesRequest, String contentType, String filename, ApiCallback _callback) Build call for uploadAttachmentBytes
ApiResponse<List<String>>	uploadAttachmentBytesWithHttpInfo(UploadAttachmentBytesRequest uploadAttachmentBytesRequest, String contentType, String filename) Upload an attachment for sending using file byte stream input octet stream.
okhttp3.Call	uploadAttachmentCall(UploadAttachmentOptions uploadAttachmentOptions, ApiCallback _callback) Build call for uploadAttachment
ApiResponse<List<String>>	uploadAttachmentWithHttpInfo(UploadAttachmentOptions uploadAttachmentOptions) Upload an attachment for sending using base64 file encoding.
List<String>	uploadMultipartForm(String contentType, String filename, String xFilename, UploadMultipartFormRequest uploadMultipartFormRequest) Upload an attachment for sending using a Multipart Form request.
okhttp3.Call	uploadMultipartFormAsync(String contentType, String filename, String xFilename, UploadMultipartFormRequest uploadMultipartFormRequest, ApiCallback<List<String>> _callback) Upload an attachment for sending using a Multipart Form request.
okhttp3.Call	uploadMultipartFormCall(String contentType, String filename, String xFilename, UploadMultipartFormRequest uploadMultipartFormRequest, ApiCallback _callback) Build call for uploadMultipartForm
ApiResponse<List<String>>	uploadMultipartFormWithHttpInfo(String contentType, String filename, String xFilename, UploadMultipartFormRequest uploadMultipartFormRequest) 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)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

deleteAllAttachmentsCall

public okhttp3.Call deleteAllAttachmentsCall(ApiCallback _callback)
                                      throws ApiException

Build call for deleteAllAttachments

Parameters:

_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
204	No Content	-

deleteAllAttachments

public void deleteAllAttachments()
                          throws ApiException

Delete all attachments

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
204	No Content	-

deleteAllAttachmentsWithHttpInfo

public ApiResponse<Void> deleteAllAttachmentsWithHttpInfo()
                                                   throws ApiException

Delete all attachments

Returns:

ApiResponse<Void>

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
204	No Content	-

deleteAllAttachmentsAsync

public okhttp3.Call deleteAllAttachmentsAsync(ApiCallback<Void> _callback)
                                       throws ApiException

Delete all attachments (asynchronously)

Parameters:

_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
204	No Content	-

deleteAttachmentCall

public okhttp3.Call deleteAttachmentCall(String attachmentId,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for deleteAttachment

Parameters:

attachmentId - ID of attachment (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
204	No Content	-

deleteAttachment

public void deleteAttachment(String attachmentId)
                      throws ApiException

Delete an attachment

Parameters:

attachmentId - ID of attachment (required)

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
204	No Content	-

deleteAttachmentWithHttpInfo

public ApiResponse<Void> deleteAttachmentWithHttpInfo(String attachmentId)
                                               throws ApiException

Delete an attachment

Parameters:

attachmentId - ID of attachment (required)

Returns:

ApiResponse<Void>

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
204	No Content	-

deleteAttachmentAsync

public okhttp3.Call deleteAttachmentAsync(String attachmentId,
                                          ApiCallback<Void> _callback)
                                   throws ApiException

Delete an attachment (asynchronously)

Parameters:

attachmentId - ID of attachment (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
204	No Content	-

downloadAttachmentAsBase64EncodedCall

public okhttp3.Call downloadAttachmentAsBase64EncodedCall(String attachmentId,
                                                          ApiCallback _callback)
                                                   throws ApiException

Build call for downloadAttachmentAsBase64Encoded

Parameters:

attachmentId - ID of attachment (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
200	OK	-

downloadAttachmentAsBase64Encoded

public DownloadAttachmentDto downloadAttachmentAsBase64Encoded(String attachmentId)
                                                        throws ApiException

Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents. Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.

Parameters:

attachmentId - ID of attachment (required)

Returns:

DownloadAttachmentDto

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
200	OK	-

downloadAttachmentAsBase64EncodedWithHttpInfo

public ApiResponse<DownloadAttachmentDto> downloadAttachmentAsBase64EncodedWithHttpInfo(String attachmentId)
                                                                                 throws ApiException

Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents. Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.

Parameters:

attachmentId - ID of attachment (required)

Returns:

ApiResponse<DownloadAttachmentDto>

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
200	OK	-

downloadAttachmentAsBase64EncodedAsync

public okhttp3.Call downloadAttachmentAsBase64EncodedAsync(String attachmentId,
                                                           ApiCallback<DownloadAttachmentDto> _callback)
                                                    throws ApiException

Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents. (asynchronously) Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.

Parameters:

attachmentId - ID of attachment (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
200	OK	-

downloadAttachmentAsBytesCall

public okhttp3.Call downloadAttachmentAsBytesCall(String attachmentId,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for downloadAttachmentAsBytes

Parameters:

attachmentId - ID of attachment (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
0	default response	-

downloadAttachmentAsBytes

public byte[] downloadAttachmentAsBytes(String attachmentId)
                                 throws ApiException

Download attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints. Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.

Parameters:

attachmentId - ID of attachment (required)

Returns:

byte[]

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
0	default response	-

downloadAttachmentAsBytesWithHttpInfo

public ApiResponse<byte[]> downloadAttachmentAsBytesWithHttpInfo(String attachmentId)
                                                          throws ApiException

Download attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints. Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.

Parameters:

attachmentId - ID of attachment (required)

Returns:

ApiResponse<byte[]>

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
0	default response	-

downloadAttachmentAsBytesAsync

public okhttp3.Call downloadAttachmentAsBytesAsync(String attachmentId,
                                                   ApiCallback<byte[]> _callback)
                                            throws ApiException

Download attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints. (asynchronously) Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.

Parameters:

attachmentId - ID of attachment (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
0	default response	-

getAttachmentCall

public okhttp3.Call getAttachmentCall(String attachmentId,
                                      ApiCallback _callback)
                               throws ApiException

Build call for getAttachment

Parameters:

attachmentId - ID of attachment (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
200	OK	-

getAttachment

public AttachmentEntity getAttachment(String attachmentId)
                               throws ApiException

Get an attachment entity

Parameters:

attachmentId - ID of attachment (required)

Returns:

AttachmentEntity

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
200	OK	-

getAttachmentWithHttpInfo

public ApiResponse<AttachmentEntity> getAttachmentWithHttpInfo(String attachmentId)
                                                        throws ApiException

Get an attachment entity

Parameters:

attachmentId - ID of attachment (required)

Returns:

ApiResponse<AttachmentEntity>

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
200	OK	-

getAttachmentAsync

public okhttp3.Call getAttachmentAsync(String attachmentId,
                                       ApiCallback<AttachmentEntity> _callback)
                                throws ApiException

Get an attachment entity (asynchronously)

Parameters:

attachmentId - ID of attachment (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
200	OK	-

getAttachmentInfoCall

public okhttp3.Call getAttachmentInfoCall(String attachmentId,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for getAttachmentInfo

Parameters:

attachmentId - ID of attachment (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
200	OK	-

getAttachmentInfo

public AttachmentMetaData getAttachmentInfo(String attachmentId)
                                     throws ApiException

Get email attachment metadata information Returns the metadata for an attachment. It is saved separately to the content of the attachment. Contains properties `name` and `content-type` and `content-length` in bytes for a given attachment.

Parameters:

attachmentId - ID of attachment (required)

Returns:

AttachmentMetaData

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
200	OK	-

getAttachmentInfoWithHttpInfo

public ApiResponse<AttachmentMetaData> getAttachmentInfoWithHttpInfo(String attachmentId)
                                                              throws ApiException

Get email attachment metadata information Returns the metadata for an attachment. It is saved separately to the content of the attachment. Contains properties `name` and `content-type` and `content-length` in bytes for a given attachment.

Parameters:

attachmentId - ID of attachment (required)

Returns:

ApiResponse<AttachmentMetaData>

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
200	OK	-

getAttachmentInfoAsync

public okhttp3.Call getAttachmentInfoAsync(String attachmentId,
                                           ApiCallback<AttachmentMetaData> _callback)
                                    throws ApiException

Get email attachment metadata information (asynchronously) Returns the metadata for an attachment. It is saved separately to the content of the attachment. Contains properties `name` and `content-type` and `content-length` in bytes for a given attachment.

Parameters:

attachmentId - ID of attachment (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
200	OK	-

getAttachmentsCall

public okhttp3.Call getAttachmentsCall(Integer page,
                                       Integer size,
                                       String sort,
                                       String fileNameFilter,
                                       OffsetDateTime since,
                                       OffsetDateTime before,
                                       ApiCallback _callback)
                                throws ApiException

Build call for getAttachments

Parameters:

page - Optional page index for list pagination (optional, default to 0)

size - Optional page size for list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

fileNameFilter - Optional file name and content type search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (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
200	OK	-

getAttachments

public PageAttachmentEntity getAttachments(Integer page,
                                           Integer size,
                                           String sort,
                                           String fileNameFilter,
                                           OffsetDateTime since,
                                           OffsetDateTime before)
                                    throws ApiException

Get email attachments Get all attachments in paginated response. Each entity contains meta data for the attachment such as `name` and `content-type`. Use the `attachmentId` and the download endpoints to get the file contents.

Parameters:

page - Optional page index for list pagination (optional, default to 0)

size - Optional page size for list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

fileNameFilter - Optional file name and content type search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

PageAttachmentEntity

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
200	OK	-

getAttachmentsWithHttpInfo

public ApiResponse<PageAttachmentEntity> getAttachmentsWithHttpInfo(Integer page,
                                                                    Integer size,
                                                                    String sort,
                                                                    String fileNameFilter,
                                                                    OffsetDateTime since,
                                                                    OffsetDateTime before)
                                                             throws ApiException

Get email attachments Get all attachments in paginated response. Each entity contains meta data for the attachment such as `name` and `content-type`. Use the `attachmentId` and the download endpoints to get the file contents.

Parameters:

page - Optional page index for list pagination (optional, default to 0)

size - Optional page size for list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

fileNameFilter - Optional file name and content type search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

ApiResponse<PageAttachmentEntity>

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
200	OK	-

getAttachmentsAsync

public okhttp3.Call getAttachmentsAsync(Integer page,
                                        Integer size,
                                        String sort,
                                        String fileNameFilter,
                                        OffsetDateTime since,
                                        OffsetDateTime before,
                                        ApiCallback<PageAttachmentEntity> _callback)
                                 throws ApiException

Get email attachments (asynchronously) Get all attachments in paginated response. Each entity contains meta data for the attachment such as `name` and `content-type`. Use the `attachmentId` and the download endpoints to get the file contents.

Parameters:

page - Optional page index for list pagination (optional, default to 0)

size - Optional page size for list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

fileNameFilter - Optional file name and content type search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (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
200	OK	-

uploadAttachmentCall

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

Build call for uploadAttachment

Parameters:

uploadAttachmentOptions - (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	-

uploadAttachment

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

Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.

Parameters:

uploadAttachmentOptions - (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	-

uploadAttachmentWithHttpInfo

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

Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.

Parameters:

uploadAttachmentOptions - (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	-

uploadAttachmentAsync

public okhttp3.Call uploadAttachmentAsync(UploadAttachmentOptions uploadAttachmentOptions,
                                          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)

Parameters:

uploadAttachmentOptions - (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	-

uploadAttachmentBytesCall

public okhttp3.Call uploadAttachmentBytesCall(UploadAttachmentBytesRequest uploadAttachmentBytesRequest,
                                              String contentType,
                                              String filename,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for uploadAttachmentBytes

Parameters:

uploadAttachmentBytesRequest - (required)

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

filename - Optional filename to save upload with (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	-

uploadAttachmentBytes

public List<String> uploadAttachmentBytes(UploadAttachmentBytesRequest uploadAttachmentBytesRequest,
                                          String contentType,
                                          String filename)
                                   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.

Parameters:

uploadAttachmentBytesRequest - (required)

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

filename - Optional filename to save upload with (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	-

uploadAttachmentBytesWithHttpInfo

public ApiResponse<List<String>> uploadAttachmentBytesWithHttpInfo(UploadAttachmentBytesRequest uploadAttachmentBytesRequest,
                                                                   String contentType,
                                                                   String filename)
                                                            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.

Parameters:

uploadAttachmentBytesRequest - (required)

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

filename - Optional filename to save upload with (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	-

uploadAttachmentBytesAsync

public okhttp3.Call uploadAttachmentBytesAsync(UploadAttachmentBytesRequest uploadAttachmentBytesRequest,
                                               String contentType,
                                               String filename,
                                               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)

Parameters:

uploadAttachmentBytesRequest - (required)

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

filename - Optional filename to save upload with (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	-

uploadMultipartFormCall

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

Build call for uploadMultipartForm

Parameters:

contentType - Optional content type of attachment (optional)

filename - Optional name of file (optional)

xFilename - Optional content type header of attachment (optional)

uploadMultipartFormRequest - (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	-

uploadMultipartForm

public List<String> uploadMultipartForm(String contentType,
                                        String filename,
                                        String xFilename,
                                        UploadMultipartFormRequest uploadMultipartFormRequest)
                                 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.

Parameters:

contentType - Optional content type of attachment (optional)

filename - Optional name of file (optional)

xFilename - Optional content type header of attachment (optional)

uploadMultipartFormRequest - (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	-

uploadMultipartFormWithHttpInfo

public ApiResponse<List<String>> uploadMultipartFormWithHttpInfo(String contentType,
                                                                 String filename,
                                                                 String xFilename,
                                                                 UploadMultipartFormRequest uploadMultipartFormRequest)
                                                          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.

Parameters:

contentType - Optional content type of attachment (optional)

filename - Optional name of file (optional)

xFilename - Optional content type header of attachment (optional)

uploadMultipartFormRequest - (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	-

uploadMultipartFormAsync

public okhttp3.Call uploadMultipartFormAsync(String contentType,
                                             String filename,
                                             String xFilename,
                                             UploadMultipartFormRequest uploadMultipartFormRequest,
                                             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)

Parameters:

contentType - Optional content type of attachment (optional)

filename - Optional name of file (optional)

xFilename - Optional content type header of attachment (optional)

uploadMultipartFormRequest - (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	-