Skip to main content
PATCH
/
library
/
v1beta1
/
{libId}
/
inboundEmails
/
{inboundEmailId}
cURL
curl --request PATCH \
  --url https://aodocs.altirnao.com/api/library/v1beta1/{libId}/inboundEmails/{inboundEmailId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowUnknownSenders": true,
  "classId": "<string>",
  "conversionMode": "NONE",
  "createdTime": "2023-11-07T05:31:56Z",
  "destinationFolderId": "<string>",
  "emailPrefix": "<string>",
  "fullEmail": "<string>",
  "id": "<string>",
  "importedParts": [
    "BODY"
  ],
  "kind": "<string>",
  "lastModifiedTime": "2023-11-07T05:31:56Z",
  "libraryId": "<string>",
  "ocrLocale": "<string>",
  "preferPlainTextBody": true,
  "removeThreadHistory": true,
  "templateDocumentId": "<string>"
}
'
{
  "allowUnknownSenders": true,
  "classId": "<string>",
  "conversionMode": "NONE",
  "createdTime": "2023-11-07T05:31:56Z",
  "destinationFolderId": "<string>",
  "emailPrefix": "<string>",
  "fullEmail": "<string>",
  "id": "<string>",
  "importedParts": [
    "BODY"
  ],
  "kind": "<string>",
  "lastModifiedTime": "2023-11-07T05:31:56Z",
  "libraryId": "<string>",
  "ocrLocale": "<string>",
  "preferPlainTextBody": true,
  "removeThreadHistory": true,
  "templateDocumentId": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
libId
string
required

The ID of the library

​
inboundEmailId
string
required

The ID of the inbound email

Query Parameters

​
domain
string

The G Suite domain

​
securityCode
string

The security code

Body

application/json
​
allowUnknownSenders
boolean

Whether we allow unknown senders to create document via the inbound email

​
classId
string

The ID of the document class associated to the inbound email (read-only field after creation)

​
conversionMode
enum<string>

The conversion mode for files attached to the email: NONE (no conversion, default mode), GDOCS (to convert in Google documents format) or OCR (to convert using Optical Character Recognition)

Available options:
NONE,
GDOCS,
OCR
​
createdTime
string<date-time>

The time at which the inbound email was created (read-only field)

​
destinationFolderId
string

The ID of the folder in which the document should be created from the inbound email

​
emailPrefix
string

The prefix of the inbound email

​
fullEmail
string

The full email address of the inbound email (read-only field)

​
id
string

The ID of the inbound email (read-only field)

​
importedParts
enum<string>[]

The list of email parts to include in import. If empty, defaults to [BODY, ATTACHMENTS] only

Available options:
BODY,
ATTACHMENTS,
EML
​
kind
string
​
lastModifiedTime
string<date-time>

The time at which the inbound email was last modified (read-only field)

​
libraryId
string

The ID of the library (read-only field)

​
ocrLocale
string

The locale for OCR conversion

​
preferPlainTextBody
boolean

Whether the body of the email should be interpreted as plain text

​
removeThreadHistory
boolean

Whether the history of the thread should be removed before importing email's content in the document

​
templateDocumentId
string

The ID of the document template to use to create document from the inbound email

Response

200 - application/json

A ApiInboundEmail response

​
allowUnknownSenders
boolean

Whether we allow unknown senders to create document via the inbound email

​
classId
string

The ID of the document class associated to the inbound email (read-only field after creation)

​
conversionMode
enum<string>

The conversion mode for files attached to the email: NONE (no conversion, default mode), GDOCS (to convert in Google documents format) or OCR (to convert using Optical Character Recognition)

Available options:
NONE,
GDOCS,
OCR
​
createdTime
string<date-time>

The time at which the inbound email was created (read-only field)

​
destinationFolderId
string

The ID of the folder in which the document should be created from the inbound email

​
emailPrefix
string

The prefix of the inbound email

​
fullEmail
string

The full email address of the inbound email (read-only field)

​
id
string

The ID of the inbound email (read-only field)

​
importedParts
enum<string>[]

The list of email parts to include in import. If empty, defaults to [BODY, ATTACHMENTS] only

Available options:
BODY,
ATTACHMENTS,
EML
​
kind
string
​
lastModifiedTime
string<date-time>

The time at which the inbound email was last modified (read-only field)

​
libraryId
string

The ID of the library (read-only field)

​
ocrLocale
string

The locale for OCR conversion

​
preferPlainTextBody
boolean

Whether the body of the email should be interpreted as plain text

​
removeThreadHistory
boolean

Whether the history of the thread should be removed before importing email's content in the document

​
templateDocumentId
string

The ID of the document template to use to create document from the inbound email