पत्रों के साथ क्रियाएँ

API 0.16.0OpenAPIllms-full.txt

POST/v1/mailboxes/{mailbox_id}/messages/actions

एक फ़ोल्डर में चयनित संदेशों पर एक क्रिया लागू करता है। उनकी आईडी को uids पर, फ़ोल्डर का नाम folder पर और उसके uidvalidity. पर action=move पर, लक्ष्य फ़ोल्डर को destination. पर भी निर्दिष्ट करें।

प्राधिकरण और पहुंच क्षेत्र · त्रुटियाँ और दोहराव

अनुरोध

curl -X POST 'https://adapt-mail.com/v1/mailboxes/<mailbox_id>/messages/actions' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json' \
  --data '{"folder":"INBOX","uidvalidity":1,"uids":[1],"action":"read"}'

विकल्प

mailbox_idpathअनिवार्य रूप से

integer

X-Customer-IDheader

विकल्प 1

string

विकल्प 2

null

निकाय से अनुरोध करें · application/json

object

folderअनिवार्य रूप से

string

फ़ोल्डर सूची से फ़ोल्डर का नाम, उदाहरण के लिए INBOX.

minLength: 1

maxLength: 255

uidvalidityअनिवार्य रूप से

integer

इस फ़ोल्डर के लिए प्रतिक्रिया API से मान uidvalidity है।

exclusiveMinimum: 0

uidsअनिवार्य रूप से

array

एक फ़ोल्डर से चयनित अक्षरों के पहचानकर्ता.

minItems: 1

maxItems: 100

सरणी तत्व

integer

actionअनिवार्य रूप से

string

मान्य मान: "read" "unread" "star" "unstar" "move" "delete"

destination

लक्ष्य फ़ोल्डर का नाम. action=move. के लिए आवश्यक

विकल्प 1

string

maxLength: 255

विकल्प 2

null

अज्ञात फ़ील्ड स्वीकार नहीं किए जाते.

प्रतिक्रियाएँ

200 सफल प्रतिक्रिया

application/json

object

updated

boolean

401 लॉगिन आवश्यक है

application/json

object

detail

विकल्प 1

string

विकल्प 2

object

code

string

message

string

विकल्प 3

array

सरणी तत्व

object

403 तक पहुँच नहीं

application/json

object

detail

विकल्प 1

string

विकल्प 2

object

code

string

message

string

विकल्प 3

array

सरणी तत्व

object

404 संसाधन नहीं मिला

application/json

object

detail

विकल्प 1

string

विकल्प 2

object

code

string

message

string

विकल्प 3

array

सरणी तत्व

object

409 राज्य संघर्ष

application/json

object

detail

विकल्प 1

string

विकल्प 2

object

code

string

message

string

विकल्प 3

array

सरणी तत्व

object

422 सत्यापन त्रुटि

application/json

object

detail

array

सरणी तत्व

object

locअनिवार्य रूप से

array

सरणी तत्व

विकल्प 1

string

विकल्प 2

integer

msgअनिवार्य रूप से

string

typeअनिवार्य रूप से

string

503 अस्थायी अनुपलब्धता

application/json

object

detail

विकल्प 1

string

विकल्प 2

object

code

string

message

string

विकल्प 3

array

सरणी तत्व

object