Temporary mail
Disposable inboxes for a sign-up or a test.
Temporary mail tools
| Tool | What it does |
|---|---|
| listTempMailDomains | The domains a temporary inbox can be made on. |
| createTempInbox | A new disposable address and the inbox token that opens it. Keep the token: every other temporary mail tool needs it. |
| getTempInbox | The address of an inbox, when it expires, how many extensions are left and how many messages it holds. |
| listTempMessages | The messages an inbox received, newest first, with sender, subject, arrival time and a snippet. |
| readTempMessage | One message with its text, and its sign-in code when it is a verification email and OpenEmail is sure of the code. |
| extendTempInbox | Keep an inbox open longer. It returns a new token to use from then on. |
| deleteTempMessage | Delete one message of an inbox for good. |
| deleteTempInbox | Close an inbox now and delete everything it received. |
These are the free disposable inboxes of the OpenEmail website. An inbox belongs to no workspace and opens with its own token, so the tools need no permission and the token is the only key. Anyone holding it can read the inbox.
Mail to the address is kept for a day at most. A chosen name can be guessed and is taken by somebody else once the inbox expires, so leave localPart out for a random one.
Reference
listTempMailDomains
List the domains a temporary inbox can be made on, the free disposable addresses of the OpenEmail website. A temporary inbox belongs to no workspace and opens with its own token.
Inputs
Takes no input.
Also available in
createTempInbox
Make a temporary inbox: a disposable address that receives mail for a while, for a sign-up or a test, without touching the workspace. Returns the address and an inbox token that every other temporary mail tool needs, so keep it. Read what arrives with listTempMessages and readTempMessage, which also gives the sign-in code of a verification email. The inbox lasts an hour by default and at most 1440 minutes in all.
Inputs
domainstringOne of the domains listTempMailDomains names. Defaults to the first.
Up to 253 characterslocalPartstringThe part before the @. Leave it out for a random one: a chosen name can be guessed and is taken by somebody else once the inbox expires.
Up to 64 charactersttlMinutesintegerHow long the inbox lasts, in minutes.
At least 1At most 1440
Also available in
- API
POST /temp-mail/inboxes- TypeScript
tempMail.create()- Python
temp_mail.create()- Ruby
temp_mail.create- PHP
tempMail->create
getTempInbox
Read a temporary inbox: its address, when it expires, how many extensions are left and how many messages it holds.
Inputs
tokenstringRequiredThe inbox token createTempInbox returned, starting with oe_inbox_. It is the only key to the inbox.
1 to 4096 characters
Also available in
- API
GET /temp-mail/inboxes/{id}GET /temp-mail/inboxes/{id}/messages- TypeScript
tempMail.get()tempMail.listMessages()tempMail.listAllMessages()tempMail.iterateMessages()- Python
temp_mail.get()temp_mail.list_messages()temp_mail.list_all_messages()temp_mail.iterate_messages()- Ruby
temp_mail.gettemp_mail.list_messagestemp_mail.list_all_messagestemp_mail.iterate_messages- PHP
tempMail->gettempMail->listMessagestempMail->listAllMessagestempMail->iterateMessages
listTempMessages
List the messages a temporary inbox has received, newest first: id, sender, subject, when it arrived and a snippet.
Inputs
tokenstringRequiredThe inbox token createTempInbox returned, starting with oe_inbox_. It is the only key to the inbox.
1 to 4096 characterslimitintegerHow many messages to return.
At least 1At most 50cursorstringThe next cursor of the previous page.
1 to 512 characters
Also available in
- API
GET /temp-mail/inboxes/{id}GET /temp-mail/inboxes/{id}/messages- TypeScript
tempMail.get()tempMail.listMessages()tempMail.listAllMessages()tempMail.iterateMessages()- Python
temp_mail.get()temp_mail.list_messages()temp_mail.list_all_messages()temp_mail.iterate_messages()- Ruby
temp_mail.gettemp_mail.list_messagestemp_mail.list_all_messagestemp_mail.iterate_messages- PHP
tempMail->gettempMail->listMessagestempMail->listAllMessagestempMail->iterateMessages
readTempMessage
Read one message of a temporary inbox: sender, subject, when it arrived, the sign-in code when it is a verification email and OpenEmail is sure of it, and the text.
Inputs
tokenstringRequiredThe inbox token createTempInbox returned, starting with oe_inbox_. It is the only key to the inbox.
1 to 4096 charactersmessageIdstringRequiredThe message id listTempMessages returned.
1 to 512 characters
Also available in
extendTempInbox
Keep a temporary inbox open longer. Each extension adds time up to 1440 minutes in all, at most 23 times. It returns a new inbox token: use it from then on.
Inputs
tokenstringRequiredThe inbox token createTempInbox returned, starting with oe_inbox_. It is the only key to the inbox.
1 to 4096 characters
Also available in
- API
POST /temp-mail/inboxes/{id}/extend- TypeScript
tempMail.extend()- Python
temp_mail.extend()- Ruby
temp_mail.extend- PHP
tempMail->extend
deleteTempMessage
Delete one message of a temporary inbox for good.
Inputs
tokenstringRequiredThe inbox token createTempInbox returned, starting with oe_inbox_. It is the only key to the inbox.
1 to 4096 charactersmessageIdstringRequiredThe message id listTempMessages returned.
1 to 512 characters
Also available in
deleteTempInbox
Close a temporary inbox now and delete everything it received. Its token stops working.
Inputs
tokenstringRequiredThe inbox token createTempInbox returned, starting with oe_inbox_. It is the only key to the inbox.
1 to 4096 characters
Also available in
- API
DELETE /temp-mail/inboxes/{id}- TypeScript
tempMail.delete()- Python
temp_mail.delete()- Ruby
temp_mail.delete- PHP
tempMail->delete