ProxiedMail

https://docs.proxiedmail.com
Admin
ProxiedMail is a privacy-focused email service that provides proxy email generation, webhook...
Tokens:22,316
Snippets:130
Trust Score:7.8
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example cURL Request

Source: https://docs.proxiedmail.com/docs/webhooksCr/get

Use this cURL command to make a GET request to the webhook callback endpoint. Ensure you replace 'YOUR_AUTH_TOKEN' with your actual authentication token.

```curl
curl --location --request GET 'https://proxiedmail.com/api/v1/callback/get/14431720055a1d06d59f7c8bf095ddc6' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Token: YOUR_AUTH_TOKEN'
```

--------------------------------

### Example Response for GET /api/v1/proxy-bindings

Source: https://docs.proxiedmail.com/docs/endpoints/getProxyBindings

This JSON object illustrates the structure of a successful response when retrieving proxy bindings. It details the metadata and the list of proxy binding objects, each containing attributes like real email addresses, proxy address, and creation dates.

```json
{
    "meta": {
        "usedProxyBindings": 1,
        "availableProxyBindings": 10,
        "isVerificationEmailSend": false
    },
    "data": [
        {
            "type": "proxy_bindings",
            "id": "C6C4C547-6000-0000-00000BAE",
            "attributes": {
                "real_addresses": {
                    "kkkchinazes@pxdmail.int": {
                        "is_enabled": true,
                        "is_verification_needed": false,
                        "is_verified": false
                    }
                },
                "proxy_address": "v7do1zfs8w@proxiedmail.com",
                "received_emails": 0,
                "description": "",
                "callback_url": "",
                "created_at": "2023-12-23 12:56:32",
                "updated_at": "2023-12-23 12:56:32"
            },
            "relationships": {
                "user": {
                    "data": {
                        "type": "users",
                        "id": "A2F49023-0000-0000-00009BC6"
                    }
                }
            }
        },
        {
            "type": "proxy_bindings",
            "id": "DBE6A547-6000-0000-00000BAE",
            "attributes": {
                "real_addresses": {
                    "kkkchinazes@pxdmail.int": {
                        "is_enabled": true,
                        "is_verification_needed": false,
                        "is_verified": false
                    }
                },
                "proxy_address": "news-65ddf8@proxiedmail.com",
                "received_emails": 0,
                "description": "Automatic address, created to send you tips on how to stay safe online and protect the ownership of your digital assets",
                "callback_url": "",
                "created_at": "2023-12-23 12:53:22",
                "updated_at": "2023-12-23 12:53:22"
            },
            "relationships": {
                "user": {
                    "data": {
                        "type": "users",
                        "id": "A2F49023-0000-0000-00009BC6"
                    }
                }
            }
        }
    ]
}

```

--------------------------------

### AI Bot Prompt Example

Source: https://docs.proxiedmail.com/docs/bots/ai-bots-usage

Example prompt for an AI email delivery bot that calculates package delivery prices within France. It specifies the bot's role, required information (origin and destination), pricing logic, and conditions for handling deliveries to Corsica or outside France.

```text
You're an AI email delivery bot that would consult about the price of package delivery in France.   
You have to ask for the from destination and the to destination.   
This destinations is in France.  
Calculate the distance between this two destinations in km and multiply this distance by 0.51 to get the price in EUR.  
Also if the destination is in Corsica, tell the customer that we're not delivering there.  
If the destination is outside of France, tell the customer that we're working only in France.  


```

--------------------------------

### API Token Response Example

Source: https://docs.proxiedmail.com/docs/endpoints/apitoken

This is an example of a successful 200 OK response when requesting an API token. The response body contains the generated token.

```json
{
    "token": "a098ea9a8d23TOKENTOKEN066e23d6222"
}
```

--------------------------------

### cURL Request Example

Source: https://docs.proxiedmail.com/docs/endpoints/patchProxyBindings

Example of how to make a PATCH request to the /api/v1/proxy-bindings/{id} endpoint using cURL. This demonstrates setting the content type, authentication token, and the request body.

```curl
curl --location --request PATCH 'https://proxiedmail.com/api/v1/proxy-bindings/A1131D57-6000-0000-00000BAE' \
--header 'content-type: application/json' \
--header 'Token: Token' \
--data-raw '{"data":{"id":"A1131D57-6000-0000-00000BAE","type":"proxy_bindings","attributes":{"real_addresses":{"kkkchinazes@pxdmail.int":true},"proxy_address":"q1v9nj1gkw@proxiedmail.com","received_emails":0,"description":"abc"}}}'

```

--------------------------------

### cURL Request to GET Proxy Bindings

Source: https://docs.proxiedmail.com/docs/endpoints/getProxyBindings

This cURL command demonstrates how to make a GET request to the proxy-bindings endpoint. Ensure you replace 'Auth_TOKEN' with your actual authentication token.

```bash
curl --location --request GET 'https://proxiedmail.com/api/v1/proxy-bindings' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Token: Auth_TOKEN'

```

--------------------------------

### cURL Request to Get Proxy Bindings

Source: https://docs.proxiedmail.com/docs/endpoints/getproxybindings

Demonstrates how to make a GET request to the proxy-bindings endpoint using cURL. Ensure you replace 'Auth_TOKEN' with your actual authentication token.

```curl
curl --location --request GET 'https://proxiedmail.com/api/v1/proxy-bindings' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Token: Auth_TOKEN'
```

--------------------------------

### Example Response (200 OK)

Source: https://docs.proxiedmail.com/docs/endpoints/getproxybindings

Shows the structure of a successful response when retrieving proxy bindings. It includes metadata about usage and a list of individual proxy binding configurations.

```json
{
    "meta": {
        "usedProxyBindings": 1,
        "availableProxyBindings": 10,
        "isVerificationEmailSend": false
    },
    "data": [
        {
            "type": "proxy_bindings",
            "id": "C6C4C547-6000-0000-00000BAE",
            "attributes": {
                "real_addresses": {
                    "kkkchinazes@pxdmail.int": {
                        "is_enabled": true,
                        "is_verification_needed": false,
                        "is_verified": false
                    }
                },
                "proxy_address": "v7do1zfs8w@proxiedmail.com",
                "received_emails": 0,
                "description": "",
                "callback_url": "",
                "created_at": "2023-12-23 12:56:32",
                "updated_at": "2023-12-23 12:56:32"
            },
            "relationships": {
                "user": {
                    "data": {
                        "type": "users",
                        "id": "A2F49023-0000-0000-00009BC6"
                    }
                }
            }
        },
        {
            "type": "proxy_bindings",
            "id": "DBE6A547-6000-0000-00000BAE",
            "attributes": {
                "real_addresses": {
                    "kkkchinazes@pxdmail.int": {
                        "is_enabled": true,
                        "is_verification_needed": false,
                        "is_verified": false
                    }
                },
                "proxy_address": "news-65ddf8@proxiedmail.com",
                "received_emails": 0,
                "description": "Automatic address, created to send you tips on how to stay safe online and protect the ownership of your digital assets",
                "callback_url": "",
                "created_at": "2023-12-23 12:53:22",
                "updated_at": "2023-12-23 12:53:22"
            },
            "relationships": {
                "user": {
                    "data": {
                        "type": "users",
                        "id": "A2F49023-0000-0000-00009BC6"
                    }
                }
            }
        }
    ]
}
```

--------------------------------

### Email Callback Payload Example

Source: https://docs.proxiedmail.com/docs/usecases/receivingcallbacks

This is an example of the JSON payload received when an email is forwarded as a callback. It contains email headers and body content.

```json
{
"id":"E706070F-2400-0000-00003CC8",
"payload":{
"Content-Type":"multipart/alternative; boundary=\"00000000000026ed020603f9413b\"",
"Date":"Mon, 28 Aug 2023 11:35:24 +0100",
"Dkim-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=holyeat-com.20221208.gappssmtp.com; s=20221208; t=1693218935; x=1693823735; h=to:subject:message-id:date:from:mime-version:from:to:cc:subject :date:message-id:reply-to; bh=DvlZhjB6zfSd4x+w7gp1CxW+6CKagmlXWtT0pE4V96o=; b=p5axjc4sOAtsSeM2Z0Zs23NgGKbde13b3avlr88v6xp2Kwp7kEt8zHurYL8IQBrYpx Ubwl38jJrVmppf2BY57WM8kf5o2Q5F34S5xPWVhSfF0Us+qU4XV1i72w9z35HpuAonb8 RHmcz1s+qXs7XwqzOacGBaIF2EnAfvhkOps2Xd1rYhoT2shGOfWtW6cH7O1E8lPfDhE2 Vh1IDTJU/mlIdRAVzl3nLBp0YkUQ41BIThHyF11CxnHWakJ4k/edeAME+rxDSOOX2MEk PhYqLN+igYgO/76ArXFAZv2BhXmW1VUcXgAfgobBzRWPFeIU2NGMp3ulqc7WxlaWO0M5 4C0Q==",
"From":"Alex Yatsenko <alex@holyeat.com>",
"Message-Id":"<CACkEpfx6-Pj7hr=A9JQz7b1PYaK4i0ZbtcPxG+ZvpiUw4dOj5Q@mail.gmail.com>",
"Mime-Version":"1.0",
"Received":"by mail-ot1-f54.google.com with SMTP id 46e09a7af769-6bd066b0fd4so2034773a34.2 for <news-0197fc@proxiedmail.com>; Mon, 28 Aug 2023 03:35:35 -0700 (PDT)",
"Subject":"Hi man hi",
"To":"news-0197fc@proxiedmail.com",
"X-Envelope-From":"alex@holyeat.com",
"X-Gm-Message-State":"AOJu0YzdfcbOCYb059LkqPRmUwIkQ3Isf8nyLMh92p5lYWVlMOUSjWXE BeQpEj22dKRUpP/tPyPzOEn0s1mTE8Z6rm4qi+qEzYe2ZQ2hriBxnWdajQ==",
"X-Google-Dkim-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1693218935; x=1693823735; h=to:subject:message-id:date:from:mime-version:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=DvlZhjB6zfSd4x+w7gp1CxW+6CKagmlXWtT0pE4V96o=; b=RESRktBr+d7GsL7AaGh8vvdr5QmI8GTBIBstHT1zwWQSue774dfWBqtJCxcZMsBNrV eZdx0/7qSebRAEtZdWV4c95/2amgWtEWlocvEsejq0ztc0aHkGKEjoMhb1m6u6SKUwSk 1GqyKICrK8hup5csJ0+vJSazfY7gaRf1D+L7rR/CQdzAgcPKcey0W9Oy8pqkQTh81A4T VW2WSbnixs79wcznd/B3wpMf9LKQVBLSI4yZgC2k7IeYEE3+RQ3SyuHqt5j7YH9afES3 0SeNu3FLQleQG8V6YRGSU7kadklvsaS+rXQfZy7YzOZChbzIltrzM2u5BTtzz7QL4BjA QUcw==",
"X-Google-Smtp-Source":"AGHT+IHdv2RgMkDAb4GuR2+ziXq19m1XSSgP/QXqpmYCaXJhrQBJ1OswQ9Haov2m7u0uawa+TeTWIfqVZN8oEOxW/Rk=",
"X-Received":"by 2002:a9d:7a9a:0:b0:6b9:8ea3:2ce0 with SMTP id l26-20020a9d7a9a000000b006b98ea32ce0mr11160533otn.33.1693218935066; Mon, 28 Aug 2023 03:35:35 -0700 (PDT)",
"body-html":"<div dir=\"ltr\">hey man hey<br clear=\"all\"><div><br><\/div><span class=\"gmail_signature_prefix\">-- <\/span><br><div dir=\"ltr\" class=\"gmail_signature\" data-smartmail=\"gmail_signature\"><div dir=\"ltr\"><b><font color=\"#38761d\">Alex<\/font><\/b><div>Co-Founder at HolyEat<\/div><div>Email: <a href=\"mailto:alex@holyeat.com\" target=\"_blank\">alex@holyeat.com<\/a><br><\/div><\/div><\/div><\/div>\r\n",
"body-plain":"hey man hey\r\n\r\n-- \r\n*Alex*\r\nCo-Founder at HolyEat\r\nEmail: alex@holyeat.com\r\n",
"domain":"proxiedmail.com",
"from":"Alex Yatsenko <alex@holyeat.com>"
}

```

--------------------------------

### GET /api/v1/callback/get/

Source: https://docs.proxiedmail.com/docs/category/built-in-webhook-receivers

This endpoint is used to retrieve callback information. It allows for querying the status or details of callbacks via a GET request.

```APIDOC
## GET /api/v1/callback/get/

### Description
This endpoint is used to retrieve callback information. It allows for querying the status or details of callbacks via a GET request.

### Method
GET

### Endpoint
/api/v1/callback/get/

### Response
Success Response (200)
Details about the success response are not provided in the source documentation.
```

--------------------------------

### Response for Successful Proxy Binding Creation (201)

Source: https://docs.proxiedmail.com/docs/endpoints/postproxybindings

This is an example of a successful response when a proxy binding is created. It includes metadata about email sending and the details of the newly created binding.

```json
{
    "meta": {
        "isVerificationEmailSend": false,
        "firstProxyBinding": false
    },
    "data": {
        "type": "proxy_bindings",
        "id": "8BE3D44A-6000-0000-00000BAE",
        "attributes": {
            "real_addresses": {
                "bblabla@proxiedmail.int": {
                    "is_enabled": true,
                    "is_verified": false
                }
            },
            "type": 0,
            "proxy_address": "7uj7s9gbnp@proxiedmail.com",
            "received_emails": 0,
            "description": "",
            "callback_url": "",
            "created_at": "2024-01-08 00:08:22",
            "updated_at": "2024-01-08 00:08:22"
        },
        "relationships": {
            "user": {
                "data": {
                    "type": "users",
                    "id": "BE090B33-0000-0000-00009BC6"
                }
            }
        }
    }
}

```

--------------------------------

### Authentication Success Response (200)

Source: https://docs.proxiedmail.com/docs/endpoints/login

Example of a successful authentication response. It contains an access token, expiration time, and user information.

```json
{
    "data": {
        "type": "oauth-access-tokens",
        "id": "23e7e284c25711541b395127883b7e132312321321250d619016b41fa84aa646aa3d96ebd6d0fc0",
        "attributes": {
            "token": "BEARER TOKEN",
            "expires_at": "2024-12-23 10:55:18",
            "2fa_granted": 0,
            "isNewAcc": false
        },
        "relationships": {
            "user": {
                "data": {
                    "type": "users",
                    "id": "D4057000-0000-G000-Y0009BC6"
                }
            }
        }
    }
}

```

--------------------------------

### Get Proxy Bindings

Source: https://docs.proxiedmail.com/docs/category/http-endpoints

Retrieves a list of configured proxy bindings. This endpoint allows users to view existing proxy configurations.

```APIDOC
## GET /api/v1/proxy-bindings

### Description
Retrieves a list of proxy bindings.

### Method
GET

### Endpoint
/api/v1/proxy-bindings
```

--------------------------------

### cURL Authentication Request

Source: https://docs.proxiedmail.com/docs/endpoints/login

A cURL command to perform authentication. This example demonstrates how to send the JSON payload and headers.

```bash
curl --location --request POST 'https://proxiedmail.com/api/v1/auth' \
--header 'content-type: application/json' \
--header 'Accept: application/json' \
--data-raw '{"data":{"type":"auth-request","attributes":{"username":"ya@pxdmail.net","password":"1"}}}'

```

--------------------------------

### Get All Proxy Bindings

Source: https://docs.proxiedmail.com/docs/endpoints/getproxybindings

Fetches a list of all proxy bindings. Each binding represents a proxy email address and its configuration for forwarding emails to real addresses. The response includes metadata about usage and availability.

```APIDOC
## GET /api/v1/proxy-bindings

### Description
Retrieves a list of all proxy bindings. Each binding represents a proxy email address and its configuration for forwarding emails to real addresses. The response includes metadata about usage and availability.

### Method
GET

### Endpoint
https://proxiedmail.com/api/v1/proxy-bindings

### Parameters
#### Query Parameters
None

#### Headers
- **accept**: application/json
- **content-type**: application/json
- **Token**: Auth_TOKEN

### Response
#### Success Response (200)
- **meta** (object) - Contains metadata about used and available proxy bindings, and verification email status.
  - **usedProxyBindings** (integer) - The number of proxy bindings currently in use.
  - **availableProxyBindings** (integer) - The total number of available proxy bindings.
  - **isVerificationEmailSend** (boolean) - Indicates if a verification email has been sent.
- **data** (array) - A list of proxy binding objects.
  - **type** (string) - The type of the resource, always "proxy_bindings".
  - **id** (string) - The unique identifier for the proxy binding.
  - **attributes** (object) - Contains the main attributes of the proxy binding.
    - **real_addresses** (object) - An object mapping real email addresses to their settings.
      - **[email protected]** (object) - Settings for a specific real email address.
        - **is_enabled** (boolean) - Whether the forwarding to this real address is enabled.
        - **is_verification_needed** (boolean) - Whether verification is needed for this real address.
        - **is_verified** (boolean) - Whether this real address has been verified.
    - **proxy_address** (string) - The proxy email address.
    - **received_emails** (integer) - The number of emails received by this proxy address.
    - **description** (string) - A user-defined description for the proxy binding.
    - **callback_url** (string) - The URL to send callbacks to when new emails are received (if set).
    - **created_at** (string) - The timestamp when the proxy binding was created.
    - **updated_at** (string) - The timestamp when the proxy binding was last updated.
  - **relationships** (object) - Contains information about related resources.
    - **user** (object) - Information about the user associated with this binding.
      - **data** (object)
        - **type** (string) - The type of the related resource, always "users".
        - **id** (string) - The ID of the associated user.

#### Response Example
```json
{
    "meta": {
        "usedProxyBindings": 1,
        "availableProxyBindings": 10,
        "isVerificationEmailSend": false
    },
    "data": [
        {
            "type": "proxy_bindings",
            "id": "C6C4C547-6000-0000-00000BAE",
            "attributes": {
                "real_addresses": {
                    "kkkchinazes@pxdmail.int": {
                        "is_enabled": true,
                        "is_verification_needed": false,
                        "is_verified": false
                    }
                },
                "proxy_address": "v7do1zfs8w@proxiedmail.com",
                "received_emails": 0,
                "description": "",
                "callback_url": "",
                "created_at": "2023-12-23 12:56:32",
                "updated_at": "2023-12-23 12:56:32"
            },
            "relationships": {
                "user": {
                    "data": {
                        "type": "users",
                        "id": "A2F49023-0000-0000-00009BC6"
                    }
                }
            }
        }
    ]
}
```
```

--------------------------------

### GET /api/v1/api-token

Source: https://docs.proxiedmail.com/docs/endpoints/apitoken

Obtain an API token after authentication. This can also be done via the settings page.

```APIDOC
## GET /api/v1/api-token

### Description
Obtain an API token after authentication. This can also be done via the settings page.

### Method
GET

### Endpoint
https://proxiedmail.com/api/v1/api-token

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```curl
curl --location --request GET 'https://proxiedmail.com/api/v1/api-token' \
--header 'accept: application/json' \
--header 'authorization: Bearer TOKEN'
```

### Response
#### Success Response (200)
- **token** (string) - The obtained API token.

#### Response Example
```json
{
    "token": "a098ea9a8d23TOKENTOKEN066e23d6222"
}
```
```

--------------------------------

### Authentication Error Response (401)

Source: https://docs.proxiedmail.com/docs/endpoints/login

Example of an error response when authentication fails due to incorrect user credentials. This response includes details about the exception.

```json
{
   "data":{
      "id":"6586bb110fe0f",
      "type":"errors",
      "attributes":{
         "message":"User or password not exists",
         "exception":"Modules\\Auth\\Exceptions\\WrongUserOrPasswordException",
         "file":"/app/Modules/Auth/Services/Auth/Authenticator.php",
         "line":79
      }
   }
}

```

--------------------------------

### GET /api/v1/proxy-bindings

Source: https://docs.proxiedmail.com/docs/endpoints/getProxyBindings

Fetches a list of proxy bindings. Each binding represents a proxy email address and its configuration for forwarding emails to one or more real email addresses. The response includes metadata about usage and availability of proxy bindings.

```APIDOC
## GET /api/v1/proxy-bindings

### Description
Retrieves a list of all proxy bindings. Each proxy binding represents a unique proxy email address and its associated forwarding rules to real email addresses. This endpoint provides information on the number of used and available proxy bindings.

### Method
GET

### Endpoint
https://proxiedmail.com/api/v1/proxy-bindings

### Parameters
#### Query Parameters
None

#### Headers
- **accept**: application/json
- **content-type**: application/json
- **Token**: Auth_TOKEN (Required)

### Response
#### Success Response (200)
- **meta** (object) - Contains metadata about proxy binding usage.
  - **usedProxyBindings** (integer) - The number of proxy bindings currently in use.
  - **availableProxyBindings** (integer) - The total number of available proxy bindings.
  - **isVerificationEmailSend** (boolean) - Indicates if a verification email has been sent.
- **data** (array) - A list of proxy binding objects.
  - **type** (string) - The type of the resource, always "proxy_bindings".
  - **id** (string) - The unique identifier for the proxy binding.
  - **attributes** (object) - Contains the attributes of the proxy binding.
    - **real_addresses** (object) - An object mapping real email addresses to their settings.
      - **[email_address]** (object) - Settings for a specific real email address.
        - **is_enabled** (boolean) - Whether the forwarding to this real address is enabled.
        - **is_verification_needed** (boolean) - Whether verification is needed for this real address.
        - **is_verified** (boolean) - Whether this real address has been verified.
    - **proxy_address** (string) - The proxy email address.
    - **received_emails** (integer) - The number of emails received by this proxy address.
    - **description** (string) - A user-defined description for the proxy binding.
    - **callback_url** (string) - The URL to send callbacks to when new emails are received (if set).
    - **created_at** (string) - The timestamp when the proxy binding was created.
    - **updated_at** (string) - The timestamp when the proxy binding was last updated.
  - **relationships** (object) - Contains relationships to other resources.
    - **user** (object) - Information about the user associated with this binding.
      - **data** (object)
        - **type** (string) - The type of the related resource, always "users".
        - **id** (string) - The ID of the associated user.

#### Response Example
```json
{
    "meta": {
        "usedProxyBindings": 1,
        "availableProxyBindings": 10,
        "isVerificationEmailSend": false
    },
    "data": [
        {
            "type": "proxy_bindings",
            "id": "C6C4C547-6000-0000-00000BAE",
            "attributes": {
                "real_addresses": {
                    "kkkchinazes@pxdmail.int": {
                        "is_enabled": true,
                        "is_verification_needed": false,
                        "is_verified": false
                    }
                },
                "proxy_address": "v7do1zfs8w@proxiedmail.com",
                "received_emails": 0,
                "description": "",
                "callback_url": "",
                "created_at": "2023-12-23 12:56:32",
                "updated_at": "2023-12-23 12:56:32"
            },
            "relationships": {
                "user": {
                    "data": {
                        "type": "users",
                        "id": "A2F49023-0000-0000-00009BC6"
                    }
                }
            }
        }
    ]
}
```
```

--------------------------------

### Example of Proxy Email Domains

Source: https://docs.proxiedmail.com/docs/endpoints/postproxybindings

These domains can be used for proxy addresses if you wish to omit email delivery and only use webhooks.

```text
@int.proxiedmail.com
@proxiedmail-int.int

```

--------------------------------

### GET /api/v1/api-token

Source: https://docs.proxiedmail.com/docs/endpoints/apiToken

Obtain an API token after authentication. This endpoint can also be accessed via the settings page.

```APIDOC
## GET /api/v1/api-token

### Description
Use this endpoint to obtain an API token after authentication. As an alternative, you can use the API page token on the settings page to achieve the same result.

### Method
GET

### Endpoint
https://proxiedmail.com/api/v1/api-token

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl --location --request GET 'https://proxiedmail.com/api/v1/api-token' \
--header 'accept: application/json' \
--header 'authorization: Bearer TOKEN'
```

### Response
#### Success Response (200)
- **token** (string) - The obtained API token.

#### Response Example
```json
{
    "token": "a098ea9a8d23TOKENTOKEN066e23d6222"
}
```

### Errors
None explicitly documented.
```

--------------------------------

### GET /api/v1/callback/get/{hash}

Source: https://docs.proxiedmail.com/docs/webhooksCr/get

Fetches the callback status and payload associated with a unique hash. It returns different structures based on whether a callback has been received.

```APIDOC
## GET /api/v1/callback/get/{hash}

### Description
Retrieves the status and payload of a callback for a given hash. The response structure varies depending on whether a callback has been registered.

### Method
GET

### Endpoint
/api/v1/callback/get/{hash}

### Parameters
#### Path Parameters
- **hash** (string) - Required - The unique identifier for the callback.

#### Query Parameters
None

#### Request Body
None

### Request Example
```curl
curl --location --request GET 'https://proxiedmail.com/api/v1/callback/get/14431720055a1d06d59f7c8bf095ddc6' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Token: YOUR_AUTH_TOKEN'
```

### Response
#### Success Response (200)
- **status** (string) - The status of the operation, typically "ok".
- **payload** (object|null) - The callback data. This is a JSON object if the callback data is structured, otherwise it can be a string or null.
- **code** (string) - An internal code, typically "ok".
- **is_received** (boolean) - Indicates whether a callback has been received.
- **method** (string|null) - The HTTP method used for the callback, if received.

#### Response Example (Not Received)
```json
{
  "status": "ok",
  "payload": null,
  "code": "ok",
  "is_received": false,
  "method": null
}
```

#### Response Example (Received)
```json
{
    "status": "ok",
    "payload": {
        "data": {
            "type": "proxy_bindings",
            "attributes": {
                "real_addresses": [
                    "example@gmail.com"
                ],
                "proxy_address": "mafffaffddffawd1d1afff@proxiedmail.com"
            }
        }
    },
    "code": "ok",
    "is_received": true,
    "method": "POST"
}
```
```

--------------------------------

### Request API Token using cURL

Source: https://docs.proxiedmail.com/docs/endpoints/apitoken

Use this cURL command to make a GET request to the API token endpoint. Ensure you replace 'TOKEN' with your actual Bearer token for authentication.

```curl
curl --location --request GET 'https://proxiedmail.com/api/v1/api-token' \
--header 'accept: application/json' \
--header 'authorization: Bearer TOKEN'
```

--------------------------------

### GET /api/v1/callback/get/{hash}

Source: https://docs.proxiedmail.com/docs/webhookscr/get

Retrieves the status of a webhook callback. It can indicate whether a callback has been received and provide the payload if available. The payload format depends on whether it was originally JSON or a string.

```APIDOC
## GET /api/v1/callback/get/{hash}

### Description
Retrieves the status of a webhook callback for a given hash. This endpoint can be used to check if a callback has been received and to retrieve its associated data.

### Method
GET

### Endpoint
/api/v1/callback/get/{hash}

### Parameters
#### Path Parameters
- **hash** (string) - Required - The unique identifier for the callback.

#### Headers
- **accept**: application/json
- **content-type**: application/json
- **Token**: YOUR_AUTH_TOKEN

### Response
#### Success Response (200)
- **status** (string) - The status of the request, typically "ok".
- **payload** (object | string | null) - The data received in the callback. This will be a JSON object if the original callback data was JSON, otherwise a string. It will be null if no callback has been received.
- **code** (string) - A code indicating the result, typically "ok".
- **is_received** (boolean) - Indicates whether a callback has been received (true) or not (false).
- **method** (string | null) - The HTTP method used for the callback, if received. Null if not received.

#### Response Example (Not Received)
```json
{
  "status": "ok",
  "payload": null,
  "code": "ok",
  "is_received": false,
  "method": null
}
```

#### Response Example (Received)
```json
{
    "status": "ok",
    "payload": {
        "data": {
            "type": "proxy_bindings",
            "attributes": {
                "real_addresses": [
                    "example@gmail.com"
                ],
                "proxy_address": "mafffaffddffawd1d1afff@proxiedmail.com"
            }
        }
    },
    "code": "ok",
    "is_received": true,
    "method": "POST"
}
```
```

--------------------------------

### cURL Request to Get Received Email

Source: https://docs.proxiedmail.com/docs/endpoints/getReceivedEmails

Use this cURL command to make a GET request to retrieve the message payload of a specific received email. Ensure you replace '{receivedEmailId}' with the actual email ID and 'Auth_TOKEN' with your valid authentication token.

```curl
curl --location --request GET 'https://proxiedmail.com/api/v1/received-emails/{receivedEmailId}' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Token: Auth_TOKEN'

```

--------------------------------

### POST /api/v1/proxy-bindings

Source: https://docs.proxiedmail.com/docs/endpoints/postproxybindings

Creates a new proxy binding. This allows you to set up a proxy email address that forwards incoming emails to specified real email addresses. You can also configure whether the received emails are browsable via the API and set a callback URL for notifications.

```APIDOC
## POST /api/v1/proxy-bindings

### Description
Creates a new proxy binding, forwarding emails from a proxy address to real addresses. Supports configuring callback URLs and browsability of received emails via API.

### Method
POST

### Endpoint
https://proxiedmail.com/api/v1/proxy-bindings

### Parameters
#### Request Body
- **data** (object) - Required - The main payload object.
  - **type** (string) - Required - Must be "proxy_bindings".
  - **attributes** (object) - Required - Contains the attributes for the proxy binding.
    - **real_addresses** (array of strings) - Required - An array of real email addresses to forward emails to.
    - **proxy_address** (string) - Required - The proxy email address to be issued.
    - **callback_url** (string) - Optional - The URL to receive webhook notifications. Can be an empty string.
    - **is_browsable** (boolean) - Optional - If true, allows retrieval of received emails via API. Defaults to true if not specified.

### Request Example
```json
{
  "data": {
    "type": "proxy_bindings",
    "attributes": {
      "real_addresses": [
        "kkkchinazes@pxdmail.int"
      ],
      "proxy_address": "d0zjr5gnwi@proxiedmail.com",
      "callback_url": "",
      "is_browsable": true
    }
  }
}
```

### Response
#### Success Response (201)
- **meta** (object) - Metadata about the operation.
  - **isVerificationEmailSend** (boolean) - Indicates if a verification email was sent.
  - **firstProxyBinding** (boolean) - Indicates if this is the first proxy binding created.
- **data** (object) - The created proxy binding details.
  - **type** (string) - The type of the resource, "proxy_bindings".
  - **id** (string) - The unique identifier for the proxy binding.
  - **attributes** (object) - Attributes of the proxy binding.
    - **real_addresses** (object) - Details of the real addresses associated with the binding.
      - **email@example.com** (object) - Information for a specific real address.
        - **is_enabled** (boolean) - Whether the forwarding is enabled for this address.
        - **is_verified** (boolean) - Whether the address has been verified.
    - **type** (integer) - Type code for the binding.
    - **proxy_address** (string) - The issued proxy email address.
    - **received_emails** (integer) - The count of emails received by this proxy address.
    - **description** (string) - A description for the binding (optional).
    - **callback_url** (string) - The configured callback URL.
    - **created_at** (string) - Timestamp of creation.
    - **updated_at** (string) - Timestamp of the last update.
  - **relationships** (object) - Relationships to other resources.
    - **user** (object) - Information about the user associated with the binding.
      - **data** (object) - User data.
        - **type** (string) - The type of the related resource, "users".
        - **id** (string) - The ID of the user.

#### Response Example
```json
{
  "meta": {
    "isVerificationEmailSend": false,
    "firstProxyBinding": false
  },
  "data": {
    "type": "proxy_bindings",
    "id": "8BE3D44A-6000-0000-00000BAE",
    "attributes": {
      "real_addresses": {
        "bblabla@proxiedmail.int": {
          "is_enabled": true,
          "is_verified": false
        }
      },
      "type": 0,
      "proxy_address": "7uj7s9gbnp@proxiedmail.com",
      "received_emails": 0,
      "description": "",
      "callback_url": "",
      "created_at": "2024-01-08 00:08:22",
      "updated_at": "2024-01-08 00:08:22"
    },
    "relationships": {
      "user": {
        "data": {
          "type": "users",
          "id": "BE090B33-0000-0000-00009BC6"
        }
      }
    }
  }
}
```
```

--------------------------------

### cURL Request for Creating Proxy Binding

Source: https://docs.proxiedmail.com/docs/endpoints/postproxybindings

This cURL command demonstrates how to make a POST request to create a proxy binding, including necessary headers and the JSON payload.

```bash
curl --location --request POST 'https://proxiedmail.com/api/v1/proxy-bindings' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Token: Auth_TOKEN' \
--data-raw '{"data":{"type":"proxy_bindings","attributes":{"real_addresses":["kkkchinazes@pxdmail.int"],"proxy_address":"q1v9nj1gkw@proxiedmail.com", "is_browsable": "true"}}}'

```

--------------------------------

### Get Received Emails

Source: https://docs.proxiedmail.com/docs/category/http-endpoints

Retrieves a list of received emails. This endpoint allows users to access their received email data.

```APIDOC
## GET /api/v1/received-emails/-

### Description
Retrieves a list of received emails.

### Method
GET

### Endpoint
/api/v1/received-emails/-
```

--------------------------------

### Create Proxy Binding

Source: https://docs.proxiedmail.com/docs/category/http-endpoints

Creates a new proxy binding. This endpoint is used to establish new proxy configurations.

```APIDOC
## POST /api/v1/proxy-bindings

### Description
Creates a new proxy binding.

### Method
POST

### Endpoint
/api/v1/proxy-bindings
```

--------------------------------

### Get API Token

Source: https://docs.proxiedmail.com/docs/category/http-endpoints

Retrieves an API token. This endpoint is used to obtain authentication credentials for accessing other API resources.

```APIDOC
## GET /api/v1/api-token

### Description
Retrieves an API token for authentication.

### Method
GET

### Endpoint
/api/v1/api-token
```

--------------------------------

### POST /api/v1/callback

Source: https://docs.proxiedmail.com/docs/webhooksCr/create

Creates a new callback webhook. This endpoint allows you to set up a webhook to receive data. It returns URLs for sending data to and retrieving data from your webhook.

```APIDOC
## POST /api/v1/callback

### Description
Creates a new callback webhook. This endpoint allows you to set up a webhook to receive data. It returns URLs for sending data to and retrieving data from your webhook.

### Method
POST

### Endpoint
https://proxiedmail.com/api/v1/callback

### Request Body
This endpoint does not explicitly define a request body in the provided documentation, but the cURL example suggests sending an empty JSON object or relevant headers.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **status** (string) - Always "ok".
- **call_url** (string) - URL to call to send data to your webhook.
- **get_url** (string) - URL to call to get data from your webhook.
- **id** (string) - The unique identifier for the callback.

#### Response Example
```json
{
  "status": "ok",
  "call_url": "https://proxiedmail.com/api/v1/callback/call/27c4f31ebcb6307e8daa68f681f84161",
  "get_url": "https://proxiedmail.com/api/v1/callback/get/27c4f31ebcb6307e8daa68f681f84161",
  "id": "27c4f31ebcb6307e8daa68f681f84161"
}
```
```

--------------------------------

### Get Received Emails Links

Source: https://docs.proxiedmail.com/docs/category/http-endpoints

Retrieves links related to received emails. This endpoint provides access to associated URLs for received emails.

```APIDOC
## GET /api/v1/received-emails-links/-

### Description
Retrieves links for received emails.

### Method
GET

### Endpoint
/api/v1/received-emails-links/-
```
Tokens:
Raw