Module mailslurp::apis::attachment_controller_api

Structs

DeleteAttachmentParams	struct for passing parameters to the method delete_attachment
DownloadAttachmentAsBase64EncodedParams	struct for passing parameters to the method download_attachment_as_base64_encoded
DownloadAttachmentAsBytesParams	struct for passing parameters to the method download_attachment_as_bytes
GetAttachmentInfoParams	struct for passing parameters to the method get_attachment_info
GetAttachmentsParams	struct for passing parameters to the method get_attachments
UploadAttachmentBytesParams	struct for passing parameters to the method upload_attachment_bytes
UploadAttachmentParams	struct for passing parameters to the method upload_attachment
UploadMultipartFormParams	struct for passing parameters to the method upload_multipart_form

Enums

DeleteAttachmentError	struct for typed errors of method delete_attachment
DownloadAttachmentAsBase64EncodedError	struct for typed errors of method download_attachment_as_base64_encoded
DownloadAttachmentAsBytesError	struct for typed errors of method download_attachment_as_bytes
GetAttachmentInfoError	struct for typed errors of method get_attachment_info
GetAttachmentsError	struct for typed errors of method get_attachments
UploadAttachmentBytesError	struct for typed errors of method upload_attachment_bytes
UploadAttachmentError	struct for typed errors of method upload_attachment
UploadMultipartFormError	struct for typed errors of method upload_multipart_form

Functions

delete_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.
download_attachment_as_base64_encoded	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.
download_attachment_as_bytes	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.
get_attachment_info	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.
get_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.
upload_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.
upload_attachment_bytes	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.
upload_multipart_form	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.