(messages.email)
- send - Send an email
Send an email
import { Pushpress } from "pushpress";
const pushpress = new Pushpress({
apiKey: process.env["PUSHPRESS_API_KEY"] ?? "",
});
async function run() {
await pushpress.messages.email.send({
to: "[email protected]",
subject: "<value>",
body: "<value>",
from: "[email protected]",
});
}
run();The standalone function version of this method:
import { PushpressCore } from "pushpress/core.js";
import { messagesEmailSend } from "pushpress/funcs/messagesEmailSend.js";
// Use `PushpressCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const pushpress = new PushpressCore({
apiKey: process.env["PUSHPRESS_API_KEY"] ?? "",
});
async function run() {
const res = await messagesEmailSend(pushpress, {
to: "[email protected]",
subject: "<value>",
body: "<value>",
from: "[email protected]",
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
}
run();| Parameter | Type | Required | Description |
|---|---|---|---|
request |
operations.SendEmailRequestBody | ✔️ | The request object to use for the request. |
options |
RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions |
RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries |
RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Promise<void>
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.Unauthorized | 401, 403, 407, 511 | application/json |
| errors.NotFound | 404, 501, 505 | application/json |
| errors.Timeout | 408, 504 | application/json |
| errors.BadRequest | 413, 414, 415, 422, 431, 510 | application/json |
| errors.RateLimited | 429 | application/json |
| errors.InternalServerError | 500, 502, 503, 506, 507, 508 | application/json |
| errors.APIError | 4XX, 5XX | */* |