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
def send( body: SupportRequestInput, *, api_key: str | None = None, timeout: float | None = None,) -> SupportRequestResourceSends 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['topic']str必須What it is about in a few words, up to 64 characters, such as
Bug reportorDomains & DNS.body['message']str必須The message itself, up to 8,000 characters.
api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
OpenEmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
戻り値
SupportRequestResource with the id of the message and replyTo, the address the reply will go to.
例
from openemail import openemail sent = openemail.support.send( { 'topic': 'Bug report', 'message': 'Scheduled sends from [email protected] have stayed queued since this morning.', }) print(sent['id'], sent['replyTo'])注意事項
Needs no scope.
One address can send 3 messages in 10 minutes. The next one raises a 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- TypeScript
support.send()- Ruby
support.send- CLI
openemail support send