OAIAttachmentControllerApi
All URIs are relative to https://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. |
Delete all attachments
Example
OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
OAIAttachmentControllerApi*apiInstance = [[OAIAttachmentControllerApi alloc] init];
// Delete all attachments
[apiInstance deleteAllAttachmentsWithCompletionHandler:
^(NSError* error) {
if (error) {
NSLog(@"Error calling OAIAttachmentControllerApi->deleteAllAttachments: %@", error);
}
}];
Parameters
This endpoint does not need any parameter.
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to ]
-(NSURLSessionTask*) deleteAttachmentWithAttachmentId: (NSString*) attachmentId
completionHandler: (void (^)(NSError* error)) handler;
Delete an attachment
Example
OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
NSString* attachmentId = @"attachmentId_example"; // ID of attachment
OAIAttachmentControllerApi*apiInstance = [[OAIAttachmentControllerApi alloc] init];
// Delete an attachment
[apiInstance deleteAttachmentWithAttachmentId:attachmentId
completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error calling OAIAttachmentControllerApi->deleteAttachment: %@", error);
}
}];
Parameters
Name | Type | Description | Notes |
---|---|---|---|
attachmentId | NSString* | ID of attachment |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to ]
-(NSURLSessionTask*) downloadAttachmentAsBase64EncodedWithAttachmentId: (NSString*) attachmentId
completionHandler: (void (^)(OAIDownloadAttachmentDto* output, NSError* error)) handler;
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.
Example
OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
NSString* attachmentId = @"attachmentId_example"; // ID of attachment
OAIAttachmentControllerApi*apiInstance = [[OAIAttachmentControllerApi alloc] init];
// Get email attachment as base64 encoded string as alternative to binary responses. To read the content decode the Base64 encoded contents.
[apiInstance downloadAttachmentAsBase64EncodedWithAttachmentId:attachmentId
completionHandler: ^(OAIDownloadAttachmentDto* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAIAttachmentControllerApi->downloadAttachmentAsBase64Encoded: %@", error);
}
}];
Parameters
Name | Type | Description | Notes |
---|---|---|---|
attachmentId | NSString* | ID of attachment |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
-(NSURLSessionTask*) downloadAttachmentAsBytesWithAttachmentId: (NSString*) attachmentId
completionHandler: (void (^)(NSData* output, NSError* error)) handler;
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.
Example
OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
NSString* attachmentId = @"attachmentId_example"; // ID of attachment
OAIAttachmentControllerApi*apiInstance = [[OAIAttachmentControllerApi alloc] init];
// Download attachments. Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints.
[apiInstance downloadAttachmentAsBytesWithAttachmentId:attachmentId
completionHandler: ^(NSData* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAIAttachmentControllerApi->downloadAttachmentAsBytes: %@", error);
}
}];
Parameters
Name | Type | Description | Notes |
---|---|---|---|
attachmentId | NSString* | ID of attachment |
Return type
NSData*
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/octet-stream
[Back to top] [Back to API list] [Back to Model list] [Back to ]
-(NSURLSessionTask*) getAttachmentWithAttachmentId: (NSString*) attachmentId
completionHandler: (void (^)(OAIAttachmentEntity* output, NSError* error)) handler;
Get an attachment entity
Example
OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
NSString* attachmentId = @"attachmentId_example"; // ID of attachment
OAIAttachmentControllerApi*apiInstance = [[OAIAttachmentControllerApi alloc] init];
// Get an attachment entity
[apiInstance getAttachmentWithAttachmentId:attachmentId
completionHandler: ^(OAIAttachmentEntity* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAIAttachmentControllerApi->getAttachment: %@", error);
}
}];
Parameters
Name | Type | Description | Notes |
---|---|---|---|
attachmentId | NSString* | ID of attachment |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
-(NSURLSessionTask*) getAttachmentInfoWithAttachmentId: (NSString*) attachmentId
completionHandler: (void (^)(OAIAttachmentMetaData* output, NSError* error)) handler;
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.
Example
OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
NSString* attachmentId = @"attachmentId_example"; // ID of attachment
OAIAttachmentControllerApi*apiInstance = [[OAIAttachmentControllerApi alloc] init];
// Get email attachment metadata information
[apiInstance getAttachmentInfoWithAttachmentId:attachmentId
completionHandler: ^(OAIAttachmentMetaData* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAIAttachmentControllerApi->getAttachmentInfo: %@", error);
}
}];
Parameters
Name | Type | Description | Notes |
---|---|---|---|
attachmentId | NSString* | ID of attachment |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
-(NSURLSessionTask*) getAttachmentsWithPage: (NSNumber*) page
size: (NSNumber*) size
sort: (NSString*) sort
fileNameFilter: (NSString*) fileNameFilter
since: (NSDate*) since
before: (NSDate*) before
completionHandler: (void (^)(OAIPageAttachmentEntity* output, NSError* error)) handler;
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.
Example
OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
NSNumber* page = @0; // Optional page event list pagination (optional) (default to @0)
NSNumber* size = @20; // Optional page size event list pagination (optional) (default to @20)
NSString* sort = @"ASC"; // Optional createdAt sort direction ASC or DESC (optional) (default to @"ASC")
NSString* fileNameFilter = @"fileNameFilter_example"; // Optional file name and content type search filter (optional)
NSDate* since = @"2013-10-20T19:20:30+01:00"; // Filter by created at after the given timestamp (optional)
NSDate* before = @"2013-10-20T19:20:30+01:00"; // Filter by created at before the given timestamp (optional)
OAIAttachmentControllerApi*apiInstance = [[OAIAttachmentControllerApi alloc] init];
// Get email attachments
[apiInstance getAttachmentsWithPage:page
size:size
sort:sort
fileNameFilter:fileNameFilter
since:since
before:before
completionHandler: ^(OAIPageAttachmentEntity* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAIAttachmentControllerApi->getAttachments: %@", error);
}
}];
Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | NSNumber* | Optional page event list pagination | [optional] [default to @0] |
size | NSNumber* | Optional page size event list pagination | [optional] [default to @20] |
sort | NSString* | Optional createdAt sort direction ASC or DESC | [optional] [default to @"ASC"] |
fileNameFilter | NSString* | Optional file name and content type search filter | [optional] |
since | NSDate* | Filter by created at after the given timestamp | [optional] |
before | NSDate* | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
-(NSURLSessionTask*) uploadAttachmentWithUploadAttachmentOptions: (OAIUploadAttachmentOptions*) uploadAttachmentOptions
completionHandler: (void (^)(NSArray<NSString*>* output, NSError* error)) handler;
Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.
Example
OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
OAIUploadAttachmentOptions* uploadAttachmentOptions = [[OAIUploadAttachmentOptions alloc] init]; //
OAIAttachmentControllerApi*apiInstance = [[OAIAttachmentControllerApi alloc] init];
// Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.
[apiInstance uploadAttachmentWithUploadAttachmentOptions:uploadAttachmentOptions
completionHandler: ^(NSArray<NSString*>* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAIAttachmentControllerApi->uploadAttachment: %@", error);
}
}];
Parameters
Name | Type | Description | Notes |
---|---|---|---|
uploadAttachmentOptions | OAIUploadAttachmentOptions* |
Return type
NSArray
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
-(NSURLSessionTask*) uploadAttachmentBytesWithInlineObject1: (OAIInlineObject1*) inlineObject1
contentType: (NSString*) contentType
filename: (NSString*) filename
completionHandler: (void (^)(NSArray<NSString*>* output, NSError* error)) handler;
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.
Example
OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
OAIInlineObject1* inlineObject1 = [[OAIInlineObject1 alloc] init]; //
NSString* contentType = @"contentType_example"; // Optional contentType for file. For instance `application/pdf` (optional)
NSString* filename = @"filename_example"; // Optional filename to save upload with (optional)
OAIAttachmentControllerApi*apiInstance = [[OAIAttachmentControllerApi alloc] init];
// 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.
[apiInstance uploadAttachmentBytesWithInlineObject1:inlineObject1
contentType:contentType
filename:filename
completionHandler: ^(NSArray<NSString*>* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAIAttachmentControllerApi->uploadAttachmentBytes: %@", error);
}
}];
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inlineObject1 | OAIInlineObject1* | ||
contentType | NSString* | Optional contentType for file. For instance application/pdf | [optional] |
filename | NSString* | Optional filename to save upload with | [optional] |
Return type
NSArray
Authorization
HTTP request headers
- Content-Type: application/octet-stream
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to ]
-(NSURLSessionTask*) uploadMultipartFormWithContentType: (NSString*) contentType
filename: (NSString*) filename
xFilename: (NSString*) xFilename
inlineObject: (OAIInlineObject*) inlineObject
completionHandler: (void (^)(NSArray<NSString*>* output, NSError* error)) handler;
Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.
Example
OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
NSString* contentType = @"contentType_example"; // Optional content type of attachment (optional)
NSString* filename = @"filename_example"; // Optional name of file (optional)
NSString* xFilename = @"xFilename_example"; // Optional content type header of attachment (optional)
OAIInlineObject* inlineObject = [[OAIInlineObject alloc] init]; // (optional)
OAIAttachmentControllerApi*apiInstance = [[OAIAttachmentControllerApi alloc] init];
// Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.
[apiInstance uploadMultipartFormWithContentType:contentType
filename:filename
xFilename:xFilename
inlineObject:inlineObject
completionHandler: ^(NSArray<NSString*>* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAIAttachmentControllerApi->uploadMultipartForm: %@", error);
}
}];
Parameters
Name | Type | Description | Notes |
---|---|---|---|
contentType | NSString* | Optional content type of attachment | [optional] |
filename | NSString* | Optional name of file | [optional] |
xFilename | NSString* | Optional content type header of attachment | [optional] |
inlineObject | OAIInlineObject* | [optional] |
Return type
NSArray
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]