Skip to content

Commit a67dbb9

Browse files
update the README with recent information
1 parent a15c047 commit a67dbb9

File tree

2 files changed

+8
-35
lines changed

2 files changed

+8
-35
lines changed

README.md

Lines changed: 7 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,6 @@
88

99
This is an API for the temporary email service [TempMail.lol](https://tempmail.lol).
1010

11-
## If you are using a BananaCrumbs ID/Token and have not migrated, install version 3.1.0 instead of 4.x.x!
12-
13-
## Upgrading from 3.1.0
14-
15-
The key difference between 3.1.0 and 4.0.0 is the fact that the constructor only accepts an API Key, and not a BananaCrumbs ID.
16-
17-
The custom domain method has changed as well as the createInbox method's parameters.
18-
19-
## Upgrading from 2.0.3
20-
21-
The version 3.0.0+ is vastly different from the old version of the API. Please read the changes before using the new version of the API.
22-
23-
Version 2.0.3 still works, but does not have support for custom domains or TempMail Plus. Note that v2 support may be dropped at any time, so please
24-
upgrade your applications as soon as possible.
25-
2611
## Installation
2712
```bash
2813
npm i tempmail.lol
@@ -117,33 +102,21 @@ const emails = tempmail.checkInbox("<TOKEN>").then((emails) => {
117102

118103
#### Note: you will need to be a TempMail Plus/Ultra subscriber to use custom domains!
119104

120-
#### Old Custom Domains (v1)
121-
```js
122-
tempmail.checkCustomDomainLegacy("example.com", "token").then(emails => {
123-
emails.forEach(e => {
124-
console.log("Email from: " + e.from + " to " + e.to);
125-
});
126-
});
127-
```
128-
129-
You can obtain a token by visiting https://tempmail.lol/custom.html
105+
To setup Custom Domains, visit your account on https://tempmail.lol/account and follow the instructions on https://tempmail.lol/custom
130106

131-
Custom domains will NOT alert you if the token is invalid.
107+
After setting up Custom Domains, they can be checked the same way you make normal domains (note: only your account can access the domain!)
132108

133-
#### New Custom Domains (v2)
134109
```js
135-
tempmail.checkV2CustomDomain("example.com").then(emails => {
136-
emails.forEach(e => {
137-
console.log("Email from: " + e.from + " to " + e.to);
138-
});
110+
tempmail.createInbox({
111+
community: false,
112+
domain: "example.com", //replace with your custom domain
113+
prefix: "optional", //this will be the ENTIRE beginning of the email. "optional" results in "optional@example.com".
139114
});
140115
```
141116

142-
To setup this, visit your account on https://tempmail.lol/account and migrate if you have not already.
143-
144117
### Webhooks
145118

146-
You can set up a webhook to be called when an email is received.
119+
You can set up a webhook to be called when an email is received. You must have Custom Domains setup beforehand.
147120

148121
```js
149122
tempmail.setWebhook("https://example.com/webhook").then(() => {

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "tempmail.lol",
3-
"version": "4.3.1",
3+
"version": "4.3.2",
44
"description": "API to generate temporary email addresses.",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",

0 commit comments

Comments
 (0)