Class AttachmentControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

AttachmentControllerApi

Implements

IAttachmentControllerApi

IAttachmentControllerApiSync

IAttachmentControllerApiAsync

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public class AttachmentControllerApi : IAttachmentControllerApi, IAttachmentControllerApiSync, IAttachmentControllerApiAsync, IApiAccessor

Constructors

AttachmentControllerApi()

Initializes a new instance of the AttachmentControllerApi class.

Declaration

public AttachmentControllerApi()

AttachmentControllerApi(string)

Initializes a new instance of the AttachmentControllerApi class.

Declaration

public AttachmentControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

AttachmentControllerApi(Configuration)

Initializes a new instance of the AttachmentControllerApi class using Configuration object

Declaration

public AttachmentControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

AttachmentControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

Initializes a new instance of the AttachmentControllerApi class using a Configuration object and client instance.

Declaration

public AttachmentControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)

Parameters

Type	Name	Description
ISynchronousClient	client	The client interface for synchronous API access.
IAsynchronousClient	asyncClient	The client interface for asynchronous API access.
IReadableConfiguration	configuration	The configuration object.

Properties

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

DeleteAllAttachments(int)

Delete all attachments Delete all attachments

Declaration

public void DeleteAllAttachments(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteAllAttachmentsAsync(int, CancellationToken)

Delete all attachments Delete all attachments

Declaration

public Task DeleteAllAttachmentsAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteAllAttachmentsWithHttpInfo(int)

Delete all attachments Delete all attachments

Declaration

public ApiResponse<object> DeleteAllAttachmentsWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteAllAttachmentsWithHttpInfoAsync(int, CancellationToken)

Delete all attachments Delete all attachments

Declaration

public Task<ApiResponse<object>> DeleteAllAttachmentsWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteAttachment(string, int)

Delete an attachment Delete an attachment

Declaration

public void DeleteAttachment(string attachmentId, int operationIndex = 0)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteAttachmentAsync(string, int, CancellationToken)

Delete an attachment Delete an attachment

Declaration

public Task DeleteAttachmentAsync(string attachmentId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteAttachmentWithHttpInfo(string, int)

Delete an attachment Delete an attachment

Declaration

public ApiResponse<object> DeleteAttachmentWithHttpInfo(string attachmentId, int operationIndex = 0)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteAttachmentWithHttpInfoAsync(string, int, CancellationToken)

Delete an attachment Delete an attachment

Declaration

public Task<ApiResponse<object>> DeleteAttachmentWithHttpInfoAsync(string attachmentId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadAttachmentAsBase64Encoded(string, int)

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.

Declaration

public DownloadAttachmentDto DownloadAttachmentAsBase64Encoded(string attachmentId, int operationIndex = 0)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DownloadAttachmentDto	DownloadAttachmentDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadAttachmentAsBase64EncodedAsync(string, int, CancellationToken)

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.

Declaration

public Task<DownloadAttachmentDto> DownloadAttachmentAsBase64EncodedAsync(string attachmentId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<DownloadAttachmentDto>	Task of DownloadAttachmentDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadAttachmentAsBase64EncodedWithHttpInfo(string, int)

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.

Declaration

public ApiResponse<DownloadAttachmentDto> DownloadAttachmentAsBase64EncodedWithHttpInfo(string attachmentId, int operationIndex = 0)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DownloadAttachmentDto>	ApiResponse of DownloadAttachmentDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadAttachmentAsBase64EncodedWithHttpInfoAsync(string, int, CancellationToken)

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.

Declaration

public Task<ApiResponse<DownloadAttachmentDto>> DownloadAttachmentAsBase64EncodedWithHttpInfoAsync(string attachmentId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<DownloadAttachmentDto>>	Task of ApiResponse (DownloadAttachmentDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadAttachmentAsBytes(string, int)

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.

Declaration

public byte[] DownloadAttachmentAsBytes(string attachmentId, int operationIndex = 0)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.

Returns

Type	Description
byte[]	byte[]

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadAttachmentAsBytesAsync(string, int, CancellationToken)

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.

Declaration

public Task<byte[]> DownloadAttachmentAsBytesAsync(string attachmentId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<byte[]>	Task of byte[]

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadAttachmentAsBytesWithHttpInfo(string, int)

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.

Declaration

public ApiResponse<byte[]> DownloadAttachmentAsBytesWithHttpInfo(string attachmentId, int operationIndex = 0)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<byte[]>	ApiResponse of byte[]

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DownloadAttachmentAsBytesWithHttpInfoAsync(string, int, CancellationToken)

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.

Declaration

public Task<ApiResponse<byte[]>> DownloadAttachmentAsBytesWithHttpInfoAsync(string attachmentId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<byte[]>>	Task of ApiResponse (byte[])

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAttachment(string, int)

Get an attachment entity

Declaration

public AttachmentEntityDto GetAttachment(string attachmentId, int operationIndex = 0)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.

Returns

Type	Description
AttachmentEntityDto	AttachmentEntityDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAttachmentAsync(string, int, CancellationToken)

Get an attachment entity

Declaration

public Task<AttachmentEntityDto> GetAttachmentAsync(string attachmentId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<AttachmentEntityDto>	Task of AttachmentEntityDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAttachmentInfo(string, int)

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.

Declaration

public AttachmentMetaData GetAttachmentInfo(string attachmentId, int operationIndex = 0)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.

Returns

Type	Description
AttachmentMetaData	AttachmentMetaData

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAttachmentInfoAsync(string, int, CancellationToken)

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.

Declaration

public Task<AttachmentMetaData> GetAttachmentInfoAsync(string attachmentId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<AttachmentMetaData>	Task of AttachmentMetaData

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAttachmentInfoWithHttpInfo(string, int)

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.

Declaration

public ApiResponse<AttachmentMetaData> GetAttachmentInfoWithHttpInfo(string attachmentId, int operationIndex = 0)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<AttachmentMetaData>	ApiResponse of AttachmentMetaData

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAttachmentInfoWithHttpInfoAsync(string, int, CancellationToken)

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.

Declaration

public Task<ApiResponse<AttachmentMetaData>> GetAttachmentInfoWithHttpInfoAsync(string attachmentId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<AttachmentMetaData>>	Task of ApiResponse (AttachmentMetaData)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAttachmentWithHttpInfo(string, int)

Get an attachment entity

Declaration

public ApiResponse<AttachmentEntityDto> GetAttachmentWithHttpInfo(string attachmentId, int operationIndex = 0)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<AttachmentEntityDto>	ApiResponse of AttachmentEntityDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAttachmentWithHttpInfoAsync(string, int, CancellationToken)

Get an attachment entity

Declaration

public Task<ApiResponse<AttachmentEntityDto>> GetAttachmentWithHttpInfoAsync(string attachmentId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	attachmentId	ID of attachment
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<AttachmentEntityDto>>	Task of ApiResponse (AttachmentEntityDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAttachments(int?, int?, string, string, DateTime?, DateTime?, Guid?, Guid?, Guid?, int)

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.

Declaration

public PageAttachmentEntity GetAttachments(int? page = null, int? size = null, string sort = null, string fileNameFilter = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, Guid? emailId = null, Guid? sentEmailId = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index for list pagination (optional, default to 0)
int?	size	Optional page size for list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	fileNameFilter	Optional file name and content type search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
Guid?	inboxId	Optional inboxId to filter attachments by (optional)
Guid?	emailId	Optional emailId to filter attachments by (optional)
Guid?	sentEmailId	Optional sentEmailId to filter attachments by (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageAttachmentEntity	PageAttachmentEntity

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAttachmentsAsync(int?, int?, string, string, DateTime?, DateTime?, Guid?, Guid?, Guid?, int, CancellationToken)

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.

Declaration

public Task<PageAttachmentEntity> GetAttachmentsAsync(int? page = null, int? size = null, string sort = null, string fileNameFilter = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, Guid? emailId = null, Guid? sentEmailId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index for list pagination (optional, default to 0)
int?	size	Optional page size for list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	fileNameFilter	Optional file name and content type search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
Guid?	inboxId	Optional inboxId to filter attachments by (optional)
Guid?	emailId	Optional emailId to filter attachments by (optional)
Guid?	sentEmailId	Optional sentEmailId to filter attachments by (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageAttachmentEntity>	Task of PageAttachmentEntity

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAttachmentsWithHttpInfo(int?, int?, string, string, DateTime?, DateTime?, Guid?, Guid?, Guid?, int)

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.

Declaration

public ApiResponse<PageAttachmentEntity> GetAttachmentsWithHttpInfo(int? page = null, int? size = null, string sort = null, string fileNameFilter = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, Guid? emailId = null, Guid? sentEmailId = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index for list pagination (optional, default to 0)
int?	size	Optional page size for list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	fileNameFilter	Optional file name and content type search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
Guid?	inboxId	Optional inboxId to filter attachments by (optional)
Guid?	emailId	Optional emailId to filter attachments by (optional)
Guid?	sentEmailId	Optional sentEmailId to filter attachments by (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageAttachmentEntity>	ApiResponse of PageAttachmentEntity

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAttachmentsWithHttpInfoAsync(int?, int?, string, string, DateTime?, DateTime?, Guid?, Guid?, Guid?, int, CancellationToken)

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.

Declaration

public Task<ApiResponse<PageAttachmentEntity>> GetAttachmentsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, string fileNameFilter = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, Guid? emailId = null, Guid? sentEmailId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index for list pagination (optional, default to 0)
int?	size	Optional page size for list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string	fileNameFilter	Optional file name and content type search filter (optional)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
Guid?	inboxId	Optional inboxId to filter attachments by (optional)
Guid?	emailId	Optional emailId to filter attachments by (optional)
Guid?	sentEmailId	Optional sentEmailId to filter attachments by (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageAttachmentEntity>>	Task of ApiResponse (PageAttachmentEntity)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

UploadAttachment(UploadAttachmentOptions, int)

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

Declaration

public List<string> UploadAttachment(UploadAttachmentOptions uploadAttachmentOptions, int operationIndex = 0)

Parameters

Type	Name	Description
UploadAttachmentOptions	uploadAttachmentOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
List<string>	List<string>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UploadAttachmentAsync(UploadAttachmentOptions, int, CancellationToken)

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

Declaration

public Task<List<string>> UploadAttachmentAsync(UploadAttachmentOptions uploadAttachmentOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UploadAttachmentOptions	uploadAttachmentOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<List<string>>	Task of List<string>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UploadAttachmentBytes(string, string, string, string, long?, string, int)

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.

Declaration

public List<string> UploadAttachmentBytes(string contentType = null, string contentType2 = null, string contentId = null, string filename = null, long? fileSize = null, string filename2 = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	contentType	(optional)
string	contentType2	Optional contentType for file. For instance application/pdf (optional)
string	contentId	Optional content ID (CID) to save upload with (optional)
string	filename	Optional filename to save upload with (optional)
long?	fileSize	Optional byte length to save upload with (optional)
string	filename2	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
List<string>	List<string>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UploadAttachmentBytesAsync(string, string, string, string, long?, string, int, CancellationToken)

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.

Declaration

public Task<List<string>> UploadAttachmentBytesAsync(string contentType = null, string contentType2 = null, string contentId = null, string filename = null, long? fileSize = null, string filename2 = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	contentType	(optional)
string	contentType2	Optional contentType for file. For instance application/pdf (optional)
string	contentId	Optional content ID (CID) to save upload with (optional)
string	filename	Optional filename to save upload with (optional)
long?	fileSize	Optional byte length to save upload with (optional)
string	filename2	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<List<string>>	Task of List<string>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UploadAttachmentBytesWithHttpInfo(string, string, string, string, long?, string, int)

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.

Declaration

public ApiResponse<List<string>> UploadAttachmentBytesWithHttpInfo(string contentType = null, string contentType2 = null, string contentId = null, string filename = null, long? fileSize = null, string filename2 = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	contentType	(optional)
string	contentType2	Optional contentType for file. For instance application/pdf (optional)
string	contentId	Optional content ID (CID) to save upload with (optional)
string	filename	Optional filename to save upload with (optional)
long?	fileSize	Optional byte length to save upload with (optional)
string	filename2	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<List<string>>	ApiResponse of List<string>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UploadAttachmentBytesWithHttpInfoAsync(string, string, string, string, long?, string, int, CancellationToken)

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.

Declaration

public Task<ApiResponse<List<string>>> UploadAttachmentBytesWithHttpInfoAsync(string contentType = null, string contentType2 = null, string contentId = null, string filename = null, long? fileSize = null, string filename2 = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	contentType	(optional)
string	contentType2	Optional contentType for file. For instance application/pdf (optional)
string	contentId	Optional content ID (CID) to save upload with (optional)
string	filename	Optional filename to save upload with (optional)
long?	fileSize	Optional byte length to save upload with (optional)
string	filename2	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<List<string>>>	Task of ApiResponse (List<string>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UploadAttachmentWithHttpInfo(UploadAttachmentOptions, int)

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

Declaration

public ApiResponse<List<string>> UploadAttachmentWithHttpInfo(UploadAttachmentOptions uploadAttachmentOptions, int operationIndex = 0)

Parameters

Type	Name	Description
UploadAttachmentOptions	uploadAttachmentOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<List<string>>	ApiResponse of List<string>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UploadAttachmentWithHttpInfoAsync(UploadAttachmentOptions, int, CancellationToken)

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

Declaration

public Task<ApiResponse<List<string>>> UploadAttachmentWithHttpInfoAsync(UploadAttachmentOptions uploadAttachmentOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UploadAttachmentOptions	uploadAttachmentOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<List<string>>>	Task of ApiResponse (List<string>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UploadMultipartForm(string, string, string, string, string, string, long?, UploadMultipartFormRequest, int)

Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.

Declaration

public List<string> UploadMultipartForm(string contentId = null, string contentType = null, string filename = null, string contentTypeHeader = null, string xFilename = null, string xFilenameRaw = null, long? xFilesize = null, UploadMultipartFormRequest uploadMultipartFormRequest = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	contentId	Optional content ID of attachment (optional)
string	contentType	Optional content type of attachment (optional)
string	filename	Optional name of file (optional)
string	contentTypeHeader	Optional content type header of attachment (optional)
string	xFilename	Optional filename header of attachment (optional)
string	xFilenameRaw	Optional raw filename header of attachment that will be converted to punycode (optional)
long?	xFilesize	Optional content size of attachment (optional)
UploadMultipartFormRequest	uploadMultipartFormRequest	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
List<string>	List<string>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UploadMultipartFormAsync(string, string, string, string, string, string, long?, UploadMultipartFormRequest, int, CancellationToken)

Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.

Declaration

public Task<List<string>> UploadMultipartFormAsync(string contentId = null, string contentType = null, string filename = null, string contentTypeHeader = null, string xFilename = null, string xFilenameRaw = null, long? xFilesize = null, UploadMultipartFormRequest uploadMultipartFormRequest = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	contentId	Optional content ID of attachment (optional)
string	contentType	Optional content type of attachment (optional)
string	filename	Optional name of file (optional)
string	contentTypeHeader	Optional content type header of attachment (optional)
string	xFilename	Optional filename header of attachment (optional)
string	xFilenameRaw	Optional raw filename header of attachment that will be converted to punycode (optional)
long?	xFilesize	Optional content size of attachment (optional)
UploadMultipartFormRequest	uploadMultipartFormRequest	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<List<string>>	Task of List<string>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UploadMultipartFormWithHttpInfo(string, string, string, string, string, string, long?, UploadMultipartFormRequest, int)

Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.

Declaration

public ApiResponse<List<string>> UploadMultipartFormWithHttpInfo(string contentId = null, string contentType = null, string filename = null, string contentTypeHeader = null, string xFilename = null, string xFilenameRaw = null, long? xFilesize = null, UploadMultipartFormRequest uploadMultipartFormRequest = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	contentId	Optional content ID of attachment (optional)
string	contentType	Optional content type of attachment (optional)
string	filename	Optional name of file (optional)
string	contentTypeHeader	Optional content type header of attachment (optional)
string	xFilename	Optional filename header of attachment (optional)
string	xFilenameRaw	Optional raw filename header of attachment that will be converted to punycode (optional)
long?	xFilesize	Optional content size of attachment (optional)
UploadMultipartFormRequest	uploadMultipartFormRequest	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<List<string>>	ApiResponse of List<string>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UploadMultipartFormWithHttpInfoAsync(string, string, string, string, string, string, long?, UploadMultipartFormRequest, int, CancellationToken)

Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.

Declaration

public Task<ApiResponse<List<string>>> UploadMultipartFormWithHttpInfoAsync(string contentId = null, string contentType = null, string filename = null, string contentTypeHeader = null, string xFilename = null, string xFilenameRaw = null, long? xFilesize = null, UploadMultipartFormRequest uploadMultipartFormRequest = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	contentId	Optional content ID of attachment (optional)
string	contentType	Optional content type of attachment (optional)
string	filename	Optional name of file (optional)
string	contentTypeHeader	Optional content type header of attachment (optional)
string	xFilename	Optional filename header of attachment (optional)
string	xFilenameRaw	Optional raw filename header of attachment that will be converted to punycode (optional)
long?	xFilesize	Optional content size of attachment (optional)
UploadMultipartFormRequest	uploadMultipartFormRequest	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<List<string>>>	Task of ApiResponse (List<string>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

IAttachmentControllerApi

IAttachmentControllerApiSync

IAttachmentControllerApiAsync

IApiAccessor