Skip to content

Correct the Go README claim about when Send blocks #330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
etbyrd wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Correct the Go README claim about when Send blocks #330

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions sdk-go/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,11 @@ result, err := client.Send(ctx, primitive.SendParams{
})
```

`Send`, `Reply`, and `Forward` keep the HTTP request open until Primitive's
downstream SMTP transaction completes. Use a context deadline long enough for
SMTP delivery, typically 30-60 seconds.
By default `Send`, `Reply`, and `Forward` return as soon as Primitive accepts
the message for delivery. On `Send` and `Reply`, set `Wait` to keep the HTTP
request open until the first downstream SMTP delivery outcome; in that mode,
give the context a deadline long enough for SMTP delivery, typically 30-60
seconds. `Forward` has no `Wait` field and always returns on acceptance.

### Per-call timeout and cancellation

Expand Down