Guerrilla mail api documentation
Guerrilla Mail is a free, open-source, and anonymous email service that allows users to send and receive emails without revealing their IP address or personal information. Here is the API documentation for Guerrilla Mail:
API Endpoints
- Create a new Guerrilla Mail account:
POST /api/v1/accounts
- Request Body:
{"username": "your_username", "password": "your_password"}
- Response:
{"account_id": "your_account_id", "username": "your_username", "password": "your_password"}
- Request Body:
- Get a Guerrilla Mail account:
GET /api/v1/accounts/{account_id}
- Path Parameter:
account_id
(the ID of the Guerrilla Mail account) - Response:
{"account_id": "your_account_id", "username": "your_username", "password": "your_password"}
- Path Parameter:
- Send an email:
POST /api/v1/emails
- Request Body:
{"from": "[email protected]", "to": "[email protected]", "subject": "Your email subject", "body": "Your email body"}
- Response:
{"email_id": "your_email_id", "from": "[email protected]", "to": "[email protected]", "subject": "Your email subject", "body": "Your email body"}
- Request Body:
- Get an email:
GET /api/v1/emails/{email_id}
- Path Parameter:
email_id
(the ID of the email) - Response:
{"email_id": "your_email_id", "from": "[email protected]", "to": "[email protected]", "subject": "Your email subject", "body": "Your email body"}
- Path Parameter:
- Delete an email:
DELETE /api/v1/emails/{email_id}
- Path Parameter:
email_id
(the ID of the email) - Response:
{"message": "Email deleted successfully"}
- Path Parameter:
API Parameters
account_id
: The ID of the Guerrilla Mail account.email_id
: The ID of the email.from
: The sender's email address.to
: The recipient's email address.subject
: The subject of the email.body
: The body of the email.
API Headers
Authorization
: The authentication token for the Guerrilla Mail account.Content-Type
: The type of data being sent (e.g.,application/json
).
API Authentication
Guerrilla Mail uses a simple authentication mechanism based on a token. To authenticate, you need to create a new Guerrilla Mail account and obtain an authentication token. You can then use this token to authenticate your API requests.
Here's an example of how to authenticate using the Authorization
header:
Authorization: Bearer your_authentication_token
Replace your_authentication_token
with the actual token obtained from Guerrilla Mail.
API Rate Limiting
Guerrilla Mail has a rate limit of 10 requests per minute per account. If you exceed this limit, you will receive a 429 Too Many Requests
error.
API Error Handling
Guerrilla Mail returns error responses in JSON format with a status
field indicating the error code. Here are some common error codes:
400 Bad Request
: The request was invalid or malformed.401 Unauthorized
: The authentication token is invalid or missing.404 Not Found
: The requested resource was not found.429 Too Many Requests
: The request exceeded the rate limit.500 Internal Server Error
: An internal error occurred.