mailersend

Name	mailersend JSON
Version	0.5.6 JSON
	download
home_page
Summary	The official MailerSend Python SDK
upload_time	2023-09-13 12:50:50
maintainer
docs_url	None
author	Igor Hrček
requires_python	>=3.7,<4.0
license
keywords	mailersend mail
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <a href="https://www.mailersend.com"><img src="https://www.mailersend.com/images/logo.svg" width="200px"/></a>

MailerSend Python SDK

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)

# Table of Contents
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
  - [Requirements](#requirements)
  - [Authentication](#authentication)
- [Usage](#usage)
  - [Email](#email)
    - [Send an email](#send-an-email)
    - [Add CC, BCC recipients](#add-cc-bcc-recipients)
    - [Send a template-based email](#send-a-template-based-email)
    - [Advanced personalization](#advanced-personalization)
    - [Simple personalization](#simple-personalization)
    - [Send email with attachment](#send-email-with-attachment)
  - [Email Verification](#email-verification)
    - [Get all email verification lists](#get-all-email-verification-lists)
    - [Get a single email verification list](#get-a-single-email-verification-list)
    - [Create a email verification list](#create-a-email-verification-list)
    - [Verify a list](#verify-a-list)
    - [Get list results](#get-list-results)
  - [Bulk Email](#bulk-email)
    - [Send bulk email](#send-bulk-email)
    - [Get bulk email status](#get-bulk-email-status)
  - [Activity](#activity)
    - [Get a list of activities (simple)](#get-a-list-of-activities-simple)
    - [Get a list of activities (full)](#get-a-list-of-activities-full)
  - [Analytics](#analytics)
    - [Activity data by date](#activity-data-by-date)
    - [Opens by country](#opens-by-country)
    - [Opens by user-agent name](#opens-by-user-agent-name)
    - [Opens by reading environment](#opens-by-reading-environment)
  - [Inbound Routes](#inbound-routes)
    - [Get a list of inbound routes](#get-a-list-of-inbound-routes)
    - [Get a single inbound route](#get-a-single-inbound-route)
    - [Add an inbound route](#add-an-inbound-route)
    - [Update an inbound route](#update-an-inbound-route)
    - [Delete an inbound route](#delete-an-inbound-route)
  - [Domains](#domains)
    - [Get a list of domains](#get-a-list-of-domains)
    - [Get a single domain](#get-a-single-domain)
    - [Get a single domain using helper function](#get-a-single-domain-using-helper-function)
    - [Add a domain](#add-a-domain)
    - [Delete a domain](#delete-a-domain)
    - [Get a list of recipients per domain](#get-a-list-of-recipients-per-domain)
    - [Update domain settings](#update-domain-settings)
    - [Get DNS Records](#get-dns-records)
    - [Verify a domain](#verify-a-domain)
  - [Messages](#messages)
    - [Get a list of messages](#get-a-list-of-messages)
    - [Get a single message](#get-a-single-message)
  - [Scheduled messages](#scheduled-messages)
    - [Get a list of scheduled messages](#get-a-list-of-scheduled-messages)
    - [Get a single scheduled message](#get-a-single-scheduled-message)
    - [Delete a scheduled message](#delete-a-scheduled-message)
  - [Recipients](#recipients)
    - [Get a list of recipients](#get-a-list-of-recipients)
    - [Get a single recipient](#get-a-single-recipient)
    - [Delete a recipient](#delete-a-recipient)
    - [Get recipients from a blocklist](#get-recipients-from-a-blocklist)
    - [Get recipients from hard bounces](#get-recipients-from-hard-bounces)
    - [Get recipients from spam complaints](#get-recipients-from-spam-complaints)
    - [Get recipients from unsubscribes](#get-recipients-from-unsubscribes)
    - [Add recipients to blocklist](#add-recipients-to-blocklist)
    - [Add hard bounced recipients](#add-hard-bounced-recipients)
    - [Add spam complaints](#add-spam-complaints)
    - [Add recipients to unsubscribe list](#add-recipients-to-unsubscribe-list)
    - [Delete recipients from blocklist](#delete-recipients-from-blocklist)
    - [Delete hard bounced recipients](#delete-hard-bounced-recipients)
    - [Delete spam complaints](#delete-spam-complaints)
    - [Delete recipients from unsubscribe list](#delete-recipients-from-unsubscribe-list)
  - [Tokens](#tokens)
    - [Create a token](#create-a-token)
    - [Pause / Unpause Token](#pause--unpause-token)
    - [Delete a Token](#delete-a-token)
  - [Templates](#templates)
    - [Get a list of templates](#get-a-list-of-templates)
    - [Get a single template](#get-a-single-template)
    - [Delete template](#delete-template)
  - [Webhooks](#webhooks)
    - [Get a list of webhooks](#get-a-list-of-webhooks)
    - [Get a single webhook](#get-a-single-webhook)
    - [Create a Webhook](#create-a-webhook)
    - [Create a disabled webhook](#create-a-disabled-webhook)
    - [Update a Webhook](#update-a-webhook)
    - [Disable/Enable a Webhook](#disableenable-a-webhook)
    - [Delete a Webhook](#delete-a-webhook)
  - [SMS](#sms)
    - [Sending SMS messages](#sending-sms-messages)
  - [SMS Activity](#sms-activity)
    - [Get a list of activities](#get-a-list-of-activities)
    - [Get activity of a single message](#get-activity-of-a-single-message)
  - [SMS Phone Numbers](#sms-phone-numbers)
    - [Get a list of SMS phone numbers](#get-a-list-of-sms-phone-numbers)
    - [Get an SMS phone number](#get-an-sms-phone-number)
    - [Update a single SMS phone number](#update-a-single-sms-phone-number)
    - [Delete an SMS phone number](#delete-an-sms-phone-number)
  - [SMS Recipients](#sms-recipients)
    - [Get a list of SMS recipients](#get-a-list-of-sms-recipients)
    - [Get an SMS recipient](#get-an-sms-recipient)
    - [Update a single SMS recipient](#update-a-single-sms-recipient)
  - [SMS Messages](#sms-messages)
    - [Get a list of SMS messages](#get-a-list-of-sms-messages)
    - [Get an SMS message](#get-an-sms-message)
  - [SMS Webhooks](#sms-webhooks)
    - [Get a list of SMS webhooks](#get-a-list-of-sms-webhooks)
    - [Get a single SMS webhook](#get-a-single-sms-webhook)
    - [Create an SMS webhook](#create-an-sms-webhook)
    - [Update a single SMS webhook](#update-a-single-sms-webhook)
    - [Delete an SMS webhook](#delete-an-sms-webhook)
    - [Get a list of SMS webhooks](#get-a-list-of-sms-webhooks-1)
  - [SMS Inbouds](#sms-inbouds)
    - [Get a list of SMS inbound routes](#get-a-list-of-sms-inbound-routes)
    - [Get a single SMS inbound route](#get-a-single-sms-inbound-route)
    - [Create an SMS inbound route](#create-an-sms-inbound-route)
    - [Update an SMS inbound route](#update-an-sms-inbound-route)
    - [Delete an SMS inbound route](#delete-an-sms-inbound-route)
  - [Sender Identities](#sender-identities)
    - [Get a list of sender identities](#get-a-list-of-sender-identities)
    - [Get a sender identity](#get-a-sender-identity)
    - [Create a sender identity](#create-a-sender-identity)
    - [Update a sender identity](#update-a-sender-identity)
    - [Delete a sender identity](#delete-a-sender-identity)
  - [API Quota](#api-quota)
    - [Get API Quota](#get-api-quota)
- [Troubleshooting](#troubleshooting)
  - [Emails not being sent](#emails-not-being-sent)
- [Testing](#testing)
- [Available endpoints](#available-endpoints)
- [Support and Feedback](#support-and-feedback)
- [License](#license)

<a name="installation"></a>

# Installation

```
$ python -m pip install mailersend
```

## Requirements

- Python > 3.6.1
- Python `pip`
- An API Key from [mailersend.com](https://www.mailersend.com)

## Authentication

We recommend you to define `MAILERSEND_API_KEY` environment variable in the `.env` file, and use it to store the API key.

- Using environment variable
```python
from mailersend import emails

# assigning NewEmail() without params defaults to MAILERSEND_API_KEY env var
mailer = emails.NewEmail()

# define an empty dict to populate with mail values
mail_body = {}

mail_from = {
    "name": "Your Name",
    "email": "your@domain.com",
}

recipients = [
    {
        "name": "Your Client",
        "email": "your@client.com",
    }
]

reply_to = {
    "name": "Name",
    "email": "reply@domain.com",
}

mailer.set_mail_from(mail_from, mail_body)
mailer.set_mail_to(recipients, mail_body)
mailer.set_subject("Hello!", mail_body)
mailer.set_html_content("This is the HTML content", mail_body)
mailer.set_plaintext_content("This is the text content", mail_body)
mailer.set_reply_to(reply_to, mail_body)

# using print() will also return status code and data
mailer.send(mail_body)
```

- Explicit declaration
```python
from mailersend import emails

mailer = emails.NewEmail("my-api-key")

# define an empty dict to populate with mail values
mail_body = {}

mail_from = {
    "name": "Your Name",
    "email": "your@domain.com",
}

recipients = [
    {
        "name": "Your Client",
        "email": "your@client.com",
    }
]

reply_to = {
    "name": "Name",
    "email": "reply@domain.com",
}

mailer.set_mail_from(mail_from, mail_body)
mailer.set_mail_to(recipients, mail_body)
mailer.set_subject("Hello!", mail_body)
mailer.set_html_content("This is the HTML content", mail_body)
mailer.set_plaintext_content("This is the text content", mail_body)
mailer.set_reply_to(reply_to, mail_body)

# using print() will also return status code and data
mailer.send(mail_body)
```

# Usage

## Email

### Send an email

```python
from mailersend import emails
from dotenv import load_dotenv

load_dotenv()

mailer = emails.NewEmail(os.getenv('MAILERSEND_API_KEY'))

# define an empty dict to populate with mail values
mail_body = {}

mail_from = {
    "name": "Your Name",
    "email": "your@domain.com",
}

recipients = [
    {
        "name": "Your Client",
        "email": "your@client.com",
    }
]

reply_to = {
    "name": "Name",
    "email": "reply@domain.com",
}

mailer.set_mail_from(mail_from, mail_body)
mailer.set_mail_to(recipients, mail_body)
mailer.set_subject("Hello!", mail_body)
mailer.set_html_content("This is the HTML content", mail_body)
mailer.set_plaintext_content("This is the text content", mail_body)
mailer.set_reply_to(reply_to, mail_body)

# using print() will also return status code and data
mailer.send(mail_body)
```

### Add CC, BCC recipients

```python
from mailersend import emails
from dotenv import load_dotenv

load_dotenv()

mailer = emails.NewEmail(os.getenv('MAILERSEND_API_KEY'))

# define an empty dict to populate with mail values
mail_body = {}

mail_from = {
    "name": "Your Name",
    "email": "your@domain.com",
}

recipients = [
    {
        "name": "Your Client",
        "email": "your@client.com",
    }
]

cc = [
    {
        "name": "CC",
        "email": "cc@client.com"
    }
]

bcc = [
    {
        "name": "BCC",
        "email": "bcc@client.com"
    }
]

mailer.set_mail_from(mail_from, mail_body)
mailer.set_mail_to(recipients, mail_body)
mailer.set_subject("Hello!", mail_body)
mailer.set_html_content("This is the HTML content", mail_body)
mailer.set_plaintext_content("This is the text content", mail_body)
mailer.set_cc_recipients(cc, mail_body)
mailer.set_bcc_recipients(bcc, mail_body)

mailer.send(mail_body)
```

### Send a template-based email

```python
from mailersend import emails
from dotenv import load_dotenv

load_dotenv()

mailer = emails.NewEmail(os.getenv('MAILERSEND_API_KEY'))

# define an empty dict to populate with mail values
mail_body = {}

mail_from = {
    "name": "Your Name",
    "email": "your@domain.com",
}

recipients = [
    {
        "name": "Your Client",
        "email": "your@client.com",
    }
]


variables = [
    {
        "email": "your@client.com",
        "substitutions": [
            {
                "var": "foo",
                "value": "bar"
            },
        ]
    }
]


mailer.set_mail_from(mail_from, mail_body)
mailer.set_mail_to(recipients, mail_body)
mailer.set_subject("Hello from {$company}", mail_body)
mailer.set_template("templateID", mail_body)
mailer.set_simple_personalization(variables, mail_body)

mailer.send(mail_body)
```

### Advanced personalization

```python
from mailersend import emails
from dotenv import load_dotenv

load_dotenv()

mailer = emails.NewEmail(os.getenv('MAILERSEND_API_KEY'))

# define an empty dict to populate with mail values
mail_body = {}

mail_from = {
    "name": "Your Name",
    "email": "your@domain.com",
}

recipients = [
    {
        "name": "Your Client",
        "email": "your@client.com",
    }
]

personalization = [
    {
        "email": "test@mailersend.com",
        "data": {
            "var": "value",
            "boolean": True,
            "object": {
                "key" : "object-value"
            },
            "number": 2,
            "array": [
                1,
                2,
                3
            ]
        }
    }
]


mailer.set_mail_from(mail_from, mail_body)
mailer.set_mail_to(recipients, mail_body)
mailer.set_subject("Hello from {$company}", mail_body)
mailer.set_html_content("This is the HTML content, {$name}", mail_body)
mailer.set_plaintext_content("This is the text content, {$name}", mail_body)
mailer.set_advanced_personalization(personalization, mail_body)

mailer.send(mail_body)
```

### Simple personalization

```python
from mailersend import emails
from dotenv import load_dotenv

load_dotenv()

mailer = emails.NewEmail(os.getenv('MAILERSEND_API_KEY'))

# define an empty dict to populate with mail values
mail_body = {}

mail_from = {
    "name": "Your Name",
    "email": "your@domain.com",
}

recipients = [
    {
        "name": "Your Client",
        "email": "your@client.com",
    }
]

variables = [
    {
        "email": "your@client.com",
        "substitutions": [
            {
                "var": "foo",
                "value": "bar"
            },
        ]
    }
]


mailer.set_mail_from(mail_from, mail_body)
mailer.set_mail_to(recipients, mail_body)
mailer.set_subject("Hello from {$foo}", mail_body)
mailer.set_html_content("This is the HTML content, {$foo}", mail_body)
mailer.set_plaintext_content("This is the text content, {$foo}", mail_body)
mailer.set_simple_personalization(variables, mail_body)

mailer.send(mail_body)
```

### Send email with attachment

```python
from mailersend import emails
import base64
from dotenv import load_dotenv

load_dotenv()

mailer = emails.NewEmail(os.getenv('MAILERSEND_API_KEY'))

# define an empty dict to populate with mail values
mail_body = {}

mail_from = {
    "name": "Your Name",
    "email": "your@domain.com",
}

recipients = [
    {
        "name": "Your Client",
        "email": "your@client.com",
    }
]

variables = [
    {
        "email": "your@client.com",
        "substitutions": [
            {
                "var": "foo",
                "value": "bar"
            },
        ]
    }
]

attachment = open('path-to-file', 'rb')
att_read = attachment.read()
att_base64 = base64.b64encode(bytes(att_read))
attachments = [
    {
        "id": "my-attached-file",
        "filename": "file.jpg",
        "content": f"{att_base64.decode('ascii')}",
        "disposition": "attachment"
    }
]

mailer.set_mail_from(mail_from, mail_body)
mailer.set_mail_to(recipients, mail_body)
mailer.set_subject("Hello from {$foo}", mail_body)
mailer.set_html_content("This is the HTML content, {$foo}", mail_body)
mailer.set_plaintext_content("This is the text content, {$foo}", mail_body)
mailer.set_simple_personalization(variables, mail_body)
mailer.set_attachments(attachments, mail_body)

mailer.send(mail_body)
```

## Email Verification

### Get all email verification lists

```python
from mailersend import email_verification
from dotenv import load_dotenv

load_dotenv()

mailer = email_verification.NewEmailVerification(os.getenv('MAILERSEND_API_KEY'))

mailer.get_all_lists()
```

### Get a single email verification list

```python
from mailersend import email_verification
from dotenv import load_dotenv

load_dotenv()

mailer = email_verification.NewEmailVerification(os.getenv('MAILERSEND_API_KEY'))

email_verification_list_id = 123456

mailer.get_list(email_verification_list_id)
```

### Create a email verification list

```python
from mailersend import email_verification
from dotenv import load_dotenv

load_dotenv()

mailer = email_verification.NewEmailVerification(os.getenv('MAILERSEND_API_KEY'))

name = "My List"
emails = [
    "some@email.com",
    "another@email.com"
]

mailer.create_list(name, emails)
```

### Verify a list

```python
from mailersend import email_verification
from dotenv import load_dotenv

load_dotenv()

mailer = email_verification.NewEmailVerification(os.getenv('MAILERSEND_API_KEY'))

email_verification_list_id = 123456

mailer.verify_list(email_verification_list_id)
```

### Get list results

```python
from mailersend import email_verification
from dotenv import load_dotenv

load_dotenv()

mailer = email_verification.NewEmailVerification(os.getenv('MAILERSEND_API_KEY'))

email_verification_list_id = 123456

mailer.get_list_results(email_verification_list_id)
```


## Bulk Email

### Send bulk email

```python
from mailersend import emails
from dotenv import load_dotenv

load_dotenv()

mailer = emails.NewEmail(os.getenv('MAILERSEND_API_KEY'))

mail_list = [
  {
    "from": {
      "email": "your@domain.com",
      "name": "Your Name"
    },
    "to": [
      {
        "email": "your@client.com",
        "name": "Your Client"
      }
    ],
    "subject": "Subject",
    "text": "This is the text content",
    "html": "<p>This is the HTML content</p>",
  },
  {
    "from": {
      "email": "your@domain.com",
      "name": "Your Name"
    },
    "to": [
      {
        "email": "your@client.com",
        "name": "Your Client"
      }
    ],
    "subject": "Subject",
    "text": "This is the text content",
    "html": "<p>This is the HTML content</p>",
  }
]

print(mailer.send_bulk(mail_list))
```

### Get bulk email status

```python
from mailersend import emails
from dotenv import load_dotenv

load_dotenv()

mailer = emails.NewEmail(os.getenv('MAILERSEND_API_KEY'))

print(mailer.get_bulk_status_by_id("bulk-email-id"))
```

<a name="activity"></a>

## Activity

### Get a list of activities (simple)

```python
from mailersend import activity
from dotenv import load_dotenv

load_dotenv()

mailer = activity.NewActivity(os.getenv('MAILERSEND_API_KEY'))

mailer.get_domain_activity("domain-id")
```

### Get a list of activities (full)

```python
from mailersend import activity
from dotenv import load_dotenv

load_dotenv()

mailer = activity.NewActivity(os.getenv('MAILERSEND_API_KEY'))

page = 1
limit = 20
date_from = 1623073576
date_to = 1623074976
events = [
    "queued",
    "sent",
    "delivered",
    "soft-bounced",
    "hard-bounced",
    "junk",
    "opened",
    "clicked",
    "unsubscribed",
    "spam_complaints",
]

mailer.get_domain_activity("domain-id", page, limit, date_from, date_to, events)
```

## Analytics

### Activity data by date

```python
from mailersend import analytics
from dotenv import load_dotenv

load_dotenv()

mailer = analytics.NewAnalytics(os.getenv('MAILERSEND_API_KEY'))

date_from = 1623073576
date_to = 1623074976
events = [
    "sent",
]

# optional arguments
domain_id = "domain-id"
group_by = "days"

mailer.get_activity_by_date(date_from, date_to, events, domain_id, group_by)
```

### Opens by country

```python
from mailersend import analytics
from dotenv import load_dotenv

load_dotenv()

mailer = analytics.NewAnalytics(os.getenv('MAILERSEND_API_KEY'))

date_from = 1623073576
date_to = 1623074976

# optional arguments
domain_id = "domain-id"

mailer.get_opens_by_country(date_from, date_to, domain_id)
```

### Opens by user-agent name

```python
from mailersend import analytics
from dotenv import load_dotenv

load_dotenv()

mailer = analytics.NewAnalytics(os.getenv('MAILERSEND_API_KEY'))

date_from = 1623073576
date_to = 1623074976

# optional arguments
domain_id = "domain-id"

mailer.get_opens_by_user_agent(date_from, date_to, domain_id)
```

### Opens by reading environment

```python
from mailersend import analytics
from dotenv import load_dotenv

load_dotenv()

mailer = analytics.NewAnalytics(os.getenv('MAILERSEND_API_KEY'))

date_from = 1623073576
date_to = 1623074976

# optional arguments
domain_id = "domain-id"

mailer.get_opens_by_reading_environment(date_from, date_to, domain_id)
```

## Inbound Routes

### Get a list of inbound routes

```python
from mailersend import inbound_routing
from dotenv import load_dotenv

load_dotenv()

mailer = inbound_routing.NewInbound(os.getenv('MAILERSEND_API_KEY'))

print(mailer.get_inbound_routes())
```

### Get a single inbound route

```python
from mailersend import inbound_routing
from dotenv import load_dotenv

load_dotenv()

mailer = inbound_routing.NewInbound(os.getenv('MAILERSEND_API_KEY'))

print(mailer.get_inbound_by_id("inbound-id"))
```

### Add an inbound route

```python
from mailersend import inbound_routing
from dotenv import load_dotenv

load_dotenv()

mailer = inbound_routing.NewInbound(os.getenv('MAILERSEND_API_KEY'))

options = {}

_catch_filter = {
    "type": "catch_recipient",
    "filters": [
        {
            "comparer": "equal",
            "value": "test"
        }
    ]
}

_match_filter = {
    "type": "match_all"
}

_forwards = [
    {
        "type": "webhook",
        "value": "https://www.mailersend.com/hook"
    }
]
mailer.set_name("Example route", options)
mailer.set_domain_enabled(True, options)
mailer.set_inbound_domain("test.mailersend.com", options)
mailer.set_catch_filter(_catch_filter, options)

print(mailer.add_inbound_route())
```

### Update an inbound route

```python
from mailersend import inbound_routing
from dotenv import load_dotenv

load_dotenv()

route_id = "inbound-route-id"

mailer = inbound_routing.NewInbound(os.getenv('MAILERSEND_API_KEY'))

options = {}

_catch_filter = {
    "type": "catch_recipient",
    "filters": [
        {
            "comparer": "equal",
            "value": "test"
        }
    ]
}

_match_filter = {
    "type": "match_all"
}

_forwards = [
    {
        "type": "webhook",
        "value": "https://www.mailersend.com/hook"
    }
]
mailer.set_name("Example route", options)
mailer.set_domain_enabled(True, options)
mailer.set_inbound_domain("test.mailersend.com", options)
mailer.set_catch_filter(_catch_filter, options)

print(mailer.update_inbound_route(route_id))
```

### Delete an inbound route

```python
from mailersend import inbound_routing
from dotenv import load_dotenv

load_dotenv()

route_id = "inbound-route-id"

mailer = inbound_routing.NewInbound(os.getenv('MAILERSEND_API_KEY'))

print(mailer.delete_inbound_route(route_id))
```

## Domains

### Get a list of domains

```python
from mailersend import domains
from dotenv import load_dotenv

load_dotenv()

mailer = domains.NewDomain(os.getenv('MAILERSEND_API_KEY'))

mailer.get_domains()
```

### Get a single domain

```python
from mailersend import domains
from dotenv import load_dotenv

load_dotenv()

mailer = domains.NewDomain(os.getenv('MAILERSEND_API_KEY'))

mailer.get_domain_by_id("domain-id")
```

### Get a single domain using helper function

```python
from mailersend import domains
from mailersend import utils
from dotenv import load_dotenv

load_dotenv()

mailer = domains.NewDomain(os.getenv('MAILERSEND_API_KEY'))
helper = utils.NewHelper(os.getenv('MAILERSEND_API_KEY'))

mailer.get_domain_by_id(helper.get_id_by_name("domains","domain-name"))
```

### Add a domain

You can find a full list of settings [here](https://developers.mailersend.com/api/v1/domains.html#request-parameters-3).

```python
from mailersend import domains
from dotenv import load_dotenv

load_dotenv()

mailer = domains.NewDomain(os.getenv('MAILERSEND_API_KEY'))

domain_data = {
    "name": "mydomain.com",
    "return_path_subdomain": "rpsubdomain",
    "custom_tracking_subdomain": "ctsubdomain",
    "inbound_routing_subdomain": "irsubdomain"
}
mailer.add_domain("name", domain_data)
```


### Delete a domain

```python
from mailersend import domains
from dotenv import load_dotenv

load_dotenv()

mailer = domains.NewDomain(os.getenv('MAILERSEND_API_KEY'))

mailer.delete_domain("domain-id")
```

### Get a list of recipients per domain

```python
from mailersend import domains
from dotenv import load_dotenv

load_dotenv()

mailer = domains.NewDomain(os.getenv('MAILERSEND_API_KEY'))

mailer.get_recipients_for_domain("domain-id")
```

### Update domain settings

You can find a full list of settings [here](https://developers.mailersend.com/api/v1/domains.html#request-body).

```python
from mailersend import domains
from dotenv import load_dotenv

load_dotenv()

mailer = domains.NewDomain(os.getenv('MAILERSEND_API_KEY'))

domain_data = {
    "send_paused": True,
    "track_clicks": True,
    "track_opens": True,
    "track_unsubscribe": True,
    "track_unsubscribe_html": "<p>Click to <a href='{$unsubscribe}'>unsubscribe</a></p>",
    "track_unsubscribe_plain": "Click to unsubscribe: {$unsubscribe}",
    "track_content": True,
    "custom_tracking_enabled": True,
    "custom_tracking_subdomain": "email",
    "precedence_bulk": False
}

mailer.update_domain_setting("domain-id", domain_data)
```

### Get DNS Records

```python
from mailersend import domains
from dotenv import load_dotenv

load_dotenv()

mailer = domains.NewDomain(os.getenv('MAILERSEND_API_KEY'))

mailer.get_dns_records("domain-id")
```

### Verify a domain

```python
from mailersend import domains
from dotenv import load_dotenv

load_dotenv()

mailer = domains.NewDomain(os.getenv('MAILERSEND_API_KEY'))

mailer.verify_domain("domain-id")
```


## Messages

### Get a list of messages

```python
from mailersend import messages
from dotenv import load_dotenv

load_dotenv()

mailer = messages.NewMessage(os.getenv('MAILERSEND_API_KEY'))

mailer.get_messages()
```

### Get a single message

```python
from mailersend import messages
from dotenv import load_dotenv

load_dotenv()

mailer = messages.NewMessage(os.getenv('MAILERSEND_API_KEY'))

mailer.get_message_by_id("message-id")
```

## Scheduled messages

### Get a list of scheduled messages

```python
from mailersend import scheduled_messages
from dotenv import load_dotenv

load_dotenv()

mailer = scheduled_messages.NewMessageSchedule(os.getenv('MAILERSEND_API_KEY'))

print(mailer.get_scheduled_messages())
```

### Get a single scheduled message

```python
from mailersend import scheduled_messages
from dotenv import load_dotenv

load_dotenv()

mailer = scheduled_messages.NewMessageSchedule(os.getenv('MAILERSEND_API_KEY'))

print(mailer.get_scheduled_message_by_id("scheduled-message-id"))
```

### Delete a scheduled message

```python
from mailersend import scheduled_messages
from dotenv import load_dotenv

load_dotenv()

mailer = scheduled_messages.NewMessageSchedule(os.getenv('MAILERSEND_API_KEY'))

print(mailer.delete_scheduled_message("scheduled-message-id"))
```

## Recipients

### Get a list of recipients

```python
from mailersend import recipients
from dotenv import load_dotenv

load_dotenv()

mailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))

mailer.get_recipients()
```

### Get a single recipient

```python
from mailersend import recipients
from dotenv import load_dotenv

load_dotenv()

mailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))

mailer.get_recipient_by_id("recipient-id")
```

### Delete a recipient

```python
from mailersend import recipients
from dotenv import load_dotenv

load_dotenv()

mailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))

mailer.delete_recipient("recipient-id")
```

### Get recipients from a blocklist

```python
from mailersend import recipients
from dotenv import load_dotenv

load_dotenv()

mailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))

mailer.get_recipients_from_blocklist("domain-id")
```

### Get recipients from hard bounces

```python
from mailersend import recipients
from dotenv import load_dotenv

load_dotenv()

mailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))

mailer.get_hard_bounces("domain-id")
```

### Get recipients from spam complaints

```python
from mailersend import recipients
from dotenv import load_dotenv

load_dotenv()

mailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))

mailer.get_spam_complaints("domain-id")
```

### Get recipients from unsubscribes

```python
from mailersend import recipients
from dotenv import load_dotenv

load_dotenv()

mailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))

mailer.get_unsubscribes("domain-id")
```

### Add recipients to blocklist

Using recipients:

```python
from mailersend import recipients
from dotenv import load_dotenv

load_dotenv()

mailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))

recipient_list = [
    'blocked@client.com'
]

mailer.add_to_blocklist("domain-id", recipients=recipient_list)
```

Using patterns:

```python
from mailersend import recipients
from dotenv import load_dotenv

load_dotenv()

mailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))

recipient_patterns = [
    '*@client.com'
]

mailer.add_to_blocklist("domain-id", patterns=recipient_patterns)
```

### Add hard bounced recipients

```python
from mailersend import recipients
from dotenv import load_dotenv

load_dotenv()

mailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))

recipient_list = [
    "your@client.com"
]

mailer.add_hard_bounces("domain-id", recipient_list)
```

### Add spam complaints

```python
from mailersend import recipients
from dotenv import load_dotenv

load_dotenv()

mailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))

recipient_list = [
    "your@client.com"
]

mailer.add_spam_complaints("domain-id", recipient_list)
```

### Add recipients to unsubscribe list

```python
from mailersend import recipients
from dotenv import load_dotenv

load_dotenv()

mailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))

recipient_list = [
    "your@client.com"
]

mailer.add_unsubscribes("domain-id", recipient_list)
```

### Delete recipients from blocklist

```python
from mailersend import recipients
from dotenv import load_dotenv

load_dotenv()

mailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))

recipient_list = [
    "your@client.com"
]

mailer.delete_from_blocklist("domain-id", recipient_list)
```

### Delete hard bounced recipients

```python
from mailersend import recipients
from dotenv import load_dotenv

load_dotenv()

mailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))

recipient_list = [
    "your@client.com"
]

mailer.delete_hard_bounces("domain-id", recipient_list)
```

### Delete spam complaints

```python
from mailersend import recipients
from dotenv import load_dotenv

load_dotenv()

mailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))

recipient_list = [
    "your@client.com"
]

mailer.delete_spam_complaints("domain-id", recipient_list)
```

### Delete recipients from unsubscribe list

```python
from mailersend import recipients
from dotenv import load_dotenv

load_dotenv()

mailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))

recipient_list = [
    "your@client.com"
]

mailer.delete_unsubscribes("domain-id", recipient_list)
```

## Tokens

### Create a token

```python
from mailersend import tokens
from dotenv import load_dotenv

load_dotenv()

mailer = tokens.NewToken(os.getenv('MAILERSEND_API_KEY'))

scopes = ["email_full", "analytics_read"]

mailer.create_token("my-token", scopes)
```

Because of security reasons, we only allow access token appearance once during creation. In order to see the access token created you can do:

```python
from mailersend import tokens
from dotenv import load_dotenv

load_dotenv()

mailer = tokens.NewToken(os.getenv('MAILERSEND_API_KEY'))

scopes = ["email_full", "analytics_read"]

print(mailer.create_token("my-token", scopes))
```

### Pause / Unpause Token

```python
from mailersend import tokens
from dotenv import load_dotenv

load_dotenv()

mailer = tokens.NewToken(os.getenv('MAILERSEND_API_KEY'))

# pause
mailer.update_token("my-token")

# unpause
mailer.update_token("my-token", pause=False)
```

### Delete a Token

```python
from mailersend import tokens
from dotenv import load_dotenv

load_dotenv()

mailer = tokens.NewToken(os.getenv('MAILERSEND_API_KEY'))

mailer.delete_token("token-id")
```

## Templates

### Get a list of templates

```python
from mailersend import templates
from dotenv import load_dotenv

load_dotenv()

mailer = templates.NewTemplate(os.getenv('MAILERSEND_API_KEY'))

mailer.get_templates()
```

### Get a single template

```python
from mailersend import templates
from dotenv import load_dotenv

load_dotenv()

mailer = templates.NewTemplate(os.getenv('MAILERSEND_API_KEY'))
template_id = 1234

mailer.get_template_by_id()
```

### Delete template

```python
from mailersend import templates
from dotenv import load_dotenv

load_dotenv()

mailer = templates.NewTemplate(os.getenv('MAILERSEND_API_KEY'))
template_id = 1234

mailer.delete_template()
```

## Webhooks

### Get a list of webhooks

```python
from mailersend import webhooks
from dotenv import load_dotenv

load_dotenv()

mailer = webhooks.NewWebhook(os.getenv('MAILERSEND_API_KEY'))

mailer.get_webhooks("domain-id")
```

### Get a single webhook

```python
from mailersend import webhooks
from dotenv import load_dotenv

load_dotenv()

mailer = webhooks.NewWebhook(os.getenv('MAILERSEND_API_KEY'))

mailer.get_webhook_by_id("webhook-id")
```

### Create a Webhook

```python
from mailersend import webhooks
from dotenv import load_dotenv

load_dotenv()

webhookEvents = ['activity.sent', 'activity.delivered']

webhook = webhooks.NewWebhook(os.getenv('MAILERSEND_API_KEY'))
webhook.set_webhook_url("https://webhooks.mysite.com")
webhook.set_webhook_name("my first webhook")
webhook.set_webhook_events(webhookEvents)
webhook.set_webhook_domain("domain-id")

webhook.create_webhook()
```

### Create a disabled webhook

```python
from mailersend import webhooks
from dotenv import load_dotenv

load_dotenv()

webhookEvents = ['activity.sent', 'activity.delivered']

webhook = webhooks.NewWebhook(os.getenv('MAILERSEND_API_KEY'))
webhook.set_webhook_url("https://webhooks.mysite.com")
webhook.set_webhook_name("my first webhook")
webhook.set_webhook_events(webhookEvents)
webhook.set_webhook_domain("domain-id")
webhook.set_webhook_enabled(False)

webhook.create_webhook()
```

### Update a Webhook

```python
from mailersend import webhooks
from dotenv import load_dotenv

load_dotenv()

webhook = webhooks.NewWebhook(os.getenv('MAILERSEND_API_KEY'))

webhook.update_webhook("webhook-id", "name", "a new webhook name")
```

### Disable/Enable a Webhook

```python
from mailersend import webhooks
from dotenv import load_dotenv

load_dotenv()

webhook = webhooks.NewWebhook(os.getenv('MAILERSEND_API_KEY'))

webhook.update_webhook("webhook-id", "enabled", False)
```

### Delete a Webhook

```python
from mailersend import webhooks
from dotenv import load_dotenv

load_dotenv()

webhook = webhooks.NewWebhook(os.getenv('MAILERSEND_API_KEY'))

webhook.delete_webhook("webhook-id")
```

## SMS

### Sending SMS messages

Without personalization:
```python
from mailersend import sms_sending
from dotenv import load_dotenv

load_dotenv()

mailer = sms_sending.NewSmsSending(os.getenv('MAILERSEND_API_KEY'))

# Number belonging to your account in E164 format
number_from = "+11234567890"

# You can add up to 50 recipient numbers
numbers_to = [
    "+11234567891",
    "+11234567892"
]
text = "This is the text content"

print(mailer.send_sms(number_from, numbers_to, text))
```

With personalization:
```python
from mailersend import sms_sending
from dotenv import load_dotenv

load_dotenv()

mailer = sms_sending.NewSmsSending(os.getenv('MAILERSEND_API_KEY'))

# Number belonging to your account in E164 format
number_from = "+11234567890"

# You can add up to 50 recipient numbers
numbers_to = [
    "+11234567891",
    "+11234567892"
]
text = "Hi {{name}} how are you?"
personalization = [
    {
        "phone_number": "+11234567891",
        "data": {
            "name": "Mike"
        }
    },
    {
        "phone_number": "+11234567892",
        "data": {
            "name": "John"
        }
    }
]

print(mailer.send_sms(number_from, numbers_to, text, personalization))
```

## SMS Activity

### Get a list of activities
```python
from mailersend import sms_activity
from dotenv import load_dotenv

load_dotenv()

mailer = sms_activity.NewSmsActivity(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
sms_number_id = 1365743
date_from = 1655157601
date_to = 1655158601
status = ["queued", "failed"]
page = 1
limit = 200

print(mailer.get_activities(sms_number_id=sms_number_id, date_from=date_from, date_to=date_to, status=status, page=page, limit=limit))
```

### Get activity of a single message
```python
from mailersend import sms_activity
from dotenv import load_dotenv

load_dotenv()

mailer = sms_activity.NewSmsActivity(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
sms_message_id = "62a9d12b07852eaf2207b417"

print(mailer.get_activity(sms_message_id))
```

## SMS Phone Numbers

### Get a list of SMS phone numbers
```python
from mailersend import sms_phone_numbers
from dotenv import load_dotenv

load_dotenv()

mailer = sms_phone_numbers.NewSmsNumbers(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
paused = False

print(mailer.get_phone_numbers(paused))
```

### Get an SMS phone number
```python
from mailersend import sms_phone_numbers
from dotenv import load_dotenv

load_dotenv()

mailer = sms_phone_numbers.NewSmsNumbers(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
sms_number_id = "9pq3enl6842vwrzx"

print(mailer.get_phone_number(sms_number_id))
```

### Update a single SMS phone number
```python
from mailersend import sms_phone_numbers
from dotenv import load_dotenv

load_dotenv()

mailer = sms_phone_numbers.NewSmsNumbers(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
sms_number_id = "9pq3enl6842vwrzx"
paused = True

print(mailer.update_phone_number(sms_number_id, paused))
```

### Delete an SMS phone number
```python
from mailersend import sms_phone_numbers
from dotenv import load_dotenv

load_dotenv()

mailer = sms_phone_numbers.NewSmsNumbers(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
sms_number_id = "9pq3enl6842vwrzx"

print(mailer.delete_phone_number(sms_number_id))
```

## SMS Recipients

### Get a list of SMS recipients
```python
from mailersend import sms_recipients
from dotenv import load_dotenv

load_dotenv()

mailer = sms_recipients.NewSmsRecipients(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
sms_number_id = "9pq3enl6842vwrzx"
status = "active"

print(mailer.get_recipients(status=status, sms_number_id=sms_number_id))
```

### Get an SMS recipient
```python
from mailersend import sms_recipients
from dotenv import load_dotenv

load_dotenv()

mailer = sms_recipients.NewSmsRecipients(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
sms_recipient_id = "627e756fd30078fb2208cc87"

print(mailer.get_recipient(sms_recipient_id))
```

### Update a single SMS recipient
```python
from mailersend import sms_recipients
from dotenv import load_dotenv

load_dotenv()

mailer = sms_recipients.NewSmsRecipients(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
sms_recipient_id = "627e756fd30078fb2208cc87"
status = "opt_out"

print(mailer.update_recipient(sms_recipient_id, status))
```

## SMS Messages

### Get a list of SMS messages
```python
from mailersend import sms_messages
from dotenv import load_dotenv

load_dotenv()

mailer = sms_messages.NewSmsMessages(os.getenv('MAILERSEND_API_KEY'))

print(mailer.get_messages())
```

### Get an SMS message
```python
from mailersend import sms_messages
from dotenv import load_dotenv

load_dotenv()

#Request parameters
sms_message_id = "627e756fd30078fb2208cc87"

mailer = sms_messages.NewSmsMessages(os.getenv('MAILERSEND_API_KEY'))

print(mailer.get_message(sms_message_id))
```

## SMS Webhooks

### Get a list of SMS webhooks
```python
from mailersend import sms_webhooks
from dotenv import load_dotenv

load_dotenv()

mailer = sms_webhooks.NewSmsWebhooks(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
sms_number_id = "9pq3enl6842vwrzx"

print(mailer.get_webhooks(sms_number_id))
```

### Get a single SMS webhook
```python
from mailersend import sms_webhooks
from dotenv import load_dotenv

load_dotenv()

mailer = sms_webhooks.NewSmsWebhooks(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
sms_webhook_id = "aaui13enl12f2vzx"

print(mailer.get_webhook(sms_webhook_id))
```

### Create an SMS webhook
```python
from mailersend import sms_webhooks
from dotenv import load_dotenv

load_dotenv()

mailer = sms_webhooks.NewSmsWebhooks(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
url = "https://webhook-url.com"
name = "My Webhook Name"
events = ["sms.sent"]
sms_number_id = "9pq3enl6842vwrzx"
enabled = True

print(mailer.create_webhook(url, name, events, sms_number_id, enabled))
```

### Update a single SMS webhook
```python
from mailersend import sms_webhooks
from dotenv import load_dotenv

load_dotenv()

mailer = sms_webhooks.NewSmsWebhooks(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
url = "https://different-url.com"
name = "New Webhook Name"
events = ["sms.sent", "sms.failed"],
sms_webhook_id = "aaui13enl12f2vzx"
enabled = False

print(mailer.update_webhook(sms_webhook_id, url, name, events, enabled))
```

### Delete an SMS webhook
```python
from mailersend import sms_webhooks
from dotenv import load_dotenv

load_dotenv()

mailer = sms_webhooks.NewSmsWebhooks(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
sms_webhook_id = "aaui13enl12f2vzx"

print(mailer.delete_webhook(sms_webhook_id))
```

### Get a list of SMS webhooks
```python
from mailersend import sms_webhooks
from dotenv import load_dotenv

load_dotenv()

mailer = sms_webhooks.NewSmsWebhooks(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
sms_number_id = "9pq3enl6842vwrzx"

print(mailer.get_webhooks(sms_number_id))
```

## SMS Inbouds

### Get a list of SMS inbound routes
```python
from mailersend import sms_inbounds
from dotenv import load_dotenv

load_dotenv()

mailer = sms_inbounds.NewSmsInbounds(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
sms_number_id = "123456789"
enabled = True
page = 1
limit = 25

print(mailer.get_inbound_routes(sms_number_id, enabled, page, limit))
```

### Get a single SMS inbound route
```python
from mailersend import sms_inbounds
from dotenv import load_dotenv

load_dotenv()

mailer = sms_inbounds.NewSmsInbounds(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
sms_inbound_id = "123456789"

print(mailer.get_inbound_route(sms_inbound_id))
```

### Create an SMS inbound route
```python
from mailersend import sms_inbounds
from dotenv import load_dotenv

load_dotenv()

mailer = sms_inbounds.NewSmsInbounds(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
sms_number_id = "123456789"
name = "My route"
forward_url = "https://some.url"
filter = {
    "comparer": "equal",
    "value": "START"
}
enabled = True

print(mailer.create_inbound_route(sms_number_id, name, forward_url, filter, enabled))
```

### Update an SMS inbound route
```python
from mailersend import sms_inbounds
from dotenv import load_dotenv

load_dotenv()

mailer = sms_inbounds.NewSmsInbounds(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
sms_number_id = "123456789"
name = "New name"
forward_url = "https://news.url"
filter = {
    "comparer": "contains",
    "value": "some-value"
}
enabled = True

print(mailer.update_inbound_route(sms_number_id, name, forward_url, filter, enabled))
```

### Delete an SMS inbound route
```python
from mailersend import sms_inbounds
from dotenv import load_dotenv

load_dotenv()

mailer = sms_inbounds.NewSmsInbounds(os.getenv('MAILERSEND_API_KEY'))

#Request parameters
sms_inbound_id = "123456789"

print(mailer.delete_inbound_route()(sms_inbound_id))
```

## Sender Identities

### Get a list of sender identities
```python
from mailersend import sender_identities
from dotenv import load_dotenv

load_dotenv()

mailer = sender_identities.NewSenderIdentity(os.getenv('MAILERSEND_API_KEY'))

print(mailer.get_identities())
```

### Get a sender identity
```python
from mailersend import sender_identities
from dotenv import load_dotenv

load_dotenv()

mailer = sender_identities.NewSenderIdentity(os.getenv('MAILERSEND_API_KEY'))

print(mailer.get_identity(identity_id="12345"))
```

### Create a sender identity
```python
from mailersend import sender_identities
from dotenv import load_dotenv

load_dotenv()

mailer = sender_identities.NewSenderIdentity(os.getenv('MAILERSEND_API_KEY'))

print(mailer.create_identity(
    domain_id="123456",
    name="John Doe",
    email="email@domain.com",
    reply_to_email="reply@domain.com",
    reply_to_name="Doe John",
    add_note=True,
    personal_note="My awesome note",
))
```

### Update a sender identity
```python
from mailersend import sender_identities
from dotenv import load_dotenv

load_dotenv()

mailer = sender_identities.NewSenderIdentity(os.getenv('MAILERSEND_API_KEY'))

print(mailer.update_identity(
    identity_id="123456",
    domain_id="123456",
    name="Abe Doe",
    email="email@mydomain.com",
    reply_to_email="reply@mydomain.com",
    reply_to_name="Doe Abe",
    add_note=False
))
```

### Delete a sender identity
```python
from mailersend import sender_identities
from dotenv import load_dotenv

load_dotenv()

mailer = sender_identities.NewSenderIdentity(os.getenv('MAILERSEND_API_KEY'))

print(mailer.delete_identity(identity_id="123456"))
```

## API Quota
### Get API Quota
```python
from mailersend import api_quota
from dotenv import load_dotenv

load_dotenv()

mailer = api_quota.NewApiQuota(os.getenv('MAILERSEND_API_KEY'))

print(mailer.get_quota())
```

# Troubleshooting

## Emails not being sent

Print the output of `mailer.send()` to view status code and errors.

```python
from mailersend import emails

mailer = emails.NewEmail()

mail_body = {}

print(mailer.send(mail_body))
```

# Testing

TBD

<a name="endpoints"></a>
# Available endpoints

| Feature group     | Endpoint                                | Available |
|-------------------|-----------------------------------------|-----------|
| Activity          | `GET activity`                          | ✅         |
| Analytics         | `GET analytics`                         | ✅         |
| Domains           | `{GET, PUT, DELETE} domains`            | ✅         |
| Emails            | `POST send`                             | ✅         |
| Messages          | `GET messages`                          | ✅         |
| Recipients        | `{GET, DELETE} recipients`              | ✅         |
| Templates         | `{GET, DELETE} templates`               | ✅         |
| Tokens            | `{POST, PUT, DELETE} tokens`            | ✅         |
| Webhooks          | `{GET, POST, PUT, DELETE} webhooks`     | ✅         |
| SMS Sending       | `{POST} sms`                            | ✅         |
| SMS Activity      | `{GET} sms-activity`                    | ✅         |
| SMS Phone numbers | `{GET, PUT, DELETE} sms-numbers`        | ✅         |
| SMS Recipients    | `{GET, PUT} sms-recipients`             | ✅         |
| SMS Messages      | `{GET} sms-messages`                    | ✅         |
| SMS Webhooks      | `{GET, POST, PUT, DELETE} sms-webhooks` | ✅         |
| SMS Inbounds      | `{GET, POST, PUT, DELETE} sms-inbounds` | ✅         |
| Sender Identities | `{GET, POST, PUT, DELETE} identities`   | ✅         |
| API Quota         | `{GET} api-quota`                       | ✅         |

*If, at the moment, some endpoint is not available, please use other available tools to access it. [Refer to official API docs for more info](https://developers.mailersend.com/).*


<a name="support-and-feedback"></a>
# Support and Feedback

In case you find any bugs, submit an issue directly here in GitHub.

You are welcome to create SDK for any other programming language.

If you have any troubles using our API or SDK free to contact our support by email [info@mailersend.com](mailto:info@mailersend.com)

The official documentation is at [https://developers.mailersend.com](https://developers.mailersend.com)

<a name="license"></a>
# License

[The MIT License (MIT)](LICENSE)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "mailersend",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7,<4.0",
    "maintainer_email": "",
    "keywords": "mailersend,mail",
    "author": "Igor Hr\u010dek",
    "author_email": "igor@mailerlite.com",
    "download_url": "https://files.pythonhosted.org/packages/ec/62/139be58ddf7b37f04bcd123010336f1837d7c62451ab038f95e81926e1d5/mailersend-0.5.6.tar.gz",
    "platform": null,
    "description": "<a href=\"https://www.mailersend.com\"><img src=\"https://www.mailersend.com/images/logo.svg\" width=\"200px\"/></a>\n\nMailerSend Python SDK\n\n[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)\n\n# Table of Contents\n- [Table of Contents](#table-of-contents)\n- [Installation](#installation)\n  - [Requirements](#requirements)\n  - [Authentication](#authentication)\n- [Usage](#usage)\n  - [Email](#email)\n    - [Send an email](#send-an-email)\n    - [Add CC, BCC recipients](#add-cc-bcc-recipients)\n    - [Send a template-based email](#send-a-template-based-email)\n    - [Advanced personalization](#advanced-personalization)\n    - [Simple personalization](#simple-personalization)\n    - [Send email with attachment](#send-email-with-attachment)\n  - [Email Verification](#email-verification)\n    - [Get all email verification lists](#get-all-email-verification-lists)\n    - [Get a single email verification list](#get-a-single-email-verification-list)\n    - [Create a email verification list](#create-a-email-verification-list)\n    - [Verify a list](#verify-a-list)\n    - [Get list results](#get-list-results)\n  - [Bulk Email](#bulk-email)\n    - [Send bulk email](#send-bulk-email)\n    - [Get bulk email status](#get-bulk-email-status)\n  - [Activity](#activity)\n    - [Get a list of activities (simple)](#get-a-list-of-activities-simple)\n    - [Get a list of activities (full)](#get-a-list-of-activities-full)\n  - [Analytics](#analytics)\n    - [Activity data by date](#activity-data-by-date)\n    - [Opens by country](#opens-by-country)\n    - [Opens by user-agent name](#opens-by-user-agent-name)\n    - [Opens by reading environment](#opens-by-reading-environment)\n  - [Inbound Routes](#inbound-routes)\n    - [Get a list of inbound routes](#get-a-list-of-inbound-routes)\n    - [Get a single inbound route](#get-a-single-inbound-route)\n    - [Add an inbound route](#add-an-inbound-route)\n    - [Update an inbound route](#update-an-inbound-route)\n    - [Delete an inbound route](#delete-an-inbound-route)\n  - [Domains](#domains)\n    - [Get a list of domains](#get-a-list-of-domains)\n    - [Get a single domain](#get-a-single-domain)\n    - [Get a single domain using helper function](#get-a-single-domain-using-helper-function)\n    - [Add a domain](#add-a-domain)\n    - [Delete a domain](#delete-a-domain)\n    - [Get a list of recipients per domain](#get-a-list-of-recipients-per-domain)\n    - [Update domain settings](#update-domain-settings)\n    - [Get DNS Records](#get-dns-records)\n    - [Verify a domain](#verify-a-domain)\n  - [Messages](#messages)\n    - [Get a list of messages](#get-a-list-of-messages)\n    - [Get a single message](#get-a-single-message)\n  - [Scheduled messages](#scheduled-messages)\n    - [Get a list of scheduled messages](#get-a-list-of-scheduled-messages)\n    - [Get a single scheduled message](#get-a-single-scheduled-message)\n    - [Delete a scheduled message](#delete-a-scheduled-message)\n  - [Recipients](#recipients)\n    - [Get a list of recipients](#get-a-list-of-recipients)\n    - [Get a single recipient](#get-a-single-recipient)\n    - [Delete a recipient](#delete-a-recipient)\n    - [Get recipients from a blocklist](#get-recipients-from-a-blocklist)\n    - [Get recipients from hard bounces](#get-recipients-from-hard-bounces)\n    - [Get recipients from spam complaints](#get-recipients-from-spam-complaints)\n    - [Get recipients from unsubscribes](#get-recipients-from-unsubscribes)\n    - [Add recipients to blocklist](#add-recipients-to-blocklist)\n    - [Add hard bounced recipients](#add-hard-bounced-recipients)\n    - [Add spam complaints](#add-spam-complaints)\n    - [Add recipients to unsubscribe list](#add-recipients-to-unsubscribe-list)\n    - [Delete recipients from blocklist](#delete-recipients-from-blocklist)\n    - [Delete hard bounced recipients](#delete-hard-bounced-recipients)\n    - [Delete spam complaints](#delete-spam-complaints)\n    - [Delete recipients from unsubscribe list](#delete-recipients-from-unsubscribe-list)\n  - [Tokens](#tokens)\n    - [Create a token](#create-a-token)\n    - [Pause / Unpause Token](#pause--unpause-token)\n    - [Delete a Token](#delete-a-token)\n  - [Templates](#templates)\n    - [Get a list of templates](#get-a-list-of-templates)\n    - [Get a single template](#get-a-single-template)\n    - [Delete template](#delete-template)\n  - [Webhooks](#webhooks)\n    - [Get a list of webhooks](#get-a-list-of-webhooks)\n    - [Get a single webhook](#get-a-single-webhook)\n    - [Create a Webhook](#create-a-webhook)\n    - [Create a disabled webhook](#create-a-disabled-webhook)\n    - [Update a Webhook](#update-a-webhook)\n    - [Disable/Enable a Webhook](#disableenable-a-webhook)\n    - [Delete a Webhook](#delete-a-webhook)\n  - [SMS](#sms)\n    - [Sending SMS messages](#sending-sms-messages)\n  - [SMS Activity](#sms-activity)\n    - [Get a list of activities](#get-a-list-of-activities)\n    - [Get activity of a single message](#get-activity-of-a-single-message)\n  - [SMS Phone Numbers](#sms-phone-numbers)\n    - [Get a list of SMS phone numbers](#get-a-list-of-sms-phone-numbers)\n    - [Get an SMS phone number](#get-an-sms-phone-number)\n    - [Update a single SMS phone number](#update-a-single-sms-phone-number)\n    - [Delete an SMS phone number](#delete-an-sms-phone-number)\n  - [SMS Recipients](#sms-recipients)\n    - [Get a list of SMS recipients](#get-a-list-of-sms-recipients)\n    - [Get an SMS recipient](#get-an-sms-recipient)\n    - [Update a single SMS recipient](#update-a-single-sms-recipient)\n  - [SMS Messages](#sms-messages)\n    - [Get a list of SMS messages](#get-a-list-of-sms-messages)\n    - [Get an SMS message](#get-an-sms-message)\n  - [SMS Webhooks](#sms-webhooks)\n    - [Get a list of SMS webhooks](#get-a-list-of-sms-webhooks)\n    - [Get a single SMS webhook](#get-a-single-sms-webhook)\n    - [Create an SMS webhook](#create-an-sms-webhook)\n    - [Update a single SMS webhook](#update-a-single-sms-webhook)\n    - [Delete an SMS webhook](#delete-an-sms-webhook)\n    - [Get a list of SMS webhooks](#get-a-list-of-sms-webhooks-1)\n  - [SMS Inbouds](#sms-inbouds)\n    - [Get a list of SMS inbound routes](#get-a-list-of-sms-inbound-routes)\n    - [Get a single SMS inbound route](#get-a-single-sms-inbound-route)\n    - [Create an SMS inbound route](#create-an-sms-inbound-route)\n    - [Update an SMS inbound route](#update-an-sms-inbound-route)\n    - [Delete an SMS inbound route](#delete-an-sms-inbound-route)\n  - [Sender Identities](#sender-identities)\n    - [Get a list of sender identities](#get-a-list-of-sender-identities)\n    - [Get a sender identity](#get-a-sender-identity)\n    - [Create a sender identity](#create-a-sender-identity)\n    - [Update a sender identity](#update-a-sender-identity)\n    - [Delete a sender identity](#delete-a-sender-identity)\n  - [API Quota](#api-quota)\n    - [Get API Quota](#get-api-quota)\n- [Troubleshooting](#troubleshooting)\n  - [Emails not being sent](#emails-not-being-sent)\n- [Testing](#testing)\n- [Available endpoints](#available-endpoints)\n- [Support and Feedback](#support-and-feedback)\n- [License](#license)\n\n<a name=\"installation\"></a>\n\n# Installation\n\n```\n$ python -m pip install mailersend\n```\n\n## Requirements\n\n- Python > 3.6.1\n- Python `pip`\n- An API Key from [mailersend.com](https://www.mailersend.com)\n\n## Authentication\n\nWe recommend you to define `MAILERSEND_API_KEY` environment variable in the `.env` file, and use it to store the API key.\n\n- Using environment variable\n```python\nfrom mailersend import emails\n\n# assigning NewEmail() without params defaults to MAILERSEND_API_KEY env var\nmailer = emails.NewEmail()\n\n# define an empty dict to populate with mail values\nmail_body = {}\n\nmail_from = {\n    \"name\": \"Your Name\",\n    \"email\": \"your@domain.com\",\n}\n\nrecipients = [\n    {\n        \"name\": \"Your Client\",\n        \"email\": \"your@client.com\",\n    }\n]\n\nreply_to = {\n    \"name\": \"Name\",\n    \"email\": \"reply@domain.com\",\n}\n\nmailer.set_mail_from(mail_from, mail_body)\nmailer.set_mail_to(recipients, mail_body)\nmailer.set_subject(\"Hello!\", mail_body)\nmailer.set_html_content(\"This is the HTML content\", mail_body)\nmailer.set_plaintext_content(\"This is the text content\", mail_body)\nmailer.set_reply_to(reply_to, mail_body)\n\n# using print() will also return status code and data\nmailer.send(mail_body)\n```\n\n- Explicit declaration\n```python\nfrom mailersend import emails\n\nmailer = emails.NewEmail(\"my-api-key\")\n\n# define an empty dict to populate with mail values\nmail_body = {}\n\nmail_from = {\n    \"name\": \"Your Name\",\n    \"email\": \"your@domain.com\",\n}\n\nrecipients = [\n    {\n        \"name\": \"Your Client\",\n        \"email\": \"your@client.com\",\n    }\n]\n\nreply_to = {\n    \"name\": \"Name\",\n    \"email\": \"reply@domain.com\",\n}\n\nmailer.set_mail_from(mail_from, mail_body)\nmailer.set_mail_to(recipients, mail_body)\nmailer.set_subject(\"Hello!\", mail_body)\nmailer.set_html_content(\"This is the HTML content\", mail_body)\nmailer.set_plaintext_content(\"This is the text content\", mail_body)\nmailer.set_reply_to(reply_to, mail_body)\n\n# using print() will also return status code and data\nmailer.send(mail_body)\n```\n\n# Usage\n\n## Email\n\n### Send an email\n\n```python\nfrom mailersend import emails\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = emails.NewEmail(os.getenv('MAILERSEND_API_KEY'))\n\n# define an empty dict to populate with mail values\nmail_body = {}\n\nmail_from = {\n    \"name\": \"Your Name\",\n    \"email\": \"your@domain.com\",\n}\n\nrecipients = [\n    {\n        \"name\": \"Your Client\",\n        \"email\": \"your@client.com\",\n    }\n]\n\nreply_to = {\n    \"name\": \"Name\",\n    \"email\": \"reply@domain.com\",\n}\n\nmailer.set_mail_from(mail_from, mail_body)\nmailer.set_mail_to(recipients, mail_body)\nmailer.set_subject(\"Hello!\", mail_body)\nmailer.set_html_content(\"This is the HTML content\", mail_body)\nmailer.set_plaintext_content(\"This is the text content\", mail_body)\nmailer.set_reply_to(reply_to, mail_body)\n\n# using print() will also return status code and data\nmailer.send(mail_body)\n```\n\n### Add CC, BCC recipients\n\n```python\nfrom mailersend import emails\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = emails.NewEmail(os.getenv('MAILERSEND_API_KEY'))\n\n# define an empty dict to populate with mail values\nmail_body = {}\n\nmail_from = {\n    \"name\": \"Your Name\",\n    \"email\": \"your@domain.com\",\n}\n\nrecipients = [\n    {\n        \"name\": \"Your Client\",\n        \"email\": \"your@client.com\",\n    }\n]\n\ncc = [\n    {\n        \"name\": \"CC\",\n        \"email\": \"cc@client.com\"\n    }\n]\n\nbcc = [\n    {\n        \"name\": \"BCC\",\n        \"email\": \"bcc@client.com\"\n    }\n]\n\nmailer.set_mail_from(mail_from, mail_body)\nmailer.set_mail_to(recipients, mail_body)\nmailer.set_subject(\"Hello!\", mail_body)\nmailer.set_html_content(\"This is the HTML content\", mail_body)\nmailer.set_plaintext_content(\"This is the text content\", mail_body)\nmailer.set_cc_recipients(cc, mail_body)\nmailer.set_bcc_recipients(bcc, mail_body)\n\nmailer.send(mail_body)\n```\n\n### Send a template-based email\n\n```python\nfrom mailersend import emails\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = emails.NewEmail(os.getenv('MAILERSEND_API_KEY'))\n\n# define an empty dict to populate with mail values\nmail_body = {}\n\nmail_from = {\n    \"name\": \"Your Name\",\n    \"email\": \"your@domain.com\",\n}\n\nrecipients = [\n    {\n        \"name\": \"Your Client\",\n        \"email\": \"your@client.com\",\n    }\n]\n\n\nvariables = [\n    {\n        \"email\": \"your@client.com\",\n        \"substitutions\": [\n            {\n                \"var\": \"foo\",\n                \"value\": \"bar\"\n            },\n        ]\n    }\n]\n\n\nmailer.set_mail_from(mail_from, mail_body)\nmailer.set_mail_to(recipients, mail_body)\nmailer.set_subject(\"Hello from {$company}\", mail_body)\nmailer.set_template(\"templateID\", mail_body)\nmailer.set_simple_personalization(variables, mail_body)\n\nmailer.send(mail_body)\n```\n\n### Advanced personalization\n\n```python\nfrom mailersend import emails\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = emails.NewEmail(os.getenv('MAILERSEND_API_KEY'))\n\n# define an empty dict to populate with mail values\nmail_body = {}\n\nmail_from = {\n    \"name\": \"Your Name\",\n    \"email\": \"your@domain.com\",\n}\n\nrecipients = [\n    {\n        \"name\": \"Your Client\",\n        \"email\": \"your@client.com\",\n    }\n]\n\npersonalization = [\n    {\n        \"email\": \"test@mailersend.com\",\n        \"data\": {\n            \"var\": \"value\",\n            \"boolean\": True,\n            \"object\": {\n                \"key\" : \"object-value\"\n            },\n            \"number\": 2,\n            \"array\": [\n                1,\n                2,\n                3\n            ]\n        }\n    }\n]\n\n\nmailer.set_mail_from(mail_from, mail_body)\nmailer.set_mail_to(recipients, mail_body)\nmailer.set_subject(\"Hello from {$company}\", mail_body)\nmailer.set_html_content(\"This is the HTML content, {$name}\", mail_body)\nmailer.set_plaintext_content(\"This is the text content, {$name}\", mail_body)\nmailer.set_advanced_personalization(personalization, mail_body)\n\nmailer.send(mail_body)\n```\n\n### Simple personalization\n\n```python\nfrom mailersend import emails\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = emails.NewEmail(os.getenv('MAILERSEND_API_KEY'))\n\n# define an empty dict to populate with mail values\nmail_body = {}\n\nmail_from = {\n    \"name\": \"Your Name\",\n    \"email\": \"your@domain.com\",\n}\n\nrecipients = [\n    {\n        \"name\": \"Your Client\",\n        \"email\": \"your@client.com\",\n    }\n]\n\nvariables = [\n    {\n        \"email\": \"your@client.com\",\n        \"substitutions\": [\n            {\n                \"var\": \"foo\",\n                \"value\": \"bar\"\n            },\n        ]\n    }\n]\n\n\nmailer.set_mail_from(mail_from, mail_body)\nmailer.set_mail_to(recipients, mail_body)\nmailer.set_subject(\"Hello from {$foo}\", mail_body)\nmailer.set_html_content(\"This is the HTML content, {$foo}\", mail_body)\nmailer.set_plaintext_content(\"This is the text content, {$foo}\", mail_body)\nmailer.set_simple_personalization(variables, mail_body)\n\nmailer.send(mail_body)\n```\n\n### Send email with attachment\n\n```python\nfrom mailersend import emails\nimport base64\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = emails.NewEmail(os.getenv('MAILERSEND_API_KEY'))\n\n# define an empty dict to populate with mail values\nmail_body = {}\n\nmail_from = {\n    \"name\": \"Your Name\",\n    \"email\": \"your@domain.com\",\n}\n\nrecipients = [\n    {\n        \"name\": \"Your Client\",\n        \"email\": \"your@client.com\",\n    }\n]\n\nvariables = [\n    {\n        \"email\": \"your@client.com\",\n        \"substitutions\": [\n            {\n                \"var\": \"foo\",\n                \"value\": \"bar\"\n            },\n        ]\n    }\n]\n\nattachment = open('path-to-file', 'rb')\natt_read = attachment.read()\natt_base64 = base64.b64encode(bytes(att_read))\nattachments = [\n    {\n        \"id\": \"my-attached-file\",\n        \"filename\": \"file.jpg\",\n        \"content\": f\"{att_base64.decode('ascii')}\",\n        \"disposition\": \"attachment\"\n    }\n]\n\nmailer.set_mail_from(mail_from, mail_body)\nmailer.set_mail_to(recipients, mail_body)\nmailer.set_subject(\"Hello from {$foo}\", mail_body)\nmailer.set_html_content(\"This is the HTML content, {$foo}\", mail_body)\nmailer.set_plaintext_content(\"This is the text content, {$foo}\", mail_body)\nmailer.set_simple_personalization(variables, mail_body)\nmailer.set_attachments(attachments, mail_body)\n\nmailer.send(mail_body)\n```\n\n## Email Verification\n\n### Get all email verification lists\n\n```python\nfrom mailersend import email_verification\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = email_verification.NewEmailVerification(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.get_all_lists()\n```\n\n### Get a single email verification list\n\n```python\nfrom mailersend import email_verification\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = email_verification.NewEmailVerification(os.getenv('MAILERSEND_API_KEY'))\n\nemail_verification_list_id = 123456\n\nmailer.get_list(email_verification_list_id)\n```\n\n### Create a email verification list\n\n```python\nfrom mailersend import email_verification\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = email_verification.NewEmailVerification(os.getenv('MAILERSEND_API_KEY'))\n\nname = \"My List\"\nemails = [\n    \"some@email.com\",\n    \"another@email.com\"\n]\n\nmailer.create_list(name, emails)\n```\n\n### Verify a list\n\n```python\nfrom mailersend import email_verification\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = email_verification.NewEmailVerification(os.getenv('MAILERSEND_API_KEY'))\n\nemail_verification_list_id = 123456\n\nmailer.verify_list(email_verification_list_id)\n```\n\n### Get list results\n\n```python\nfrom mailersend import email_verification\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = email_verification.NewEmailVerification(os.getenv('MAILERSEND_API_KEY'))\n\nemail_verification_list_id = 123456\n\nmailer.get_list_results(email_verification_list_id)\n```\n\n\n## Bulk Email\n\n### Send bulk email\n\n```python\nfrom mailersend import emails\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = emails.NewEmail(os.getenv('MAILERSEND_API_KEY'))\n\nmail_list = [\n  {\n    \"from\": {\n      \"email\": \"your@domain.com\",\n      \"name\": \"Your Name\"\n    },\n    \"to\": [\n      {\n        \"email\": \"your@client.com\",\n        \"name\": \"Your Client\"\n      }\n    ],\n    \"subject\": \"Subject\",\n    \"text\": \"This is the text content\",\n    \"html\": \"<p>This is the HTML content</p>\",\n  },\n  {\n    \"from\": {\n      \"email\": \"your@domain.com\",\n      \"name\": \"Your Name\"\n    },\n    \"to\": [\n      {\n        \"email\": \"your@client.com\",\n        \"name\": \"Your Client\"\n      }\n    ],\n    \"subject\": \"Subject\",\n    \"text\": \"This is the text content\",\n    \"html\": \"<p>This is the HTML content</p>\",\n  }\n]\n\nprint(mailer.send_bulk(mail_list))\n```\n\n### Get bulk email status\n\n```python\nfrom mailersend import emails\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = emails.NewEmail(os.getenv('MAILERSEND_API_KEY'))\n\nprint(mailer.get_bulk_status_by_id(\"bulk-email-id\"))\n```\n\n<a name=\"activity\"></a>\n\n## Activity\n\n### Get a list of activities (simple)\n\n```python\nfrom mailersend import activity\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = activity.NewActivity(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.get_domain_activity(\"domain-id\")\n```\n\n### Get a list of activities (full)\n\n```python\nfrom mailersend import activity\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = activity.NewActivity(os.getenv('MAILERSEND_API_KEY'))\n\npage = 1\nlimit = 20\ndate_from = 1623073576\ndate_to = 1623074976\nevents = [\n    \"queued\",\n    \"sent\",\n    \"delivered\",\n    \"soft-bounced\",\n    \"hard-bounced\",\n    \"junk\",\n    \"opened\",\n    \"clicked\",\n    \"unsubscribed\",\n    \"spam_complaints\",\n]\n\nmailer.get_domain_activity(\"domain-id\", page, limit, date_from, date_to, events)\n```\n\n## Analytics\n\n### Activity data by date\n\n```python\nfrom mailersend import analytics\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = analytics.NewAnalytics(os.getenv('MAILERSEND_API_KEY'))\n\ndate_from = 1623073576\ndate_to = 1623074976\nevents = [\n    \"sent\",\n]\n\n# optional arguments\ndomain_id = \"domain-id\"\ngroup_by = \"days\"\n\nmailer.get_activity_by_date(date_from, date_to, events, domain_id, group_by)\n```\n\n### Opens by country\n\n```python\nfrom mailersend import analytics\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = analytics.NewAnalytics(os.getenv('MAILERSEND_API_KEY'))\n\ndate_from = 1623073576\ndate_to = 1623074976\n\n# optional arguments\ndomain_id = \"domain-id\"\n\nmailer.get_opens_by_country(date_from, date_to, domain_id)\n```\n\n### Opens by user-agent name\n\n```python\nfrom mailersend import analytics\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = analytics.NewAnalytics(os.getenv('MAILERSEND_API_KEY'))\n\ndate_from = 1623073576\ndate_to = 1623074976\n\n# optional arguments\ndomain_id = \"domain-id\"\n\nmailer.get_opens_by_user_agent(date_from, date_to, domain_id)\n```\n\n### Opens by reading environment\n\n```python\nfrom mailersend import analytics\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = analytics.NewAnalytics(os.getenv('MAILERSEND_API_KEY'))\n\ndate_from = 1623073576\ndate_to = 1623074976\n\n# optional arguments\ndomain_id = \"domain-id\"\n\nmailer.get_opens_by_reading_environment(date_from, date_to, domain_id)\n```\n\n## Inbound Routes\n\n### Get a list of inbound routes\n\n```python\nfrom mailersend import inbound_routing\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = inbound_routing.NewInbound(os.getenv('MAILERSEND_API_KEY'))\n\nprint(mailer.get_inbound_routes())\n```\n\n### Get a single inbound route\n\n```python\nfrom mailersend import inbound_routing\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = inbound_routing.NewInbound(os.getenv('MAILERSEND_API_KEY'))\n\nprint(mailer.get_inbound_by_id(\"inbound-id\"))\n```\n\n### Add an inbound route\n\n```python\nfrom mailersend import inbound_routing\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = inbound_routing.NewInbound(os.getenv('MAILERSEND_API_KEY'))\n\noptions = {}\n\n_catch_filter = {\n    \"type\": \"catch_recipient\",\n    \"filters\": [\n        {\n            \"comparer\": \"equal\",\n            \"value\": \"test\"\n        }\n    ]\n}\n\n_match_filter = {\n    \"type\": \"match_all\"\n}\n\n_forwards = [\n    {\n        \"type\": \"webhook\",\n        \"value\": \"https://www.mailersend.com/hook\"\n    }\n]\nmailer.set_name(\"Example route\", options)\nmailer.set_domain_enabled(True, options)\nmailer.set_inbound_domain(\"test.mailersend.com\", options)\nmailer.set_catch_filter(_catch_filter, options)\n\nprint(mailer.add_inbound_route())\n```\n\n### Update an inbound route\n\n```python\nfrom mailersend import inbound_routing\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nroute_id = \"inbound-route-id\"\n\nmailer = inbound_routing.NewInbound(os.getenv('MAILERSEND_API_KEY'))\n\noptions = {}\n\n_catch_filter = {\n    \"type\": \"catch_recipient\",\n    \"filters\": [\n        {\n            \"comparer\": \"equal\",\n            \"value\": \"test\"\n        }\n    ]\n}\n\n_match_filter = {\n    \"type\": \"match_all\"\n}\n\n_forwards = [\n    {\n        \"type\": \"webhook\",\n        \"value\": \"https://www.mailersend.com/hook\"\n    }\n]\nmailer.set_name(\"Example route\", options)\nmailer.set_domain_enabled(True, options)\nmailer.set_inbound_domain(\"test.mailersend.com\", options)\nmailer.set_catch_filter(_catch_filter, options)\n\nprint(mailer.update_inbound_route(route_id))\n```\n\n### Delete an inbound route\n\n```python\nfrom mailersend import inbound_routing\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nroute_id = \"inbound-route-id\"\n\nmailer = inbound_routing.NewInbound(os.getenv('MAILERSEND_API_KEY'))\n\nprint(mailer.delete_inbound_route(route_id))\n```\n\n## Domains\n\n### Get a list of domains\n\n```python\nfrom mailersend import domains\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = domains.NewDomain(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.get_domains()\n```\n\n### Get a single domain\n\n```python\nfrom mailersend import domains\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = domains.NewDomain(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.get_domain_by_id(\"domain-id\")\n```\n\n### Get a single domain using helper function\n\n```python\nfrom mailersend import domains\nfrom mailersend import utils\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = domains.NewDomain(os.getenv('MAILERSEND_API_KEY'))\nhelper = utils.NewHelper(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.get_domain_by_id(helper.get_id_by_name(\"domains\",\"domain-name\"))\n```\n\n### Add a domain\n\nYou can find a full list of settings [here](https://developers.mailersend.com/api/v1/domains.html#request-parameters-3).\n\n```python\nfrom mailersend import domains\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = domains.NewDomain(os.getenv('MAILERSEND_API_KEY'))\n\ndomain_data = {\n    \"name\": \"mydomain.com\",\n    \"return_path_subdomain\": \"rpsubdomain\",\n    \"custom_tracking_subdomain\": \"ctsubdomain\",\n    \"inbound_routing_subdomain\": \"irsubdomain\"\n}\nmailer.add_domain(\"name\", domain_data)\n```\n\n\n### Delete a domain\n\n```python\nfrom mailersend import domains\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = domains.NewDomain(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.delete_domain(\"domain-id\")\n```\n\n### Get a list of recipients per domain\n\n```python\nfrom mailersend import domains\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = domains.NewDomain(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.get_recipients_for_domain(\"domain-id\")\n```\n\n### Update domain settings\n\nYou can find a full list of settings [here](https://developers.mailersend.com/api/v1/domains.html#request-body).\n\n```python\nfrom mailersend import domains\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = domains.NewDomain(os.getenv('MAILERSEND_API_KEY'))\n\ndomain_data = {\n    \"send_paused\": True,\n    \"track_clicks\": True,\n    \"track_opens\": True,\n    \"track_unsubscribe\": True,\n    \"track_unsubscribe_html\": \"<p>Click to <a href='{$unsubscribe}'>unsubscribe</a></p>\",\n    \"track_unsubscribe_plain\": \"Click to unsubscribe: {$unsubscribe}\",\n    \"track_content\": True,\n    \"custom_tracking_enabled\": True,\n    \"custom_tracking_subdomain\": \"email\",\n    \"precedence_bulk\": False\n}\n\nmailer.update_domain_setting(\"domain-id\", domain_data)\n```\n\n### Get DNS Records\n\n```python\nfrom mailersend import domains\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = domains.NewDomain(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.get_dns_records(\"domain-id\")\n```\n\n### Verify a domain\n\n```python\nfrom mailersend import domains\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = domains.NewDomain(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.verify_domain(\"domain-id\")\n```\n\n\n## Messages\n\n### Get a list of messages\n\n```python\nfrom mailersend import messages\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = messages.NewMessage(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.get_messages()\n```\n\n### Get a single message\n\n```python\nfrom mailersend import messages\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = messages.NewMessage(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.get_message_by_id(\"message-id\")\n```\n\n## Scheduled messages\n\n### Get a list of scheduled messages\n\n```python\nfrom mailersend import scheduled_messages\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = scheduled_messages.NewMessageSchedule(os.getenv('MAILERSEND_API_KEY'))\n\nprint(mailer.get_scheduled_messages())\n```\n\n### Get a single scheduled message\n\n```python\nfrom mailersend import scheduled_messages\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = scheduled_messages.NewMessageSchedule(os.getenv('MAILERSEND_API_KEY'))\n\nprint(mailer.get_scheduled_message_by_id(\"scheduled-message-id\"))\n```\n\n### Delete a scheduled message\n\n```python\nfrom mailersend import scheduled_messages\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = scheduled_messages.NewMessageSchedule(os.getenv('MAILERSEND_API_KEY'))\n\nprint(mailer.delete_scheduled_message(\"scheduled-message-id\"))\n```\n\n## Recipients\n\n### Get a list of recipients\n\n```python\nfrom mailersend import recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.get_recipients()\n```\n\n### Get a single recipient\n\n```python\nfrom mailersend import recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.get_recipient_by_id(\"recipient-id\")\n```\n\n### Delete a recipient\n\n```python\nfrom mailersend import recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.delete_recipient(\"recipient-id\")\n```\n\n### Get recipients from a blocklist\n\n```python\nfrom mailersend import recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.get_recipients_from_blocklist(\"domain-id\")\n```\n\n### Get recipients from hard bounces\n\n```python\nfrom mailersend import recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.get_hard_bounces(\"domain-id\")\n```\n\n### Get recipients from spam complaints\n\n```python\nfrom mailersend import recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.get_spam_complaints(\"domain-id\")\n```\n\n### Get recipients from unsubscribes\n\n```python\nfrom mailersend import recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.get_unsubscribes(\"domain-id\")\n```\n\n### Add recipients to blocklist\n\nUsing recipients:\n\n```python\nfrom mailersend import recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))\n\nrecipient_list = [\n    'blocked@client.com'\n]\n\nmailer.add_to_blocklist(\"domain-id\", recipients=recipient_list)\n```\n\nUsing patterns:\n\n```python\nfrom mailersend import recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))\n\nrecipient_patterns = [\n    '*@client.com'\n]\n\nmailer.add_to_blocklist(\"domain-id\", patterns=recipient_patterns)\n```\n\n### Add hard bounced recipients\n\n```python\nfrom mailersend import recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))\n\nrecipient_list = [\n    \"your@client.com\"\n]\n\nmailer.add_hard_bounces(\"domain-id\", recipient_list)\n```\n\n### Add spam complaints\n\n```python\nfrom mailersend import recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))\n\nrecipient_list = [\n    \"your@client.com\"\n]\n\nmailer.add_spam_complaints(\"domain-id\", recipient_list)\n```\n\n### Add recipients to unsubscribe list\n\n```python\nfrom mailersend import recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))\n\nrecipient_list = [\n    \"your@client.com\"\n]\n\nmailer.add_unsubscribes(\"domain-id\", recipient_list)\n```\n\n### Delete recipients from blocklist\n\n```python\nfrom mailersend import recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))\n\nrecipient_list = [\n    \"your@client.com\"\n]\n\nmailer.delete_from_blocklist(\"domain-id\", recipient_list)\n```\n\n### Delete hard bounced recipients\n\n```python\nfrom mailersend import recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))\n\nrecipient_list = [\n    \"your@client.com\"\n]\n\nmailer.delete_hard_bounces(\"domain-id\", recipient_list)\n```\n\n### Delete spam complaints\n\n```python\nfrom mailersend import recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))\n\nrecipient_list = [\n    \"your@client.com\"\n]\n\nmailer.delete_spam_complaints(\"domain-id\", recipient_list)\n```\n\n### Delete recipients from unsubscribe list\n\n```python\nfrom mailersend import recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = recipients.NewRecipient(os.getenv('MAILERSEND_API_KEY'))\n\nrecipient_list = [\n    \"your@client.com\"\n]\n\nmailer.delete_unsubscribes(\"domain-id\", recipient_list)\n```\n\n## Tokens\n\n### Create a token\n\n```python\nfrom mailersend import tokens\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = tokens.NewToken(os.getenv('MAILERSEND_API_KEY'))\n\nscopes = [\"email_full\", \"analytics_read\"]\n\nmailer.create_token(\"my-token\", scopes)\n```\n\nBecause of security reasons, we only allow access token appearance once during creation. In order to see the access token created you can do:\n\n```python\nfrom mailersend import tokens\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = tokens.NewToken(os.getenv('MAILERSEND_API_KEY'))\n\nscopes = [\"email_full\", \"analytics_read\"]\n\nprint(mailer.create_token(\"my-token\", scopes))\n```\n\n### Pause / Unpause Token\n\n```python\nfrom mailersend import tokens\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = tokens.NewToken(os.getenv('MAILERSEND_API_KEY'))\n\n# pause\nmailer.update_token(\"my-token\")\n\n# unpause\nmailer.update_token(\"my-token\", pause=False)\n```\n\n### Delete a Token\n\n```python\nfrom mailersend import tokens\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = tokens.NewToken(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.delete_token(\"token-id\")\n```\n\n## Templates\n\n### Get a list of templates\n\n```python\nfrom mailersend import templates\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = templates.NewTemplate(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.get_templates()\n```\n\n### Get a single template\n\n```python\nfrom mailersend import templates\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = templates.NewTemplate(os.getenv('MAILERSEND_API_KEY'))\ntemplate_id = 1234\n\nmailer.get_template_by_id()\n```\n\n### Delete template\n\n```python\nfrom mailersend import templates\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = templates.NewTemplate(os.getenv('MAILERSEND_API_KEY'))\ntemplate_id = 1234\n\nmailer.delete_template()\n```\n\n## Webhooks\n\n### Get a list of webhooks\n\n```python\nfrom mailersend import webhooks\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = webhooks.NewWebhook(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.get_webhooks(\"domain-id\")\n```\n\n### Get a single webhook\n\n```python\nfrom mailersend import webhooks\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = webhooks.NewWebhook(os.getenv('MAILERSEND_API_KEY'))\n\nmailer.get_webhook_by_id(\"webhook-id\")\n```\n\n### Create a Webhook\n\n```python\nfrom mailersend import webhooks\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nwebhookEvents = ['activity.sent', 'activity.delivered']\n\nwebhook = webhooks.NewWebhook(os.getenv('MAILERSEND_API_KEY'))\nwebhook.set_webhook_url(\"https://webhooks.mysite.com\")\nwebhook.set_webhook_name(\"my first webhook\")\nwebhook.set_webhook_events(webhookEvents)\nwebhook.set_webhook_domain(\"domain-id\")\n\nwebhook.create_webhook()\n```\n\n### Create a disabled webhook\n\n```python\nfrom mailersend import webhooks\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nwebhookEvents = ['activity.sent', 'activity.delivered']\n\nwebhook = webhooks.NewWebhook(os.getenv('MAILERSEND_API_KEY'))\nwebhook.set_webhook_url(\"https://webhooks.mysite.com\")\nwebhook.set_webhook_name(\"my first webhook\")\nwebhook.set_webhook_events(webhookEvents)\nwebhook.set_webhook_domain(\"domain-id\")\nwebhook.set_webhook_enabled(False)\n\nwebhook.create_webhook()\n```\n\n### Update a Webhook\n\n```python\nfrom mailersend import webhooks\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nwebhook = webhooks.NewWebhook(os.getenv('MAILERSEND_API_KEY'))\n\nwebhook.update_webhook(\"webhook-id\", \"name\", \"a new webhook name\")\n```\n\n### Disable/Enable a Webhook\n\n```python\nfrom mailersend import webhooks\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nwebhook = webhooks.NewWebhook(os.getenv('MAILERSEND_API_KEY'))\n\nwebhook.update_webhook(\"webhook-id\", \"enabled\", False)\n```\n\n### Delete a Webhook\n\n```python\nfrom mailersend import webhooks\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nwebhook = webhooks.NewWebhook(os.getenv('MAILERSEND_API_KEY'))\n\nwebhook.delete_webhook(\"webhook-id\")\n```\n\n## SMS\n\n### Sending SMS messages\n\nWithout personalization:\n```python\nfrom mailersend import sms_sending\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_sending.NewSmsSending(os.getenv('MAILERSEND_API_KEY'))\n\n# Number belonging to your account in E164 format\nnumber_from = \"+11234567890\"\n\n# You can add up to 50 recipient numbers\nnumbers_to = [\n    \"+11234567891\",\n    \"+11234567892\"\n]\ntext = \"This is the text content\"\n\nprint(mailer.send_sms(number_from, numbers_to, text))\n```\n\nWith personalization:\n```python\nfrom mailersend import sms_sending\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_sending.NewSmsSending(os.getenv('MAILERSEND_API_KEY'))\n\n# Number belonging to your account in E164 format\nnumber_from = \"+11234567890\"\n\n# You can add up to 50 recipient numbers\nnumbers_to = [\n    \"+11234567891\",\n    \"+11234567892\"\n]\ntext = \"Hi {{name}} how are you?\"\npersonalization = [\n    {\n        \"phone_number\": \"+11234567891\",\n        \"data\": {\n            \"name\": \"Mike\"\n        }\n    },\n    {\n        \"phone_number\": \"+11234567892\",\n        \"data\": {\n            \"name\": \"John\"\n        }\n    }\n]\n\nprint(mailer.send_sms(number_from, numbers_to, text, personalization))\n```\n\n## SMS Activity\n\n### Get a list of activities\n```python\nfrom mailersend import sms_activity\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_activity.NewSmsActivity(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nsms_number_id = 1365743\ndate_from = 1655157601\ndate_to = 1655158601\nstatus = [\"queued\", \"failed\"]\npage = 1\nlimit = 200\n\nprint(mailer.get_activities(sms_number_id=sms_number_id, date_from=date_from, date_to=date_to, status=status, page=page, limit=limit))\n```\n\n### Get activity of a single message\n```python\nfrom mailersend import sms_activity\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_activity.NewSmsActivity(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nsms_message_id = \"62a9d12b07852eaf2207b417\"\n\nprint(mailer.get_activity(sms_message_id))\n```\n\n## SMS Phone Numbers\n\n### Get a list of SMS phone numbers\n```python\nfrom mailersend import sms_phone_numbers\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_phone_numbers.NewSmsNumbers(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\npaused = False\n\nprint(mailer.get_phone_numbers(paused))\n```\n\n### Get an SMS phone number\n```python\nfrom mailersend import sms_phone_numbers\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_phone_numbers.NewSmsNumbers(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nsms_number_id = \"9pq3enl6842vwrzx\"\n\nprint(mailer.get_phone_number(sms_number_id))\n```\n\n### Update a single SMS phone number\n```python\nfrom mailersend import sms_phone_numbers\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_phone_numbers.NewSmsNumbers(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nsms_number_id = \"9pq3enl6842vwrzx\"\npaused = True\n\nprint(mailer.update_phone_number(sms_number_id, paused))\n```\n\n### Delete an SMS phone number\n```python\nfrom mailersend import sms_phone_numbers\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_phone_numbers.NewSmsNumbers(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nsms_number_id = \"9pq3enl6842vwrzx\"\n\nprint(mailer.delete_phone_number(sms_number_id))\n```\n\n## SMS Recipients\n\n### Get a list of SMS recipients\n```python\nfrom mailersend import sms_recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_recipients.NewSmsRecipients(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nsms_number_id = \"9pq3enl6842vwrzx\"\nstatus = \"active\"\n\nprint(mailer.get_recipients(status=status, sms_number_id=sms_number_id))\n```\n\n### Get an SMS recipient\n```python\nfrom mailersend import sms_recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_recipients.NewSmsRecipients(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nsms_recipient_id = \"627e756fd30078fb2208cc87\"\n\nprint(mailer.get_recipient(sms_recipient_id))\n```\n\n### Update a single SMS recipient\n```python\nfrom mailersend import sms_recipients\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_recipients.NewSmsRecipients(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nsms_recipient_id = \"627e756fd30078fb2208cc87\"\nstatus = \"opt_out\"\n\nprint(mailer.update_recipient(sms_recipient_id, status))\n```\n\n## SMS Messages\n\n### Get a list of SMS messages\n```python\nfrom mailersend import sms_messages\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_messages.NewSmsMessages(os.getenv('MAILERSEND_API_KEY'))\n\nprint(mailer.get_messages())\n```\n\n### Get an SMS message\n```python\nfrom mailersend import sms_messages\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\n#Request parameters\nsms_message_id = \"627e756fd30078fb2208cc87\"\n\nmailer = sms_messages.NewSmsMessages(os.getenv('MAILERSEND_API_KEY'))\n\nprint(mailer.get_message(sms_message_id))\n```\n\n## SMS Webhooks\n\n### Get a list of SMS webhooks\n```python\nfrom mailersend import sms_webhooks\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_webhooks.NewSmsWebhooks(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nsms_number_id = \"9pq3enl6842vwrzx\"\n\nprint(mailer.get_webhooks(sms_number_id))\n```\n\n### Get a single SMS webhook\n```python\nfrom mailersend import sms_webhooks\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_webhooks.NewSmsWebhooks(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nsms_webhook_id = \"aaui13enl12f2vzx\"\n\nprint(mailer.get_webhook(sms_webhook_id))\n```\n\n### Create an SMS webhook\n```python\nfrom mailersend import sms_webhooks\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_webhooks.NewSmsWebhooks(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nurl = \"https://webhook-url.com\"\nname = \"My Webhook Name\"\nevents = [\"sms.sent\"]\nsms_number_id = \"9pq3enl6842vwrzx\"\nenabled = True\n\nprint(mailer.create_webhook(url, name, events, sms_number_id, enabled))\n```\n\n### Update a single SMS webhook\n```python\nfrom mailersend import sms_webhooks\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_webhooks.NewSmsWebhooks(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nurl = \"https://different-url.com\"\nname = \"New Webhook Name\"\nevents = [\"sms.sent\", \"sms.failed\"],\nsms_webhook_id = \"aaui13enl12f2vzx\"\nenabled = False\n\nprint(mailer.update_webhook(sms_webhook_id, url, name, events, enabled))\n```\n\n### Delete an SMS webhook\n```python\nfrom mailersend import sms_webhooks\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_webhooks.NewSmsWebhooks(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nsms_webhook_id = \"aaui13enl12f2vzx\"\n\nprint(mailer.delete_webhook(sms_webhook_id))\n```\n\n### Get a list of SMS webhooks\n```python\nfrom mailersend import sms_webhooks\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_webhooks.NewSmsWebhooks(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nsms_number_id = \"9pq3enl6842vwrzx\"\n\nprint(mailer.get_webhooks(sms_number_id))\n```\n\n## SMS Inbouds\n\n### Get a list of SMS inbound routes\n```python\nfrom mailersend import sms_inbounds\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_inbounds.NewSmsInbounds(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nsms_number_id = \"123456789\"\nenabled = True\npage = 1\nlimit = 25\n\nprint(mailer.get_inbound_routes(sms_number_id, enabled, page, limit))\n```\n\n### Get a single SMS inbound route\n```python\nfrom mailersend import sms_inbounds\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_inbounds.NewSmsInbounds(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nsms_inbound_id = \"123456789\"\n\nprint(mailer.get_inbound_route(sms_inbound_id))\n```\n\n### Create an SMS inbound route\n```python\nfrom mailersend import sms_inbounds\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_inbounds.NewSmsInbounds(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nsms_number_id = \"123456789\"\nname = \"My route\"\nforward_url = \"https://some.url\"\nfilter = {\n    \"comparer\": \"equal\",\n    \"value\": \"START\"\n}\nenabled = True\n\nprint(mailer.create_inbound_route(sms_number_id, name, forward_url, filter, enabled))\n```\n\n### Update an SMS inbound route\n```python\nfrom mailersend import sms_inbounds\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_inbounds.NewSmsInbounds(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nsms_number_id = \"123456789\"\nname = \"New name\"\nforward_url = \"https://news.url\"\nfilter = {\n    \"comparer\": \"contains\",\n    \"value\": \"some-value\"\n}\nenabled = True\n\nprint(mailer.update_inbound_route(sms_number_id, name, forward_url, filter, enabled))\n```\n\n### Delete an SMS inbound route\n```python\nfrom mailersend import sms_inbounds\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sms_inbounds.NewSmsInbounds(os.getenv('MAILERSEND_API_KEY'))\n\n#Request parameters\nsms_inbound_id = \"123456789\"\n\nprint(mailer.delete_inbound_route()(sms_inbound_id))\n```\n\n## Sender Identities\n\n### Get a list of sender identities\n```python\nfrom mailersend import sender_identities\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sender_identities.NewSenderIdentity(os.getenv('MAILERSEND_API_KEY'))\n\nprint(mailer.get_identities())\n```\n\n### Get a sender identity\n```python\nfrom mailersend import sender_identities\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sender_identities.NewSenderIdentity(os.getenv('MAILERSEND_API_KEY'))\n\nprint(mailer.get_identity(identity_id=\"12345\"))\n```\n\n### Create a sender identity\n```python\nfrom mailersend import sender_identities\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sender_identities.NewSenderIdentity(os.getenv('MAILERSEND_API_KEY'))\n\nprint(mailer.create_identity(\n    domain_id=\"123456\",\n    name=\"John Doe\",\n    email=\"email@domain.com\",\n    reply_to_email=\"reply@domain.com\",\n    reply_to_name=\"Doe John\",\n    add_note=True,\n    personal_note=\"My awesome note\",\n))\n```\n\n### Update a sender identity\n```python\nfrom mailersend import sender_identities\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sender_identities.NewSenderIdentity(os.getenv('MAILERSEND_API_KEY'))\n\nprint(mailer.update_identity(\n    identity_id=\"123456\",\n    domain_id=\"123456\",\n    name=\"Abe Doe\",\n    email=\"email@mydomain.com\",\n    reply_to_email=\"reply@mydomain.com\",\n    reply_to_name=\"Doe Abe\",\n    add_note=False\n))\n```\n\n### Delete a sender identity\n```python\nfrom mailersend import sender_identities\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = sender_identities.NewSenderIdentity(os.getenv('MAILERSEND_API_KEY'))\n\nprint(mailer.delete_identity(identity_id=\"123456\"))\n```\n\n## API Quota\n### Get API Quota\n```python\nfrom mailersend import api_quota\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nmailer = api_quota.NewApiQuota(os.getenv('MAILERSEND_API_KEY'))\n\nprint(mailer.get_quota())\n```\n\n# Troubleshooting\n\n## Emails not being sent\n\nPrint the output of `mailer.send()` to view status code and errors.\n\n```python\nfrom mailersend import emails\n\nmailer = emails.NewEmail()\n\nmail_body = {}\n\nprint(mailer.send(mail_body))\n```\n\n# Testing\n\nTBD\n\n<a name=\"endpoints\"></a>\n# Available endpoints\n\n| Feature group     | Endpoint                                | Available |\n|-------------------|-----------------------------------------|-----------|\n| Activity          | `GET activity`                          | \u2705         |\n| Analytics         | `GET analytics`                         | \u2705         |\n| Domains           | `{GET, PUT, DELETE} domains`            | \u2705         |\n| Emails            | `POST send`                             | \u2705         |\n| Messages          | `GET messages`                          | \u2705         |\n| Recipients        | `{GET, DELETE} recipients`              | \u2705         |\n| Templates         | `{GET, DELETE} templates`               | \u2705         |\n| Tokens            | `{POST, PUT, DELETE} tokens`            | \u2705         |\n| Webhooks          | `{GET, POST, PUT, DELETE} webhooks`     | \u2705         |\n| SMS Sending       | `{POST} sms`                            | \u2705         |\n| SMS Activity      | `{GET} sms-activity`                    | \u2705         |\n| SMS Phone numbers | `{GET, PUT, DELETE} sms-numbers`        | \u2705         |\n| SMS Recipients    | `{GET, PUT} sms-recipients`             | \u2705         |\n| SMS Messages      | `{GET} sms-messages`                    | \u2705         |\n| SMS Webhooks      | `{GET, POST, PUT, DELETE} sms-webhooks` | \u2705         |\n| SMS Inbounds      | `{GET, POST, PUT, DELETE} sms-inbounds` | \u2705         |\n| Sender Identities | `{GET, POST, PUT, DELETE} identities`   | \u2705         |\n| API Quota         | `{GET} api-quota`                       | \u2705         |\n\n*If, at the moment, some endpoint is not available, please use other available tools to access it. [Refer to official API docs for more info](https://developers.mailersend.com/).*\n\n\n<a name=\"support-and-feedback\"></a>\n# Support and Feedback\n\nIn case you find any bugs, submit an issue directly here in GitHub.\n\nYou are welcome to create SDK for any other programming language.\n\nIf you have any troubles using our API or SDK free to contact our support by email [info@mailersend.com](mailto:info@mailersend.com)\n\nThe official documentation is at [https://developers.mailersend.com](https://developers.mailersend.com)\n\n<a name=\"license\"></a>\n# License\n\n[The MIT License (MIT)](LICENSE)\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "The official MailerSend Python SDK",
    "version": "0.5.6",
    "project_urls": null,
    "split_keywords": [
        "mailersend",
        "mail"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "02f163690dfebbf244870ec6987f3b134d49100ace113fcb9b6287b3b8fb5371",
                "md5": "b7be35121659b2aedd46ec775f131dc3",
                "sha256": "136cd537c4449118a4599df3e144fc910542540273f80c026bb0d7b4f39ca19d"
            },
            "downloads": -1,
            "filename": "mailersend-0.5.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b7be35121659b2aedd46ec775f131dc3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7,<4.0",
            "size": 26453,
            "upload_time": "2023-09-13T12:50:48",
            "upload_time_iso_8601": "2023-09-13T12:50:48.244172Z",
            "url": "https://files.pythonhosted.org/packages/02/f1/63690dfebbf244870ec6987f3b134d49100ace113fcb9b6287b3b8fb5371/mailersend-0.5.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ec62139be58ddf7b37f04bcd123010336f1837d7c62451ab038f95e81926e1d5",
                "md5": "d964db28f80fa6867893e3b14c962b77",
                "sha256": "2d316859f7f8de1c1d666ec5c5659220dccfa312da162d78811c9b4e81bb15d8"
            },
            "downloads": -1,
            "filename": "mailersend-0.5.6.tar.gz",
            "has_sig": false,
            "md5_digest": "d964db28f80fa6867893e3b14c962b77",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7,<4.0",
            "size": 22323,
            "upload_time": "2023-09-13T12:50:50",
            "upload_time_iso_8601": "2023-09-13T12:50:50.147731Z",
            "url": "https://files.pythonhosted.org/packages/ec/62/139be58ddf7b37f04bcd123010336f1837d7c62451ab038f95e81926e1d5/mailersend-0.5.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-13 12:50:50",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "mailersend"
}