Skip to content

MailSlurp\AttachmentControllerApi

All URIs are relative to https://golang.api.mailslurp.com

Method HTTP request Description
DeleteAllAttachments Delete /attachments Delete all attachments
DeleteAttachment Delete /attachments/{attachmentId} Delete an attachment
DownloadAttachmentAsBase64Encoded Get /attachments/{attachmentId}/base64 Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents.
DownloadAttachmentAsBytes Get /attachments/{attachmentId}/bytes Download attachments. Get email attachment bytes. If you have trouble with byte responses try the downloadAttachmentBase64 response endpoints.
GetAttachment Get /attachments/{attachmentId} Get an attachment entity
GetAttachmentInfo Get /attachments/{attachmentId}/metadata Get email attachment metadata information
GetAttachments Get /attachments Get email attachments
UploadAttachment Post /attachments Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.
UploadAttachmentBytes Post /attachments/bytes 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.
UploadMultipartForm Post /attachments/multipart Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.

DeleteAllAttachments

DeleteAllAttachments(ctx, )

Delete all attachments

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

DeleteAttachment

DeleteAttachment(ctx, attachmentId)

Delete an attachment

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
attachmentId string ID of attachment

Return type

(empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

DownloadAttachmentAsBase64Encoded

DownloadAttachmentDto DownloadAttachmentAsBase64Encoded(ctx, attachmentId)

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.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
attachmentId string ID of attachment

Return type

DownloadAttachmentDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

DownloadAttachmentAsBytes

string DownloadAttachmentAsBytes(ctx, attachmentId)

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.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
attachmentId string ID of attachment

Return type

string

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to ]

GetAttachment

AttachmentEntity GetAttachment(ctx, attachmentId)

Get an attachment entity

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
attachmentId string ID of attachment

Return type

AttachmentEntity

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

GetAttachmentInfo

AttachmentMetaData GetAttachmentInfo(ctx, attachmentId)

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.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
attachmentId string ID of attachment

Return type

AttachmentMetaData

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

GetAttachments

PageAttachmentEntity GetAttachments(ctx, optional)

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.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetAttachmentsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAttachmentsOpts struct

Name Type Description Notes
page optional.Int32 Optional page for list pagination [default to 0]
size optional.Int32 Optional page size for list pagination [default to 20]
sort optional.String Optional createdAt sort direction ASC or DESC [default to ASC]
fileNameFilter optional.String Optional file name and content type search filter
since optional.Time Filter by created at after the given timestamp
before optional.Time Filter by created at before the given timestamp

Return type

PageAttachmentEntity

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

UploadAttachment

[]string UploadAttachment(ctx, uploadAttachmentOptions)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
uploadAttachmentOptions UploadAttachmentOptions

Return type

[]string

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

UploadAttachmentBytes

[]string UploadAttachmentBytes(ctx, inlineObject1, optional)

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.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
inlineObject1 InlineObject1
optional *UploadAttachmentBytesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UploadAttachmentBytesOpts struct

Name Type Description Notes

contentType | optional.String| Optional contentType for file. For instance application/pdf | filename | optional.String| Optional filename to save upload with |

Return type

[]string

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/octet-stream
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

UploadMultipartForm

[]string UploadMultipartForm(ctx, optional)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *UploadMultipartFormOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UploadMultipartFormOpts struct

Name Type Description Notes
contentType optional.String Optional content type of attachment
filename optional.String Optional name of file
xFilename optional.String Optional content type header of attachment
inlineObject optional.Interface of InlineObject

Return type

[]string

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]