सप्रेशन
इस समूह का हर ऑपरेशन: वह क्या लेता है, क्या लौटाता है और किन त्रुटियों के साथ जवाब दे सकता है।
ऑपरेशन
The addresses this workspace will not send to: hard bounces and complaints, recorded as they happen, and any address somebody blocks by hand. A send to one is refused for that recipient before anything leaves. A hard bounce stays for good; a complaint or a manual entry can be removed. Reading needs settings:read and changing needs settings:write, the scopes the Blocked addresses screen in Settings is gated on.
GET/suppressions
List suppressed addresses
The addresses this workspace will not send to, newest first: every address that bounced hard, complained, or was added by hand. It is the Blocked addresses screen in Settings. A send to a suppressed address is refused for that recipient before anything leaves, and a message whose recipients are all suppressed fails outright.
The list belongs to the whole workspace, so a key limited to particular addresses or domains reads all of it. A row names the recipient and never which of your addresses sent to it.
Requires the settings:read scope.
क्वेरी पैरामीटर
qstringSearches the address, the reason and the detail. Words match loosely, and a close spelling is tried when nothing matches exactly.
अधिकतम 320 वर्णreasonstringKeeps one kind.
इनमें से एक"bounce""complaint""manual"limitintegerRows per page, 1 to 100.
कम से कम 1अधिकतम 100डिफ़ॉल्ट25cursorstringThe previous page's
nextCursor, passed back as it came. It is opaque: it holds where the last row sat in this list's order, so a row deleted or edited between pages never breaks the walk, and the next page starts at the first row that sorts after it. A value this list did not hand out is a 400invalid_cursor.
लौटाता है
A page of the suppression list, newest first.
त्रुटियाँ
वे त्रुटियाँ जो कोई भी ऑपरेशन लौटा सकता है400401403404422500त्रुटि सूची
इनमें भी उपलब्ध
POST/suppressions
Add a suppressed address
Puts an address on the list by hand, with reason: "manual", so no address in the workspace sends to it until it is removed. Adding one that is already there changes nothing and answers 200 with the row it already holds, whatever its reason. A new entry fires suppression.added.
The list stops mail from every address in the workspace, so a key limited to particular addresses or domains, and an app connected by anybody but the owner, cannot change it.
Requires the settings:write scope.
अनुरोध बॉडी
emailstringआवश्यकThe address to stop sending to. Trimmed and lower-cased on the way in.
अधिकतम 320 वर्णफ़ॉर्मैटemail
लौटाता है
It was already on the list. The row that was there, unchanged.
Added. Nothing is sent to the address from here on.
त्रुटियाँ
- 422
invalid_parameterfor an address that is not one, orcapability_unsupportedfor a key limited to particular addresses or domains.
वे त्रुटियाँ जो कोई भी ऑपरेशन लौटा सकता है400401403404500त्रुटि सूची
इनमें भी उपलब्ध
GET/suppressions/{id}
Retrieve a suppressed address
One row of the suppression list.
Requires the settings:read scope.
पाथ पैरामीटर
idstringआवश्यकThe id from
GET /suppressions.
लौटाता है
The row.
त्रुटियाँ
वे त्रुटियाँ जो कोई भी ऑपरेशन लौटा सकता है400401403404422500त्रुटि सूची
इनमें भी उपलब्ध
DELETE/suppressions/{id}
Remove a suppressed address
Takes an address off the list, so mail may go to it again. It is Allow again on the Blocked addresses screen, and it fires suppression.removed. Only a complaint or a manual entry can be removed.
Requires the settings:write scope.
पाथ पैरामीटर
idstringआवश्यकThe id from
GET /suppressions.
लौटाता है
Removed. Mail may go to the address again.
objectstring- इनमें से एक
"suppression" idstringemailstringdeletedboolean- इनमें से एक
true
त्रुटियाँ
- 409
suppression_not_removable: the address bounced hard, so it stays. Check the address is right and send to the corrected one.- 422
capability_unsupportedfor a key limited to particular addresses or domains.
वे त्रुटियाँ जो कोई भी ऑपरेशन लौटा सकता है400401403404500त्रुटि सूची
इनमें भी उपलब्ध
ऑब्जेक्ट
Suppressionobject
objectstring- इनमें से एक
"suppression" idstringemailstringThe recipient address, lower-cased. It is somebody you sent to, not one of your own.
reasonstringbounceis a hard bounce and stays for good.complaintmeans the recipient marked a message as spam.manualmeans somebody added it.इनमें से एक"bounce""complaint""manual"detailstringWhat the bounce or complaint said, when it said anything.
null हो सकता हैremovablebooleanWhether
DELETE /suppressions/{id}will take it off. False for a bounce.createdAtstring- फ़ॉर्मैट
date-time
SuppressionListobject
objectstring- इनमें से एक
"list" dataSuppression[]hasMorebooleanTrue when another page follows. Pass
nextCursorback ascursorto read it.nextCursorstringAn opaque cursor for the next page, or null on the last page. Pass it back unchanged.
null हो सकता है