client.sending
Jede Methode in diesem Namespace: ihre Signatur, ihre Parameter, was sie zurückgibt und ein Beispiel.
Methoden
How mail leaves the workspace: the two lanes it travels in, transactional for app mail and broadcast for newsletters, each with its bounce and complaint numbers, the switch that resumes a paused lane, and the dedicated IPs of a workspace that bought one.
sending.list_streams
List the sending lanes
list_streams(api_key: nil) -> HashReturns the two lanes mail travels in, transactional for app mail such as password resets, receipts and codes, and broadcast for newsletters, each with its state and its numbers for the last 7 days: recipients, bounced and complained, the two rates, and the limits the broadcast lane is held to. The lanes have their own queues and their own reputation, so a newsletter never holds up or harms app mail.
The broadcast lane pauses itself when more than 4% of its recipients bounced or more than 0.2% reported the mail as spam over those 7 days, once it reached enough recipients to judge. A paused lane says when and why in pausedAt and pausedReason, and app mail keeps going out. The count starts again when a lane is resumed, which resumedAt gives.
Parameter
api_keyStringOverrides the client's API key for this call only.
Rückgabe
A Hash with one Hash per lane in data: stream, status, pausedAt, pausedReason, resumedAt, window and limits.
Beispiel
lanes = client.sending.list_streams lanes[:data].each do |lane| puts "#{lane[:stream]} #{lane[:status]} #{lane[:window][:bounceRate]} #{lane[:window][:complaintRate]}"endHinweise
Only the broadcast lane pauses. The transactional lane is always
active.A GET is retried automatically on network failure and on 408, 500, 502, 503 and 504 responses, up to the client's
max_retries:, and on a 429 only when it carries aRetry-Afterof a minute or less.
Auch verfügbar über
sending.resume_stream
Resume a paused lane
resume_stream(stream, api_key: nil) -> HashResumes the broadcast lane after it was paused for too many bounces or complaints, as Resume does on the Analytics page of the app. Broadcasts and messages that were on hold continue at once, and the 7 day count starts again from now, so clean the audience first: a lane resumed onto the same list pauses again.
Only the workspace owner may do it: an API key acts for the owner, and an access token that acts for a member is 403 owner_only.
Parameter
streamStringErforderlichThe lane to resume,
broadcast. The transactional lane never pauses.api_keyStringOverrides the client's API key for this call only.
Rückgabe
A Hash with the lane, now with status active and resumedAt set.
Beispiel
lane = client.sending.resume_stream("broadcast") puts lane[:status], lane[:resumedAt]Hinweise
With an OAuth access token it asks for a verification code: until the app has verified one, it is refused with 403
step_up_required. An API key is never asked.A lane that is not paused is 409
stream_not_paused.The SDK does not retry it.
Auch verfügbar über
sending.list_dedicated_ips
List dedicated IPs
list_dedicated_ips(api_key: nil) -> HashReturns the dedicated sending IPs of the workspace, bought as an add-on with billing.start_add_on_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, so nothing is held back while it warms. status is warming until then and ready after.
A workspace without the add-on gets an empty data Array and sends through the shared IPs.
Parameter
api_keyStringOverrides the client's API key for this call only.
Rückgabe
A Hash with one Hash per IP in data: ip, status, pool, poolStatus, warmupPercent, assignedAt, readyAt and checkedAt.
Beispiel
addresses = client.sending.list_dedicated_ips addresses[:data].each do |address| puts "#{address[:ip]} #{address[:status]} #{address[:warmupPercent]}%"endHinweise
The warm-up is read from the sending service every few minutes, and
checkedAtsays when.A GET is retried automatically on network failure and on 408, 500, 502, 503 and 504 responses, up to the client's
max_retries:, and on a 429 only when it carries aRetry-Afterof a minute or less.
Auch verfügbar über
sending.get_dedicated_ip
Read a dedicated IP
get_dedicated_ip(ip, api_key: nil) -> HashReturns one dedicated IP of the workspace with its status and how far its warm-up has come.
Parameter
ipStringErforderlichThe IP address, as
list_dedicated_ipsreturns it, such as203.0.113.24.api_keyStringOverrides the client's API key for this call only.
Rückgabe
A Hash with ip, status, pool, poolStatus, warmupPercent, assignedAt, readyAt and checkedAt.
Beispiel
address = client.sending.get_dedicated_ip("203.0.113.24") puts address[:status], address[:warmupPercent]Hinweise
An IP that does not belong to the workspace is a 404
resource_not_found.A GET is retried automatically on network failure and on 408, 500, 502, 503 and 504 responses, up to the client's
max_retries:, and on a 429 only when it carries aRetry-Afterof a minute or less.