Skip to content

SDK method

tools.dropDisposableMailbox

Stop receiving at a disposable mailbox. Convenience alias for drop_disposable_mailbox, forwarding to tinbox.api.disposable.drop.mutate.

Signature

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

Parameters

NameTypeRequiredDescription
pollTokenstringyesThe pollToken of the mailbox to stop receiving at.

Returns

ReturnType<TinboxTools["dropDisposableMailbox"]>

Example

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