You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+51-19Lines changed: 51 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,47 @@
1
1
# openapi-client
2
2
**Send emails fast and with confidence through our easy to use [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) API interface.**
3
+
3
4
# Overview
4
-
This is the API interface to the [Mail Baby](https//mail.baby/) Mail services provided by [InterServer](https://www.interserver.net). To use this service you must have an account with us at [my.interserver.net](https://my.interserver.net).
5
+
6
+
This is the API interface to the [Mail Baby](https://mail.baby/) Mail services provided by [InterServer](https://www.interserver.net). To use this service you must have an account with us at [my.interserver.net](https://my.interserver.net).
7
+
8
+
# Mail Orders
9
+
10
+
Every sending account in MailBaby is backed by a **Mail Order** — a provisioned sending credential with a numeric `id` and a corresponding SMTP username (`mb<id>`). Most calls accept an optional `id` parameter; when omitted the API automatically selects the first active order on your account. Use `GET /mail` to list all orders, and `GET /mail/{id}` to inspect a single order including its current SMTP password.
11
+
12
+
# Sending Email
13
+
14
+
Three sending methods are available depending on your use-case:
15
+
| Endpoint | Best for ||----------|----------||`POST /mail/send`| Simple single-recipient messages ||`POST /mail/advsend`| Multiple recipients, CC/BCC, attachments, named contacts ||`POST /mail/rawsend`| Pre-built RFC 822 messages (e.g. DKIM-signed payloads) |
16
+
17
+
After a successful send each endpoint returns a `GenericResponse` whose `text` field contains the **transaction ID** assigned by the relay. This ID can later be matched against entries in `GET /mail/log` via the `mailid` query parameter.
18
+
19
+
# Filtering & Logs
20
+
21
+
`GET /mail/log` provides paginated access to every message accepted by the relay for your account. Combine any of the query parameters to narrow results — e.g. `from`, `to`, `subject`, `messageId`, `origin`, `mx`, `startDate`/`endDate`, and `delivered`.
22
+
23
+
# Blocking
24
+
25
+
Two independent mechanisms exist for suppressing unwanted email:
26
+
-**Block lists** (`GET /mail/blocks`, `POST /mail/blocks/delete`) — addresses flagged by the
27
+
system spam filters (LOCAL_BL_RCPT / MBTRAP rules in rspamd, and suspicious subjects).
custom rules you configure to reject specific senders, domains, destination addresses, or
30
+
subject-line prefixes before a message is even attempted.
31
+
32
+
5
33
# Authentication
34
+
6
35
In order to use most of the API calls you must pass credentials from the [my.interserver.net](https://my.interserver.net/) site.
7
36
We support several different authentication methods but the preferred method is to use the **API Key** which you can get from the [Account Security](https://my.interserver.net/account_security) page.
37
+
Pass your key in the `X-API-KEY` HTTP request header for every protected call.
8
38
9
39
10
40
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
data ='data_example'# str | The content of the rule. If a domain type rule then an example would be google.com. For a begins with type an example would be msgid-. For the email typer an example would be user@server.com.
89
-
user ='user_example'# str | Mail account username that will be tied to this rule. If not specified the first active mail order will be used. (optional)
118
+
data ='data_example'# str | The value to match against, interpreted according to `type`: a full email address for `email`/`destination`, a domain name for `domain`, or an alphanumeric prefix string for `startswith`.
119
+
user ='user_example'# str | Optional SMTP username of the mail order to associate this rule with (e.g. `mb20682`). If omitted the first active order is used. Valid usernames are the `username` values returned by `GET /mail`. (optional)
0 commit comments