0% found this document useful (0 votes)
440 views6 pages

API Documentation

This API documentation describes how to use the TmailZ API to manage temporary disposable emails. It provides endpoints to get available domains, create email IDs, and fetch emails. The fetch emails endpoint returns email content and metadata in JSON format, including attachment links and delete/download URLs that require an API key. Sample responses are provided for emails with and without attachments.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
440 views6 pages

API Documentation

This API documentation describes how to use the TmailZ API to manage temporary disposable emails. It provides endpoints to get available domains, create email IDs, and fetch emails. The fetch emails endpoint returns email content and metadata in JSON format, including attachment links and delete/download URLs that require an API key. Sample responses are provided for emails with and without attachments.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 6

TmailZ | Disposable Temporary Email

Www.Tmailz.Com

API Documentation
List of Domains
URL

https://tmailz.com/actions.php?action=getDomains&apikey=[yourkey]

Parameters

Key Value
action getDomains
apikey Key which you may have set in your Admin Panel of TMail Installation. In case
you have not set that, you can keep this blank

Sample Response

[
"tmailz.com"

Create Email ID
URL

https://tmailz.com/user.php?user=[emailID]&apikey=[yourkey]

Parameters

Key Value
user Based on the domains available you can send a generated email ID. If this
parameter is not specified, system will generate a random email ID and return
that.

Sample Response
[email protected]
Fetch Emails
URL

https://tmailz.com/mail.php?email=[emailID]&apikey=[yourkey]

Parameters

Key Value
email Pass the returned email ID from above step in order to receive emails related to
that ID.
apikey Key which you may have set in your Admin Panel of TMail Installation. In case
you have not set that, you can keep this blank

Result

Above API call will provide a JSON response with all details of all emails in the inbox of
particular email ID. It will provide file name and link to download for Attachments. It will
also provide links Delete and Download emails. Make sure you append your API key (like
&apikey=[yourkey] ) to the end of Delete and Download URLs.

Sample Response (with Attachments)

[
{
"textPlain": "API Test with Attachments\r\n",
"textHtml": "\r\nAPI Test with Attachments</div></div>\r\n",
"id": 7,
"date": "2018-12-26 04:11:39",
"headersRaw": "Return-Path: .......",
"headers": {
"date": "Wed, 26 Dec 2018 14:41:39 +0530",
"Date": "Wed, 26 Dec 2018 14:41:39 +0530",
"subject": "API Testing with Attachments",
"Subject": "API Testing with Attachments",
"message_id": "",
"toaddress": "[email protected]",
"to": [
{
"mailbox": "username",
"host": "tmailz.com"
}
],
"fromaddress": "username ",
"from": [
{
"personal": "username",
"mailbox": "username",
"host": "gmail.com"
}
],
"reply_toaddress": "username ",
"reply_to": [
{
"personal": "username ",
"mailbox": "username",
"host": "gmail.com"
}
],
"senderaddress": "username ",
"sender": [
{
"personal": "username ",
"mailbox": "username",
"host": "gmail.com"
}
]
},
"subject": "API Testing with Attachments",
"fromName": "username ",
"fromAddress": "[email protected]",
"to": {
"[email protected]": null
},
"toString": "[email protected]",
"cc": [],
"bcc": [],
"replyTo": {
"[email protected]": "username "
},
"messageId": "",
"tmail_attachments": [
[
"Readmetxt",

"https://tmailz.com/attachments/[email protected]/8/Readme.txt"
]
],
"tmail_delete_url":
"https://tmailz.com/actions.php?action=delete&id=8&[email protected]",
"tmail_download_url":
"https://tmailz.com/actions.php?action=download&id=8&[email protected].
gq"
}
]
Sample Response (without Attachments)

[
{
"textPlain": "API Test\r\n",
"textHtml": "\r\nAPI Test</div></div>\r\n",
"id": 7,
"date": "2018-12-26 04:11:39",
"headersRaw": "Return-Path: .......",
"headers": {
"date": "Wed, 26 Dec 2018 14:41:39 +0530",
"Date": "Wed, 26 Dec 2018 14:41:39 +0530",
"subject": "API Testing",
"Subject": "API Testing",
"message_id": "",
"toaddress": "[email protected]",
"to": [
{
"mailbox": "username",
"host": "bavfau.gq"
}
],
"fromaddress": "username ",
"from": [
{
"personal": "username ",
"mailbox": "username",
"host": "gmail.com"
}
],
"reply_toaddress": "username ",
"reply_to": [
{
"personal": "username ",
"mailbox": "username",
"host": "gmail.com"
}
],
"senderaddress": "username ",
"sender": [
{
"personal": "username ",
"mailbox": "username",
"host": "gmail.com"
}
]
},
"subject": "API Testing",
"fromName": "username ",
"fromAddress": "[email protected]",
"to": {
"[email protected]": null
},
"toString": "[email protected]",
"cc": [],
"bcc": [],
"replyTo": {
"[email protected]": "username "
},
"messageId": "",
"tmail_attachments": [],
"tmail_delete_url":
"https://tmailz.com/actions.php?action=delete&id=7&[email protected]",
"tmail_download_url":
"https://tmailz.com/actions.php?action=download&id=7&email=username@bavfau.
gq"
}
]

You might also like