Foggy Email API
Authentication
By default, you can use your API token (Which can be found within your account dashboard) to check if your authentication works.
To only authenticate yourself, you need to perform a POST request to the following URL:
https://foggy.email/api/?foggyemail_api=authenticate
As a content type, you need to define JSON:
Content-Type: application/json
Within the body of the request, you can simply send a JSON, which contains the foggyemail_ussauth key, including your API key:
{ "foggyemail_ussauth": "YOUR_APIKEY" }
Create Alias
To create an alias, you can use a very similar setup as for only checking your authentication. Therefore simply change the GET paremeter of the URL to create_alias
https://foggy.email/?foggyemail_api=create_alias
You can keep the content type as for checking your authentication at JSON.
To actually create the alias, you have certain attributes available:
- alias - Which refers as the alias of the email you generate. E.g. demoalias which later turns into [email protected] (Optional) - If left empty, a generic alias is created
- email - which is the email you want to forward the messages to (Required)
- domain - the email you want to register the alias for. (Optional)
Here is an example of how the request may look like:
{ "foggyemail_ussauth": "MY_API_KEY", "alias": "robert", "email": "[email protected]", "domain": "neat.email" }
Update Alias Email
To update an alias, you can use the same structure as for creating it. There's only two differences: You need to set the alias and the foggyemail_api parameter to update_alias
https://foggy.email/?foggyemail_api=update_alias
You can keep the content type as for checking your authentication at JSON.
To actually update the alias email, you need to set the alias itself, along with your api key and the email you want to change. Please find a list of all down below:
- alias (Required) - The name of the alias you want to update
- email - The email you want to change the given alias to. (Emails will be forwarded to this address)
- domain - the email you want to register the alias for. (Optional)
Here is an example of how the request may look like:
{ "foggyemail_ussauth": "MY_API_KEY", "alias": "robert", "email": "[email protected]", "domain": "neat.email" }
Delete Alias
To update an alias, you can use the same structure as for creating or updating it. There's only two differences: You only need to set the alias and the foggyemail_api parameter to delete_alias
https://foggy.email/?foggyemail_api=delete_alias
You can keep the content type as for checking your authentication at JSON.
To actually delete the data, you have certain attributes available. Please find a list of all down below:
- alias (Required) - The name of the alias you want to delete
Here is an example of how the request may look like:
{ "foggyemail_ussauth": "MY_API_KEY", "alias": "robert" }
Get Aliases
You can also list all of your aliases. To get started, simply set the following parameter for the Foggy Email API: get_aliases
https://foggy.email/?foggyemail_api=get_aliases
You can keep the content type as for checking your authentication at JSON.
To actually list the data, simply set your API key within the request. Set the page parameter to switch between pages. By default, we output 20 snippets in descending order to the alias.
Here is an example of how the request may look like:
{ "foggyemail_ussauth": "MY_API_KEY", "page": 1 }