Email
Extract Email Attachment
Extract attachments from an email
POST /v1/email/extract-attachments
For converting email to PDF please see PDF from Email.
Attributes
Attributes are case-sensitive and should be inside JSON for POST request. for example:
{ "url": "https://example.com/file1.pdf" }
Attribute | Type | Required | Default | Description |
---|---|---|---|---|
url | string | Yes | - | URL to the source file url attribute |
callback | string | No | - | The callback URL (or Webhook) used to receive the POST data. see Webhooks & Callbacks. This is only applicable when async is set to true . |
inline | boolean | No | false | Set to true to return results inside the response. Otherwise, the endpoint will return a URL to the output file generated. |
async | boolean | No | false | Set async to true for long processes to run in the background, API will then return a jobId which you can use with the Background Job Check endpoint. Also see Webhooks & Callbacks |
profiles | object | No | - | See Profiles for more information. |
outputDataFormat | string | No | - | If you require your output as base64 format, set this to base64 |
DataEncryptionAlgorithm | string | No | - | Controls the encryption algorithm used for data encryption. See User-Controlled Encryption for more information. The available algorithms are: AES128 , AES192 , AES256 . |
DataEncryptionKey | string | No | - | Controls the encryption key used for data encryption. See User-Controlled Encryption for more information. |
DataEncryptionIV | string | No | - | Controls the encryption IV used for data encryption. See User-Controlled Encryption for more information. |
DataDecryptionAlgorithm | string | No | - | Controls the decryption algorithm used for data decryption. See User-Controlled Encryption for more information. The available algorithms are: AES128 , AES192 , AES256 . |
DataDecryptionKey | string | No | - | Controls the decryption key used for data decryption. See User-Controlled Encryption for more information. |
DataDecryptionIV | string | No | - | Controls the decryption IV used for data decryption. See User-Controlled Encryption for more information. |
responseParameters | object | No | - | - |
body | object | No | - | Response body. |
pageCount | integer | No | - | Number of pages in the PDF document. |
error | boolean | No | - | Indicates whether an error occurred (false means success) |
status | string | No | - | Status code of the request (200, 404, 500, etc.). For more information, see Response Codes. |
name | string | No | - | Name of the output file |
credits | integer | No | - | Number of credits consumed by the request |
remainingCredits | integer | No | - | Number of credits remaining in the account |
duration | integer | No | - | Time taken for the operation in milliseconds |
Example
Payload
To see the request size limits, please refer to the Request Size Limits.
Example
Response
To see the main response codes, please refer to the Response Codes page.