Dërgimi
Çdo veprim në këtë grup: çfarë pranon, çfarë kthen dhe gabimet me të cilat mund të përgjigjet.
Veprimet
How mail leaves the workspace. It travels in two lanes, so a newsletter cannot hold up or harm app mail: transactional for password resets, receipts and codes, and broadcast for newsletters. Each lane has its own queue and its own reputation numbers. The broadcast lane pauses itself when too many of its messages bounce or are reported as spam, and app mail keeps going out. A workspace with the dedicated IP add-on also sends from its own IP address.
GET/sending/streams
List the sending lanes
Both lanes with their state and their numbers for the last 7 days: recipients, bounces and complaints, the rates, and the limits the broadcast lane is held to. A paused lane says when and why. The count starts again when a lane is resumed.
Requires the emails:read scope.
Kthen
The two lanes.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
POST/sending/streams/{stream}/resume
Resume a paused lane
Resumes the broadcast lane after it was paused for too many bounces or complaints. Broadcasts and messages that were on hold continue at once, and the 7 day count starts again from now, so clean the audience first. Only the workspace owner may do it, and an app acting for a person is asked for a verification code.
Requires the domains:write scope.
Parametrat e shtegut
streamstringE detyrueshmeThe lane,
transactionalorbroadcast.Një nga"transactional""broadcast"
Kthen
The lane, active again.
Gabimet
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the OpenEmail website. An API key is never asked for a code.- 409
stream_not_paused: the lane is not paused, so there is nothing to resume.
Gabimet që mund të kthejë çdo veprim400401404422500Katalogu i gabimeve
E disponueshme edhe në
GET/sending/dedicated-ips
List dedicated IPs
The dedicated sending IPs of the workspace, bought as an add-on with POST /billing/add-ons/checkout. A new IP is warmed up over several weeks: warmupPercent says how far it is, and until it reaches 100 part of the mail still leaves through the shared IPs. A workspace without the add-on gets an empty list and sends through the shared IPs.
Requires the domains:read scope.
Kthen
The dedicated IPs.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
GET/sending/dedicated-ips/{ip}
Read a dedicated IP
One dedicated IP of the workspace with its status and how far its warm-up has come.
Requires the domains:read scope.
Parametrat e shtegut
ipstringE detyrueshmeThe IP address, as the list returns it.
Kthen
The dedicated IP.
Gabimet
- 404
resource_not_found: the workspace has no dedicated IP with that address.
Gabimet që mund të kthejë çdo veprim400401403422500Katalogu i gabimeve
E disponueshme edhe në
Objektet
DedicatedIpobject
objectstringE detyrueshme- Një nga
"dedicated_ip" ipstringE detyrueshmestatusstringE detyrueshmewarmingwhile the IP is being warmed up,readyonce all of the workspace's mail leaves through it.Një nga"available""warming""ready""released"poolstringE detyrueshmeThe pool the IP sends through.
Mund të jetë nullpoolStatusstringE detyrueshme- Mund të jetë nullNjë nga
"pending""warming""active""releasing""released""failed" warmupPercentintegerE detyrueshme- Të paktën 0Më së shumti 100
assignedAtstringE detyrueshme- Mund të jetë nullFormati
date-time readyAtstringE detyrueshme- Mund të jetë nullFormati
date-time checkedAtstringE detyrueshmeWhen the warm-up was last read.
Mund të jetë nullFormatidate-time
DedicatedIpListobject
objectstringE detyrueshme- Një nga
"list" dataDedicatedIp[]E detyrueshme
SendingStreamobject
objectstringE detyrueshme- Një nga
"sending_stream" streamstringE detyrueshme- Një nga
"transactional""broadcast" statusstringE detyrueshmepausedholds every new message on the lane until it is resumed. Only the broadcast lane pauses.Një nga"active""paused"pausedAtstringE detyrueshme- Mund të jetë nullFormati
date-time pausedReasonstringE detyrueshmeWhich limit was passed, or null on an active lane.
Mund të jetë nullNjë nga"bounce_rate""complaint_rate"resumedAtstringE detyrueshmeWhen the lane was last resumed. The count in
windowstarts no earlier than this.Mund të jetë nullFormatidate-timewindowobjectE detyrueshmesincestringE detyrueshme- Formati
date-time untilstringE detyrueshme- Formati
date-time recipientsintegerE detyrueshmeRecipients the lane handed over for delivery in the window.
bouncedintegerE detyrueshmecomplainedintegerE detyrueshmeRecipients who reported the mail as spam.
bounceRatenumberE detyrueshmeBounced over recipients, from 0 to 1.
complaintRatenumberE detyrueshmeComplained over recipients, from 0 to 1.
limitsobjectE detyrueshmebounceRatenumberE detyrueshmeThe broadcast lane pauses above this bounce rate.
complaintRatenumberE detyrueshmeThe broadcast lane pauses above this complaint rate.
minimumRecipientsintegerE detyrueshmeThe rates are only judged once the lane reached this many recipients in the window.
windowDaysintegerE detyrueshme
SendingStreamListobject
objectstringE detyrueshme- Një nga
"list" dataSendingStream[]E detyrueshme