Mailinator

https://www.mailinator.com/docs/
Admin
Mailinator is an email system that provides instant access to millions of email addresses for system...
Tokens:40,528
Snippets:154
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Mailinator Rules Schema Example

Source: https://www.mailinator.com/docs/index

An example JSON object demonstrating the structure of a Mailinator rule. It includes conditions and actions to process incoming messages.

```json
{
   "_id": "5c9602f5e881b5fbe91c754a",
   "description": "Rule to post all incoming mail starting with test* to my webhook",
   "enabled": true,
   "name": "testprefixpost",
   "conditions": [
      {
        "operation": "PREFIX",
        "field": "to",
        "value": "test"
      }
   ],
   "actions": [
      {
        "action" : "WEBHOOK",
        "destination": "my_webhook1"
      }
   ]
}
```

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

### Get All Rules - Mailinator API

Source: https://www.mailinator.com/docs/index

This snippet demonstrates how to fetch all rules associated with a specific domain using the Mailinator API. It includes examples for cURL and client libraries in JavaScript, Java, Go, Ruby, and Python.

```curl
curl "https://api.mailinator.com/api/v2/domains/:domain_id/rules/"
```

```javascript
mailinatorClient.request(new GetRulesRequest("domain_id"))
        .then(r => {
            const result = r.result;
            const rules = result?.rules;
            // ...
        });
```

```java
GetAllRulesRequest getAllRulesRequest = new GetAllRulesRequest() 
    { 
        DomainId = "yourDomainIdHere"
    };
    GetAllRulesResponse getAllRulesResponse = await mailinatorClient.RulesClient.GetAllRulesAsync(getAllRulesRequest);
```

```go
res, err := mailinatorClient.GetAllRules(&GetAllRulesOptions{"yourDomainIdHere"})
```

```python
response = mailinatorClient.rules.get_all_rules(domainId:"yourDomainIdHere")
```

```ruby
rules = self.mailinator.request( GetRulesRequest(DOMAIN) )
```

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

### Get All Domains

Source: https://www.mailinator.com/docs/index

Retrieves a list of all domains associated with the account.

```APIDOC
## GET /domains/

### Description
Fetches a list of all your domains.

### Method
GET

### Endpoint
https://api.mailinator.com/domains/

### Parameters
#### Query Parameters
None

### Request Example
```bash
curl "https://api.mailinator.com/domains/"
```

### Response
#### Success Response (200)
- **domains** (array) - List of domain objects.
  - **_id** (string) - Unique ID of the domain.
  - **description** (string) - Description of the domain.
  - **enabled** (boolean) - Indicates if the domain is enabled.
  - **name** (string) - Name of the domain.
  - **ownerid** (string) - ID of the domain owner.
  - **rules** (array) - List of rules associated with the domain.

#### Response Example
```json
{
  "domains" :
     [
         {
           "_id": "5c9602f5e881b5fbe91c754a",
           "description": "Domain representing some testing",
           "enabled": true,
           "name": "my.test.domain",
           "ownerid": "59188558619b4f3879751781",
           "rules": []
         }
       ]
}
```
```

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

### Mailinator Client Initialization

Source: https://www.mailinator.com/docs/index

Provides examples of initializing the Mailinator client in various programming languages using an API token. This is the first step to interacting with the Mailinator API programmatically.

```java
MailinatorClient mailinatorClient = new MailinatorClient("YourTeamAPIToken");
```

```javascript
const mailinatorClient = new MailinatorClient("YourTeamAPIToken");
```

```csharp
MailinatorClient mailinatorClient = new MailinatorClient("YourTeamAPIToken");
```

```go
mailinatorClient := mailinator.NewMailinatorClient("YourTeamAPIToken")
```

```ruby
mailinatorClient = MailinatorClient::Client.new(auth_token: "YourTeamAPIToken")
```

```python
mailinatorClient = Mailinator("API_TOKEN")
```

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

### Create Rule using Go

Source: https://www.mailinator.com/docs/index

This Go code example shows how to define and create a rule with prefix conditions and webhook actions using the Mailinator client. It details the structure for RuleToCreate and related objects.

```go
rule := RuleToCreate{
    Name:        "RuleName",
    Priority:    15,
    Description: "Description",
    Conditions: []Condition{
        Condition{
            Operation: OperationType("PREFIX"),
            ConditionData: ConditionData{
                Field: "to",
                Value: "raul",
            },
        },
    },
    Enabled: true,
    Match:   MatchType("ANY"),
    Actions: []ActionRule{
        ActionRule{
            Action: ActionType("WEBHOOK"),
            ActionData: ActionData{
                Url: "https://www.google.com",
            },
        },
    },
}

res, err := mailinatorClient.CreateRule(&CreateRuleOptions{"yourDomainIdHere", rule})
```

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

### Get Domain

Source: https://www.mailinator.com/docs/index

Fetches details for a specific domain.

```APIDOC
## GET /domains/:domain_id

### Description
Fetches details for a specific domain.

### Method
GET

### Endpoint
https://api.mailinator.com/domains/:domain_id

### Parameters
#### Path Parameters
- **domain_id** (string) - Required - This must be the Domain name or the Domain ID.

### Request Example
```bash
curl "https://api.mailinator.com/api/v2/domains/:domain_id"
```

### Response
#### Success Response (200)
- **_id** (string) - Unique ID of the domain.
- **description** (string) - Description of the domain.
- **enabled** (boolean) - Indicates if the domain is enabled.
- **name** (string) - Name of the domain.
- **ownerid** (string) - ID of the domain owner.
- **rules** (array) - List of rules associated with the domain.

#### Response Example
```json
{
   "_id": "5c9602f5e881b5fbe91c754a",
   "description": "Domain representing some testing",
   "enabled": true,
   "name": "my.test.domain.com",
   "ownerid": "59188558619b4f3879751781",
   "rules": []
}
```
```

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

### Create Rule using JavaScript

Source: https://www.mailinator.com/docs/index

This JavaScript example demonstrates creating a rule with webhook actions and prefix conditions using the Mailinator client library. It includes setting up conditions, actions, and making the API request.

```javascript
const actionData = new ActionData();
actionData.url = "https://www.mywebsite.com/restendpoint";
const action = new Action();
action.action = ActionType.WEBHOOK;
action.action_data = actionData;

const condition = new Condition();
condition.operation = OperationType.EQUALS;
condition.value = "raul";

const ruleToCreate = new RuleToCreate();
ruleToCreate.name = 'rule name';
ruleToCreate.priority = 15;
ruleToCreate.conditions = [condition];
ruleToCreate.actions = [action];
mailinatorClient.request(new CreateRuleRequest("domain_id", ruleToCreate))
    .then(r => {
        const rule = r.result;
        const name = rule?.name;
        // ...
    });
```

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

### Create Rule using Ruby

Source: https://www.mailinator.com/docs/index

This Ruby example shows how to create a rule with prefix conditions and drop actions using the Mailinator client. It defines the structure for conditions, actions, and the rule itself before making the API request.

```ruby
conditions = [Condition.new(operation: Condition::OperationType::PREFIX, field: "to", value: "test")]
actions = [Action.new(action: Action::ActionType::DROP, action_data: Action::ActionData.new("https://www.mywebsite.com/restendpoint"))]
rule = Rule.new(description: "mydescription", enabled: true, name: "MyName", conditions: conditions, actions: actions)

rule = self.mailinator.request( CreateRuleRequest::DOMAIN, rule )
```

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

### Get Usage Statistics

Source: https://www.mailinator.com/docs/index

Fetches usage statistics and a list of all domains associated with the account.

```APIDOC
## GET /api/v2/team/stats

### Description
Fetches usage statistics and a list of all domains associated with the account.

### Method
GET

### Endpoint
https://api.mailinator.com/api/v2/team/stats

### Parameters
#### Query Parameters
None

### Request Example
```bash
curl "https://api.mailinator.com/api/v2/team/stats"
```

### Response
#### Success Response (200)
- **domains** (array) - List of domain objects.
  - **_id** (string) - Unique ID of the domain.
  - **description** (string) - Description of the domain.
  - **enabled** (boolean) - Indicates if the domain is enabled.
  - **name** (string) - Name of the domain.
  - **ownerid** (string) - ID of the domain owner.
  - **rules** (array) - List of rules associated with the domain.

#### Response Example
```json
{
  "domains" :
     [
         {
           "_id": "5c9602f5e881b5fbe91c754a",
           "description": "Domain representing some testing",
           "enabled": true,
           "name": "my.test.domain",
           "ownerid": "59188558619b4f3879751781",
           "rules": []
         }
       ]
}
```
```

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

### Get All Rules

Source: https://www.mailinator.com/docs/index

Fetches all rules associated with a specific domain in Mailinator.

```APIDOC
## GET /api/v2/domains/:domain_id/rules/

### Description
This endpoint fetches all Rules for a Domain.

### Method
GET

### Endpoint
/api/v2/domains/:domain_id/rules/

### Parameters
#### Path Parameters
- **domain_id** (string) - Required - This must be the Domain name or the Domain id

### Response
#### Success Response (200)
- **rules** (array) - An array of rule objects.
  - **_id** (string) - The unique identifier for the rule.
  - **description** (string) - A description of the rule.
  - **enabled** (boolean) - Indicates if the rule is enabled.
  - **match** (string) - The matching condition for the rule (e.g., "ANY").
  - **name** (string) - The name of the rule.
  - **conditions** (array) - An array of conditions for the rule.
    - **operation** (string) - The operation type for the condition (e.g., "EQUALS").
    - **condition_data** (object) - Data for the condition.
      - **field** (string) - The field to apply the condition to (e.g., "to").
      - **value** (string) - The value to match against.
  - **actions** (array) - An array of actions to perform when the rule matches.
    - **action** (string) - The type of action (e.g., "WEBHOOK", "DROP").
    - **action_data** (object) - Data for the action (e.g., URL for WEBHOOK).
      - **url** (string) - The URL for the webhook.

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

### Response Example
```json
{
   "rules" : [
      {
         "_id": "5c9602f5e881b5fbe91c754a",
         "description": "Rule to post all incoming mail to test1 or test2, then drop the email",
         "enabled": true,
         "match" : "ANY",
         "name": "testprefixpost",
         "conditions": [
           {
             "operation": "EQUALS",
             "condition_data": {
               "field": "to",
               "value": "test1"
               }
           },
           {
             "operation": "EQUALS",
             "condition_data": {
               "field": "to",
               "value": "test2"
               }
           }
         ],
         "actions" : [
           {
             "action" : "WEBHOOK",
             "action_data": {
                "url" : "https://www.mywebsite.com/restendpoint"
             }
           },
           {
             "action" : "DROP"
           }
         ]
      }
   ]
}
```
```

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

### GET /api/v2/domains/{domain}/rules/

Source: https://context7.com/context7/mailinator/llms.txt

Retrieves a list of all rules for a specified domain.

```APIDOC
## GET /api/v2/domains/{domain}/rules/

### Description
List all routing rules for a specific domain.

### Method
GET

### Endpoint
/api/v2/domains/{domain}/rules/

### Parameters
#### Path Parameters
- **domain** (string) - Required - The domain for which to retrieve rules.

### Request Example
```bash
curl "https://api.mailinator.com/api/v2/domains/mycompany.testinator.com/rules/"
  -H "Authorization: YourTeamAPIToken"
```

### Response
#### Success Response (200)
- **rules** (array) - A list of rule objects.
  - **_id** (string) - The unique identifier of the rule.
  - **name** (string) - The name of the rule.
  - **enabled** (boolean) - Whether the rule is enabled.
  - **priority** (integer) - The priority of the rule.

#### Response Example
```json
{
  "rules": [
    {
      "_id": "5d7890abc123def456789012",
      "name": "forward_test_emails",
      "enabled": true,
      "priority": 10
    },
    {
      "_id": "5d7890abc123def456789013",
      "name": "drop_spam",
      "enabled": true,
      "priority": 1
    }
  ]
}
```
```

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

### Get Mailinator Domains (Go)

Source: https://www.mailinator.com/docs/index

Fetches all domains from your Mailinator account using the Go client. It returns the response and any potential errors.

```go
res, err := mailinatorClient.GetDomains()
```

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

### Create Mailinator Routing Rule

Source: https://context7.com/context7/mailinator/llms.txt

Illustrates how to create routing rules for your Mailinator domains using JSON payloads. Examples cover setting up a rule to webhook all emails with a 'test*' prefix and creating a rule with multiple conditions to route priority user emails. These operations require POST requests with appropriate JSON data and authorization.

```bash
# Create rule to webhook all test* emails
curl -X POST "https://api.mailinator.com/api/v2/domains/mycompany.testinator.com/rules/" \
  -H "Content-Type: application/json" \
  -H "Authorization: YourTeamAPIToken" \
  -d '{
    "name": "forward_test_emails",
    "description": "Forward all test emails to CI/CD webhook",
    "enabled": true,
    "priority": 10,
    "match": "ALL",
    "conditions": [
      {
        "operation": "PREFIX",
        "condition_data": {
          "field": "to",
          "value": "test"
        }
      }
    ],
    "actions": [
      {
        "action": "WEBHOOK",
        "action_data": {
          "url": "https://ci.mycompany.com/webhook/mailinator"
        }
      }
    ] 
  }'
```

```bash
# Create rule with multiple conditions
curl -X POST "https://api.mailinator.com/api/v2/domains/private/rules/" \
  -H "Content-Type: application/json" \
  -H "Authorization: YourTeamAPIToken" \
  -d '{
    "name": "route_priority_users",
    "description": "Route priority user emails to dedicated webhook",
    "enabled": true,
    "priority": 5,
    "match": "ANY",
    "conditions": [
      {
        "operation": "EQUALS",
        "condition_data": {"field": "to", "value": "admin"}
      },
      {
        "operation": "EQUALS",
        "condition_data": {"field": "to", "value": "support"}
      },
      {
        "operation": "EQUALS",
        "condition_data": {"field": "to", "value": "urgent"}
      }
    ],
    "actions": [
      {
        "action": "WEBHOOK",
        "action_data": {
          "url": "https://alerts.mycompany.com/priority-inbox"
        }
      }
    ]
  }'
```

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

### Mailinator API Operations (Java)

Source: https://context7.com/context7/mailinator/llms.txt

Provides Java code examples for interacting with the Mailinator API. Covers fetching inbox details, retrieving messages and their parts, accessing attachments, deleting messages from an inbox, and injecting new messages. Requires a MailinatorClient instance configured with an API token.

```java
// Fetch inbox
Inbox inbox = client.request(new GetInboxRequest("private", "testinbox"));
for (Message m : inbox.getMsgs()) {
    System.out.println(m.getSubject() + " from " + m.getFrom());
}

// Fetch message with parts
Message message = client.request(
    new GetMessageRequest("private", "testinbox", "testinbox-1570635306-12914603")
);
List<Part> parts = message.getParts();
String subject = message.getSubject();
Map<String, Object> headers = message.getHeaders();

// Fetch attachments
List<Attachment> attachments = client.request(
    new GetAttachmentsRequest("private", "testinbox", messageId)
);
for (Attachment att : attachments) {
    System.out.println("Filename: " + att.getFilename());
}

// Download attachment
Attachment attachment = client.request(
    new GetAttachmentRequest("private", "testinbox", messageId, 0)
);

// Delete messages
DeletedMessages result = client.request(
    new DeleteInboxMessagesRequest("private", "testinbox")
);
System.out.println(result.getCount() + " messages deleted");

// Inject message
MessageToPost msgToPost = new MessageToPost("Subject", "from@example.com", "Body text");
client.request(new PostMessageRequest("private", "testinbox", msgToPost));
```

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

### Get Specific Rule - Mailinator API

Source: https://www.mailinator.com/docs/index

This snippet shows how to retrieve a single rule for a given domain and rule ID using the Mailinator API. Examples are provided for cURL and client libraries in JavaScript, Java, Go, Python, and Ruby.

```curl
curl "https://mailinator.com/api/v2/domains/:domain_id/rules/:rule_id"
```

```javascript
mailinatorClient.request(new GetRuleRequest("domain_id", "rule_id"))
        .then(r => {
            const result = r.result;
            const name = result?.name;
            // ...
        });
```

```java
GetRuleRequest getRuleRequest = new GetRuleRequest() 
    { 
        DomainId = "yourDomainIdHere", 
        RuleId = "yourRuleIdHere"
    };
    GetRuleResponse getRuleResponse = await mailinatorClient.RulesClient.GetRuleAsync(getRuleRequest);
```

```go
res, err := mailinatorClient.GetRule(&GetRuleOptions{"yourDomainIdHere", "yourRuleIdHere"})
```

```python
response = mailinatorClient.rules.get_rule(domainId:"yourDomainIdHere", ruleId: "yourRuleIdHere")
```

```ruby
rule = self.mailinator.request( GetRuleRequest(DOMAIN, rule_id) )
```

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

### Fetch Message using Go (Mailinator Client)

Source: https://www.mailinator.com/docs/index

This Go code snippet demonstrates fetching a message using the Mailinator client library. It shows how to use FetchMessage with FetchMessageOptions.

```go
res, err := mailinatorClient.FetchMessage(&FetchMessageOptions{"yourDomainNameHere", "yourInboxHere", "yourMessageIdHere"})
```

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

### Fetch Inbox Summaries with Go Client

Source: https://www.mailinator.com/docs/index

This Go code snippet shows how to fetch inbox messages using the Mailinator client library. It demonstrates passing `FetchInboxOptions` with the domain and inbox names to the `FetchInbox` method and handling potential errors.

```go
res, err := mailinatorClient.FetchInbox(&FetchInboxOptions{Domain: "yourDomainNameHere", Inbox: "yourInboxHere"})
```

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

### Get Team Stats using cURL

Source: https://www.mailinator.com/docs/index

This snippet shows how to retrieve team usage statistics using cURL. It makes a GET request to the team stats endpoint. The response is a JSON object containing daily usage data for retrieved and sent messages.

```bash
curl "https://api.mailinator.com/api/v2/team/stats"

Response:
{
     "stats": [
           {
             "date": "20200921",
             "retrieved": {
                "web_private": 1029,
                "web_public": 0,
                "api_email": 983,
                "api_error": 1,
              },
              "sent": {
                "sms": 0,
                "email": 1990
              }
           },
           {
             "date": "20200922",
             "retrieved": {
                "web_private": 829,
                "web_public": 2,
                "api_email": 800,
                "api_error": 0,
              },
              "sent": {
                "sms": 3,
                "email": 1402
              }
           }
      ]
}

```

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

### Get Rule

Source: https://www.mailinator.com/docs/index

Fetches a specific rule for a given domain in Mailinator.

```APIDOC
## GET /api/v2/domains/:domain_id/rules/:rule_id

### Description
This endpoint fetches a Rule for a Domain.

### Method
GET

### Endpoint
/api/v2/domains/:domain_id/rules/:rule_id

### Parameters
#### Path Parameters
- **domain_id** (string) - Required - This must be the Domain name or the Domain id
- **rule_id** (string) - Required - This must be the rule name or the Rule id

### Response
#### Success Response (200)
- **_id** (string) - The unique identifier for the rule.
- **description** (string) - A description of the rule.
- **enabled** (boolean) - Indicates if the rule is enabled.
- **match** (string) - The matching condition for the rule (e.g., "ANY").
- **name** (string) - The name of the rule.
- **conditions** (array) - An array of conditions for the rule.
  - **operation** (string) - The operation type for the condition (e.g., "EQUALS").
  - **condition_data** (object) - Data for the condition.
    - **field** (string) - The field to apply the condition to (e.g., "to").
    - **value** (string) - The value to match against.
- **actions** (array) - An array of actions to perform when the rule matches.
  - **action** (string) - The type of action (e.g., "WEBHOOK", "DROP").
  - **action_data** (object) - Data for the action (e.g., URL for WEBHOOK).
    - **url** (string) - The URL for the webhook.

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

### Response Example
```json
{
   "_id": "5c9602f5e881b5fbe91c754a",
   "description": "Rule to post all incoming mail to test1 or test2, then drop the email",
   "enabled": true,
   "match" : "ANY",
   "name": "testprefixpost",
   "conditions": [
     {
      "operation": "EQUALS",
      "condition_data": {
        "field": "to",
        "value": "test1"
        }
     },
     {
      "operation": "EQUALS",
      "condition_data": {
        "field": "to",
        "value": "test2"
        }
     }
   ],
   "actions" : [
     {
       "action" : "WEBHOOK",
       "action_data": {
          "url" : "https://www.mywebsite.com/restendpoint"
       }
     },
     {
       "action" : "DROP"
     }
   ]
}
```
```

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

### Create Rule using Python

Source: https://www.mailinator.com/docs/index

This Python snippet demonstrates creating a rule with prefix conditions and webhook actions using the Mailinator client library. It shows how to structure the rule data for the API call.

```python
ruleToPost = {
    "name":        "RuleName",
    "priority":    15,
    "description": "Description",
    "conditions": [
      {
        "operation": "PREFIX",
        "condition_data": {
          "field": "to",
          "value": "raul"
        }
      }
    ],
    "enabled": true,
    "match":   "ANY",
    "actions": [
      {
        "action": "WEBHOOK",
        "action_data": {
          "url": "https://www.google.com"
        }
      }
    ]
  }

response = mailinatorClient.rules.create_rule(domainId:"yourDomainIdHere", ruleToPost: ruleToPost)
```

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

### Fetch Message using Ruby (Mailinator Client)

Source: https://www.mailinator.com/docs/index

This Ruby code snippet shows how to fetch a message using the Mailinator client library. It demonstrates the use of the messages.fetch_message method with named arguments.

```ruby
response = mailinatorClient.messages.fetch_message(domain:"yourDomainNameHere", inbox: "yourInboxHere", messageId: "yourMessageIdHere")
```

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

### Fetch Inbox Summaries with C# Client

Source: https://www.mailinator.com/docs/index

This C# code demonstrates how to fetch inbox messages asynchronously using the Mailinator client library. It shows the creation of a `FetchInboxRequest` object with specific parameters like Domain, Inbox, Skip, Limit, and Sort, and then asynchronously invoking the `FetchInboxAsync` method.

```csharp
FetchInboxRequest fetchInboxRequest = new FetchInboxRequest() 
{
    Domain = "yourDomainNameHere", 
    Inbox = "yourInboxHere", 
    Skip = 0, 
    Limit = 20, 
    Sort = Sort.asc 
};
FetchInboxResponse fetchInboxResponse = await mailinatorClient.MessagesClient.FetchInboxAsync(fetchInboxRequest);
```

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

### GET /api/v2/team/stats

Source: https://www.mailinator.com/docs/index

Retrieves usage statistics for your Mailinator Team. Provides insights into message retrieval and sending activities.

```APIDOC
## GET /api/v2/team/stats

### Description
Retrieves usage information for your Team, including message retrieval and sending statistics over different dates.

### Method
GET

### Endpoint
`https://api.mailinator.com/api/v2/team/stats`

### Parameters
This endpoint does not require any parameters.

### Request Example
```bash
curl "https://api.mailinator.com/api/v2/team/stats"
```

### Response
#### Success Response (200)
- **stats** (array) - An array of objects, where each object represents statistics for a specific date.
  - **date** (string) - The date for which the statistics are provided (e.g., "20200921").
  - **retrieved** (object) - Statistics on message retrieval.
    - **web_private** (integer) - Number of messages retrieved via the web interface from private inboxes.
    - **web_public** (integer) - Number of messages retrieved via the web interface from public inboxes.
    - **api_email** (integer) - Number of messages retrieved via the API using email.
    - **api_error** (integer) - Number of API errors encountered during retrieval.
  - **sent** (object) - Statistics on messages sent.
    - **sms** (integer) - Number of SMS messages sent.
    - **email** (integer) - Number of email messages sent.

#### Response Example
```json
{
     "stats": [
           {
             "date": "20200921",
             "retrieved": {
                "web_private": 1029,
                "web_public": 0,
                "api_email": 983,
                "api_error": 1
              },
              "sent": {
                "sms": 0,
                "email": 1990
              }
           },
           {
             "date": "20200922",
             "retrieved": {
                "web_private": 829,
                "web_public": 2,
                "api_email": 800,
                "api_error": 0
              },
              "sent": {
                "sms": 3,
                "email": 1402
              }
           }
      ]
}
```
```

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

### GET /api/v2/domains/{domain}/rules/{ruleId}

Source: https://context7.com/context7/mailinator/llms.txt

Retrieves the details of a specific routing rule.

```APIDOC
## GET /api/v2/domains/{domain}/rules/{ruleId}

### Description
Get specific details for a given routing rule.

### Method
GET

### Endpoint
/api/v2/domains/{domain}/rules/{ruleId}

### Parameters
#### Path Parameters
- **domain** (string) - Required - The domain of the rule.
- **ruleId** (string) - Required - The ID of the rule to retrieve.

### Request Example
```bash
curl "https://api.mailinator.com/api/v2/domains/mycompany.testinator.com/rules/5d7890abc123def456789012"
  -H "Authorization: YourTeamAPIToken"
```

### Response
#### Success Response (200)
This endpoint does not explicitly define a success response body in the provided documentation, but it is expected to return the details of the specified rule.
```

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

### Create Rule using C#

Source: https://www.mailinator.com/docs/index

This C# snippet illustrates how to create a rule with prefix conditions and webhook actions using the Mailinator client. It shows the structure for RuleToCreate, Condition, and Action objects.

```csharp
RuleToCreate ruleToCreate = new RuleToCreate()
      {
          Name = "RuleName",
          Priority = 15,
          Description = "Description",
          Conditions = new List<Condition>()
          {
              new Condition()
              {
                  Operation = OperationType.PREFIX,
                  ConditionData = new ConditionData()
                  {
                      Field = "to",
                      Value = "raul"
                  }
              }
          },
          Enabled = true,
          Match = MatchType.ANY,
          Actions = new List<ActionRule>() { new ActionRule() { Action = ActionType.WEBHOOK, ActionData = new ActionData() { Url = "https://www.google.com" } } }
      };
CreateRuleRequest createRuleRequest = new CreateRuleRequest() 
{
    DomainId = "yourDomainIdHere", 
    Rule = ruleToCreate 
};
CreateRuleResponse createRuleResponse = await mailinatorClient.RulesClient.CreateRuleAsync(createRuleRequest);
```

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

### Get Mailinator Domains (Python)

Source: https://www.mailinator.com/docs/index

Retrieves all domains from your Mailinator account using the Python client. The result is stored in the 'response' variable.

```python
response = mailinatorClient.domains.get_domains
```

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

### Fetch Links using Go

Source: https://www.mailinator.com/docs/index

This Go code snippet demonstrates fetching links from a Mailinator message using the Mailinator client library. It uses the FetchMessageLinks function with a FetchMessageLinksOptions struct containing domain, inbox, and message ID.

```go
res, err := mailinatorClient.FetchMessageLinks(&FetchMessageLinksOptions{"yourDomainNameHere", "yourInboxHere", "yourMessageIdHere"})
```

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

### Get Mailinator Domains (Java)

Source: https://www.mailinator.com/docs/index

Asynchronously retrieves all domains from your Mailinator account using the Java client. The result is a GetAllDomainsResponse object.

```java
GetAllDomainsResponse getAllDomainsResponse = await mailinatorClient.DomainsClient.GetAllDomainsAsync();
```

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

### Mailinator SDK Integration - JavaScript

Source: https://context7.com/context7/mailinator/llms.txt

This JavaScript code demonstrates integration with the Mailinator SDK. It shows how to initialize the client, fetch an inbox, retrieve and parse message details, delete messages from an inbox, and inject a new message. Requires the 'mailinator-client' package and an API token.

```javascript
const MailinatorClient = require('mailinator-client');
const client = new MailinatorClient('YourTeamAPIToken');

// Fetch inbox
const inbox = await client.request(
  new GetInboxRequest('private', 'testinbox', 0, 50, 'descending')
);
inbox.msgs.forEach(msg => {
  console.log(`${msg.subject} from ${msg.from}`);
});

// Fetch and parse message
const message = await client.request(
  new GetMessageRequest('private', 'testinbox', 'testinbox-1570635306-12914603')
);
console.log(message.subject);
message.parts.forEach(part => {
  if (part.headers['content-type'].includes('text/plain')) {
    console.log(part.body);
  }
});

// Delete messages
const result = await client.request(
  new DeleteInboxMessagesRequest('private', 'testinbox')
);
console.log(`Deleted ${result.count} messages`);

// Inject message
const msg = new MessageToPost('Test Subject', 'sender@example.com', 'Message body');
const response = await client.request(
  new PostMessageRequest('private', 'testinbox', msg)
);
console.log(`Message ID: ${response.id}`);
```

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

### Get Team Statistics

Source: https://context7.com/context7/mailinator/llms.txt

Retrieves usage statistics for your Mailinator subscription, including retrieved and sent message counts.

```APIDOC
## Get Team Statistics

### Description
Retrieve usage statistics for your subscription.

### Method
GET

### Endpoint
`/api/v2/team/stats`

### Parameters
No parameters are required for this endpoint.

### Request Example
```bash
curl "https://api.mailinator.com/api/v2/team/stats" \
  -H "Authorization: YourTeamAPIToken"
```

### Response
#### Success Response (200)
- **stats** (array) - An array of statistics objects, one for each date.
  - **date** (string) - The date for which the statistics are provided (YYYYMMDD format).
  - **retrieved** (object) - Statistics on messages retrieved.
    - **web_private** (integer) - Number of private messages retrieved via web.
    - **web_public** (integer) - Number of public messages retrieved via web.
    - **api_email** (integer) - Number of email messages retrieved via API.
    - **api_error** (integer) - Number of API errors encountered.
  - **sent** (object) - Statistics on messages sent.
    - **sms** (integer) - Number of SMS messages sent.
    - **email** (integer) - Number of email messages sent.

#### Response Example
```json
{
  "stats": [
    {
      "date": "20240115",
      "retrieved": {
        "web_private": 1029,
        "web_public": 0,
        "api_email": 983,
        "api_error": 1
      },
      "sent": {
        "sms": 5,
        "email": 1990
      }
    },
    {
      "date": "20240116",
      "retrieved": {
        "web_private": 829,
        "web_public": 2,
        "api_email": 800,
        "api_error": 0
      },
      "sent": {
        "sms": 3,
        "email": 1402
      }
    }
  ]
}
```
```

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

### Fetch Inbox Summaries with Python Client

Source: https://www.mailinator.com/docs/index

This Python code snippet illustrates fetching inbox messages using the Mailinator client library. It shows how to call the `fetch_inbox` method with parameters for domain, inbox, skip, limit, sort order, and subject decoding.

```python
response = mailinatorClient.messages.fetch_inbox(domain:"yourDomainNameHere", inbox: "yourInboxHere", skip: 0, limit: 50, sort: "ascending", decodeSubject: false)
```

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

### Get Specific Mailinator Domain (curl)

Source: https://www.mailinator.com/docs/index

Fetches details for a specific Mailinator domain using its ID. The response provides information about the requested domain.

```curl
curl "https://api.mailinator.com/api/v2/domains/:domain_id"
```

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

### GET /api/v2/domains/private/inboxes/{inbox}/messages/{message}/attachments/{attachmentId}

Source: https://context7.com/context7/mailinator/llms.txt

Retrieve a specific attachment from a message within a private inbox.

```APIDOC
## Get Attachment

### Description
Retrieves a specific attachment from a message within a private inbox.

### Method
GET

### Endpoint
`/api/v2/domains/private/inboxes/{inbox}/messages/{message}/attachments/{attachmentId}`

### Parameters
#### Path Parameters
- **inbox** (string) - Required - The name of the inbox.
- **message** (string) - Required - The ID of the message.
- **attachmentId** (string) - Required - The ID of the attachment.

#### Request Headers
- **Authorization** (string) - Required - Your Team API Token.

### Request Example
```bash
curl "https://mailinator.com/api/v2/domains/private/inboxes/testinbox/messages/testinbox-1570635306-12914603/attachments/0" \
  -H "Authorization: YourTeamAPIToken"
```

### Response
#### Success Response (200)
- The content of the attachment (e.g., PDF file).
```

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

### Manage Messages with Mailinator API (C#)

Source: https://context7.com/context7/mailinator/llms.txt

Demonstrates various message management operations using the Mailinator C# SDK. Includes fetching inbox messages, retrieving a specific message, accessing message links, downloading attachments, and deleting messages. Requires initializing the MailinatorClient with an API token.

```csharp
// Fetch inbox
var fetchInboxRequest = new FetchInboxRequest() {
    Domain = "private",
    Inbox = "testinbox",
    Limit = 50,
    Sort = Sort.descending
};
var inbox = await client.MessagesClient.FetchInboxAsync(fetchInboxRequest);
foreach (var msg in inbox.Msgs) {
    Console.WriteLine($"{msg.Subject} from {msg.From}");
}

// Fetch message
var fetchMessageRequest = new FetchMessageRequest() {
    Domain = "private",
    Inbox = "testinbox",
    MessageId = "testinbox-1570635306-12914603"
};
var message = await client.MessagesClient.FetchMessageAsync(fetchMessageRequest);
Console.WriteLine(message.Subject);

// Fetch links
var fetchLinksRequest = new FetchLinksRequest() {
    Domain = "private",
    Inbox = "testinbox",
    MessageId = messageId
};
var links = await client.MessagesClient.FetchLinksAsync(fetchLinksRequest);
foreach (var link in links.Links) {
    Console.WriteLine(link);
}

// Delete message
var deleteRequest = new DeleteMessageRequest() {
    Domain = "private",
    Inbox = "testinbox",
    MessageId = messageId
};
var result = await client.MessagesClient.DeleteMessageAsync(deleteRequest);
Console.WriteLine($"Deleted {result.MessagesDeleted} messages");
```

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

### Create Mailinator Rule

Source: https://www.mailinator.com/docs/index

This section details how to create a new rule in Mailinator. It requires a domain ID, a rule name, priority, conditions, and actions. Optional parameters include description and match type. The `name` must be 1-15 alphanumeric characters, dots, or underscores. Conditions and actions are complex objects.

```HTTP
POST https://api.mailinator.com/api/v2/domains/:domain_id/rules/
```

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

### Get Specific Mailinator Domain (Python)

Source: https://www.mailinator.com/docs/index

Fetches a specific Mailinator domain by its ID using the Python client. The domain ID is passed as a named argument.

```python
response = mailinatorClient.domains.get_domain(domainId:"yourDomainIdHere")
```

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

### Mailinator SDK Integration - Python

Source: https://context7.com/context7/mailinator/llms.txt

This Python code illustrates using the Mailinator SDK for common operations. It covers fetching an inbox and its messages, retrieving detailed message content, and extracting links from a message. The code requires the 'mailinator' library and an API token for authentication.

```python
from mailinator import Mailinator, GetInboxRequest, GetMessageRequest

mailinator = Mailinator('YourTeamAPIToken')

# Fetch inbox
inbox = mailinator.request(GetInboxRequest('private', 'testinbox'))
for msg in inbox['msgs']:
    print(f"{msg['subject']} from {msg['from']}")

# Fetch message
message = mailinator.request(
    GetMessageRequest('private', 'testinbox', 'testinbox-1570635306-12914603')
)
print(message['subject'])
for part in message['parts']:
    if 'text/plain' in part['headers'].get('content-type', ''):
        print(part['body'])

# Extract links
links = mailinator.request(
    GetMessageLinksRequest('private', 'testinbox', message_id)
)
for link in links['links']:
    print(link)
```

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

### Get Specific Mailinator Domain (JavaScript)

Source: https://www.mailinator.com/docs/index

Retrieves a specific Mailinator domain by its ID using the JavaScript client. It processes the response to extract the domain name.

```javascript
mailinatorClient.request(new GetDomainRequest("domain_id"))
    .then(r => {
        const domain = r.result;
        const name = domain?.name;
        // ...
    });
```

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

### Get Mailinator Domains (Python - alternative)

Source: https://www.mailinator.com/docs/index

Fetches all domains from your Mailinator account using a specific request object in Python. The result is stored in the 'domains' variable.

```python
domains = self.mailinator.request( GetDomainsRequest() )
```

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

### Fetch Message using Java (Mailinator Client)

Source: https://www.mailinator.com/docs/index

This Java code snippet illustrates how to fetch a message using the Mailinator client library. It shows how to retrieve message parts, subject, and headers.

```java
// Message m = mailinatorClient.request(
// new GetMessageRequest("<domain>", "<inbox-name>", "<msg-id>"));
    Message m = mailinatorClient.request(
      new GetMessageRequest("private", "testinbox", "testinbox-1570635306-12914603"));

   List<Parts> parts = m.getParts();
   String subject = m.getSubject();
   Map<String, Object> headers = m.getHeaders();
```

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

### Get Mailinator Domains (JavaScript)

Source: https://www.mailinator.com/docs/index

Retrieves a list of all domains associated with your Mailinator account using the JavaScript client. It processes the response to extract domain names.

```javascript
mailinatorClient.request(new GetDomainsRequest())
    .then(r => {
        const domains = r.result;
        domains?.domains.forEach((domain) => {
            const name = domain.name;
            // ...
        })
    });
```

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

### Fetch Inbox Summaries with Java Client

Source: https://www.mailinator.com/docs/index

This Java code snippet shows how to use the Mailinator client library to fetch inbox messages. It demonstrates creating a client, requesting inbox data, and iterating through the messages to access their subjects and parts.

```java
Inbox inbox = mailinatorClient.request(new GetInboxRequest("private"));
List<Message> messages = inbox.getMsgs();
for (Message m : messages) {
  String subject = m.getSubject();
  List<Part> parts = m.getParts();
  // process message
}
```

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

### Get Specific Mailinator Domain (Python - alternative)

Source: https://www.mailinator.com/docs/index

Retrieves a specific Mailinator domain using a GetDomainRequest object in Python. The domain ID or name is passed during instantiation.

```python
domain = self.mailinator.request( GetDomainRequest(DOMAIN) )
```

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

### Fetch Message using JavaScript (Mailinator Client)

Source: https://www.mailinator.com/docs/index

This JavaScript code demonstrates fetching a message using the Mailinator client library with Promises. It shows how to access message parts, subject, and headers from the response.

```javascript
mailinatorClient.request(new GetMessageRequest("<domain>", "<inbox-name>", "<msg-id>"))
            .then(response => {
                const result = response.result;
                const parts = result?.parts;
                const subject = result?.subject;
                const headers = result?.headers;
            });
```

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

### Get Specific Mailinator Domain (Go)

Source: https://www.mailinator.com/docs/index

Retrieves a specific Mailinator domain by its ID using the Go client. It requires a GetDomainOptions struct containing the domain ID.

```go
res, err := mailinatorClient.GetDomain(&GetDomainOptions{"yourDomainIdHere"})
```

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

### Fetch Message using cURL

Source: https://www.mailinator.com/docs/index

This snippet demonstrates how to fetch a specific message using the cURL command-line tool. It shows two URL variations for accessing messages.

```shell
curl "https://mailinator.com/api/v2/domains/private/messages/testinbox-1570635306-12914603"

or the longer form:

curl "https://mailinator.com/api/v2/domains/private/inboxes/testinbox/messages/testinbox-1570635306-12914603"
```

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

### Get Specific Mailinator Domain (Java)

Source: https://www.mailinator.com/docs/index

Asynchronously fetches a specific Mailinator domain using its ID via the Java client. It requires a GetDomainRequest object with the domain ID.

```java
GetDomainRequest getDomainRequest = new GetDomainRequest() 
    { 
        DomainId = "yourDomainIdHere" 
    };
GetDomainResponse getDomainResponse = await mailinatorClient.DomainsClient.GetDomainAsync(getDomainRequest);
```

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

### Get Mailinator Usage Statistics (curl)

Source: https://www.mailinator.com/docs/index

Fetches the usage statistics for your Mailinator account. This includes a list of your domains and their configurations. The response is a JSON object containing a 'domains' array.

```curl
curl "https://api.mailinator.com/api/v2/team/stats"
```
Tokens:
Raw