SDK

openemail.support

Каждый метод этого пространства имён: его сигнатура, параметры, что он возвращает, и пример.

Методы

Write to the people who build OpenEmail, as the contact page does. The reply goes by email to the account behind the client.

`support.send()`

Write to OpenEmail support

Без области доступа

Сигнатура

send(body: SupportRequestInput, options?: RequestScope): Promise<SupportRequestResource>

Sends a message to the people who build OpenEmail, as the contact page does for somebody signed in. The name and the address the reply goes to come from the account behind the client: the workspace owner for an API key, and the person who connected the app for an access token. The workspace is named in the message, so support knows which one it is about.

Параметры

body.topicstringОбязательно: What it is about in a few words, up to 64 characters, such as Bug report or Domains & DNS.
body.messagestringОбязательно: The message itself, up to 8,000 characters.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Возвращает

SupportRequestResource with the id of the message and replyTo, the address the reply will go to.

Пример

const sent = await openemail.support.send({    topic: 'Bug report',    message: 'Scheduled sends to one address stay queued since this morning.'}) console.log(sent.id, sent.replyTo)

Примечания

Needs no scope.
One address can send 3 messages in 10 minutes. The next one is 429 support_rate_limited, and nothing is recorded or sent.
The SDK does not retry it, because a second call would send a second message.

Также доступно в

API: POST /support
CLI: openemail support send