Skip to content

SDK method

tools.burnDisposableMailbox

Burn a disposable mailbox. Convenience alias for burn_disposable_mailbox, forwarding to tinbox.api.disposable.burn.mutate.

Signature

ts
burnDisposableMailbox(input: Parameters<TinboxTools["burnDisposableMailbox"]>[0]): ReturnType<TinboxTools["burnDisposableMailbox"]>

Parameters

NameTypeRequiredDescription
pollTokenstringyesThe pollToken of the mailbox to destroy.

Returns

ReturnType<TinboxTools["burnDisposableMailbox"]>

Example

ts
await tinbox.tools.burnDisposableMailbox({
  "pollToken": "ada@example.com"
});