SMTPeter

https://www.smtpeter.com/en/documentation
Admin
SMTPeter is a cloud-based email gateway service that enables reliable email delivery and tracking...
Tokens:68,502
Snippets:549
Trust Score:7.8
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### GET /v1/templates/{start}/{length}

Source: https://www.smtpeter.com/en/documentation/rest-templates

Retrieves a list of all templates. Use the start and length parameters to limit the number of templates returned. The response is a JSON array containing template IDs and names.

```APIDOC
## GET /v1/templates/{start}/{length}

### Description
Retrieves a list of all templates. Use the start and length parameters to limit the number of templates returned. The response is a JSON array containing template IDs and names.

### Method
GET

### Endpoint
https://www.smtpeter.com/v1/templates/{start}/{length}

### Parameters
#### Path Parameters
- **start** (integer) - Required - The starting index for the list of templates.
- **length** (integer) - Required - The number of templates to return.

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the template.
- **name** (string) - The name of the template.

#### Response Example
[
    {
        "id" : 1,
        "name" : "Test email"
    },
    {
        "id" : 2,
        "name" : "Test 123"
    }
]
```

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

### Templates list JSON response

Source: https://www.smtpeter.com/en/documentation/rest-templates

Example JSON array returned by the GET call to /v1/templates. Contains template id and name for each template.

```json
[
    {
        "id"    : 1,
        "name"  : "Test email"
    },
    {   "id"    : 2,
        "name"  : "Test 123"
    }
]
```

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

### Example of formatted foreach loop

Source: https://www.smtpeter.com/en/documentation/personalization

This is the example mentioned in the text that prints out names of players in a soccer team. The exact code is not shown, but the output is displayed.

```text
Ronaldo

Messi

Ibrahimovic    
```

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

### Retrieve templates list URL

Source: https://www.smtpeter.com/en/documentation/rest-templates

HTTP GET call to retrieve the list of templates. The {start} and {length} parameters limit the timeframe. Requires an API key.

```http
https://www.smtpeter.com/v1/templates/{start}/{length}
```

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

### Example JSON response for log files per date

Source: https://www.smtpeter.com/en/documentation/rest-logfiles

Example response from the logfiles method with a date parameter, returning a list of log file names for that date.

```json
[
    "attempts.2016-03-20.log",
    "clicks.2016-03-20.log",
    "opens.2016-03-20.log",
    "dmarc.2016-03-20.log"
]
```

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

### Example JSON response for available dates

Source: https://www.smtpeter.com/en/documentation/rest-logfiles

Example response from the logfiles method without parameters, returning a JSON array of dates in UTC.

```json
[ "2016-03-20", "2016-03-21", "2016-03-22" ]
// UTC time
```

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

### SMTP API DSN parameters example

Source: https://www.smtpeter.com/en/documentation/bounce-handling

Shows how to pass DSN parameters using the SMTP API with MAIL FROM and RCPT TO commands. The example includes the server responses '250 sender ok' and '250 recipient ok'.

```smtp
MAIL FROM:<alice@example.org> RET=HDRS ENVID=yourid
250 sender ok
RCPT TO:<bob@example.com> NOTIFY=SUCCESS ORCPT=rfc822;bob@example.com
250 recipient ok
```

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

### JSON address format example

Source: https://www.smtpeter.com/en/documentation/rest-send-json

Demonstrates flexible address notation for 'from', 'to', and 'cc' fields, including support for display names and arrays.

```json
{
    "from": "info@example.com",
    "to": [
        "one@example.com",
        "two@example.com",
        "\"Number three\" <three@example.com>, info@example.com"
    ],
    "cc": "John Doe <johndoe@example.org>"
}
```

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

### GET /v1/logfiles

Source: https://www.smtpeter.com/en/documentation/rest-logfiles

Retrieves an overview of all available dates for which log files are stored.

```APIDOC
## GET /v1/logfiles

### Description
Retrieves an overview of all available dates for which log files are stored.

### Method
GET

### Endpoint
https://www.smtpeter.com/v1/logfiles

### Response
#### Success Response (200)
Returns a JSON array of dates in UTC time.

#### Response Example
[
    "2016-03-20",
    "2016-03-21",
    "2016-03-22"
]
```

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

### Get events by template

Source: https://www.smtpeter.com/en/documentation/rest-events

Retrieves events for a specific template for the last monthly period. Optionally specify the start and/or end option for a different period, and filter on tags with the tags option.

```text
https://www.smtpeter.com/v1/events/template/TEMPLATE
```

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

### GET /v1/logfiles/DATE

Source: https://www.smtpeter.com/en/documentation/rest-logfiles

Retrieves a list of all log files available for a specific date.

```APIDOC
## GET /v1/logfiles/DATE

### Description
Retrieves a list of all log files available for a specific date.

### Method
GET

### Endpoint
https://www.smtpeter.com/v1/logfiles/DATE

### Parameters
#### Path Parameters
- **DATE** (string) - Required - The date in "YYYY-MM-DD" format.

### Response
#### Success Response (200)
Returns a JSON array of log file names.

#### Response Example
[
    "attempts.2016-03-20.log",
    "clicks.2016-03-20.log",
    "opens.2016-03-20.log",
    "dmarc.2016-03-20.log"
]
```

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

### GET /v1/logfiles/FILENAME

Source: https://www.smtpeter.com/en/documentation/rest-logfiles

Downloads a single log file.

```APIDOC
## GET /v1/logfiles/FILENAME

### Description
Downloads a single log file.

### Method
GET

### Endpoint
https://www.smtpeter.com/v1/logfiles/FILENAME

### Parameters
#### Path Parameters
- **FILENAME** (string) - Required - The name of the log file to download.

### Response
#### Success Response (200)
Returns the log file content.
```

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

### GET /v1/dkimkey/{domain}/algorithm

Source: https://www.smtpeter.com/en/documentation/rest-dkim

Retrieves the signing algorithm for the specified domain as plain text.

```APIDOC
## GET /v1/dkimkey/{domain}/algorithm

### Description
Retrieves the signing algorithm for the specified domain as plain text.

### Method
GET

### Endpoint
https://www.smtpeter.com/v1/dkimkey/{domain}/algorithm

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

### Response
#### Success Response (200)
- **body** (string) - The algorithm (e.g., sha256), returned as text/plain.

#### Response Example
sha256
```

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

### HTML with style block

Source: https://www.smtpeter.com/en/documentation/inline-css

Example HTML with a style block in the head that SMTPeter will convert to inline styles when the inline-css feature is enabled.

```html
<head>
    <style>
     td {
        font-family: helvetica, sans-serif;   
     }
    </style>
</head>
```

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

### Adding custom x-* headers to email JSON

Source: https://www.smtpeter.com/en/documentation/rest-send-json

Use the 'extra' property to include custom headers. Custom headers must start with the 'x-' prefix to avoid conflicts.

```json
{
    "subject": "this is the subject line",
    "html": "<html> .... </html>",
    "text": "text version of the email",
    "extra": {
        "x-my-identifier": "abcdefg",
        "x-custom-property": "custom"
    }
}
```

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

### POST /v1/send request with JSON body

Source: https://www.smtpeter.com/en/documentation/rest-send-json

Example of a POST request to the SMTPeter API including the access token and a JSON payload defining email properties.

```http
POST /v1/send?access_token={YOUR_API_TOKEN} HTTP/1.0
Host: www.smtpeter.com
Content-Type: application/json
Content-Length: 7391

{
    "recipient":    "john@doe.com",
    "subject":      "This is a test mail",
    "from":         "info@example.com",
    "text":         "This is the messge body...",
    "html":         "<html><head>..."
}
```

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

### Open main.cf with nano

Source: https://www.smtpeter.com/en/documentation/postfix

Opens the Postfix main configuration file for editing.

```bash
$ sudo nano /etc/postfix/main.cf
```

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

### GET /v1/attachments/MESSAGEID/NUMBER

Source: https://www.smtpeter.com/en/documentation/rest-messages

Downloads an attachment by its rank (starting from zero).

```APIDOC
## GET /v1/attachments/MESSAGEID/NUMBER

### Description
Downloads an attachment by its rank.

### Method
GET

### Endpoint
https://www.smtpeter.com/v1/attachments/MESSAGEID/NUMBER

### Parameters
#### Path Parameters
- **MESSAGEID** (string) - Required - The unique message ID of the email.
- **NUMBER** (integer) - Required - The rank of the attachment, starting from zero.

### Response
#### Success Response (200)
- **body** - The attachment file content.

#### Response Example
(binary content)
```

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

### GET /v1/embeds/MESSAGEID/NUMBER

Source: https://www.smtpeter.com/en/documentation/rest-messages

Downloads embedded content by its rank (starting from zero).

```APIDOC
## GET /v1/embeds/MESSAGEID/NUMBER

### Description
Downloads embedded content by its rank.

### Method
GET

### Endpoint
https://www.smtpeter.com/v1/embeds/MESSAGEID/NUMBER

### Parameters
#### Path Parameters
- **MESSAGEID** (string) - Required - The unique message ID of the email.
- **NUMBER** (integer) - Required - The rank of the embedded content, starting from zero.

### Response
#### Success Response (200)
- **body** - The embedded content file.

#### Response Example
(binary content)
```

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

### GET events by message ID

Source: https://www.smtpeter.com/en/documentation/rest-events

GET request to retrieve events for a specific message ID. The `MESSAGEID` placeholder should be replaced with the actual message ID. Events are available up to one month after sending; use `start` and/or `end` options for a different period.

```http
https://www.smtpeter.com/v1/events/messageid/MESSAGEID
```

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

### Configure Postfix relay settings in main.cf

Source: https://www.smtpeter.com/en/documentation/postfix

Update or add these settings to enable SASL authentication, use STARTTLS, set the relay host to SMTPeter, and specify CA certificates. If you used a non-default port in sasl_passwd, use the same port in relayhost.

```plaintext
# enable SASL authentication
smtp_sasl_auth_enable       = yes

# tell Postfix where the credentials are stored
smtp_sasl_password_maps     = hash:/etc/postfix/sasl_passwd 
smtp_sasl_security_options  = noanonymous

# use STARTTLS for encryption
smtp_use_tls                = yes 

# specify SMTP relay host
relayhost                   = [mail.smtpeter.com]:587

# where to find CA certificates
smtp_tls_CAfile             = /etc/ssl/certs/ca-certificates.crt
```

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

### Open sasl_passwd file with nano

Source: https://www.smtpeter.com/en/documentation/postfix

Opens the existing /etc/postfix/sasl_passwd file for editing. If the file does not exist, create it.

```bash
$ sudo nano /etc/postfix/sasl_passwd
```

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

### GET /v1/events/template/{TEMPLATE}

Source: https://www.smtpeter.com/en/documentation/rest-events

Retrieves events for a specific template for the last monthly period. You can specify a different period using the start and end options, and optionally filter on tags.

```APIDOC
## GET /v1/events/template/{TEMPLATE}

### Description
Retrieves event information for a particular template for the last monthly period. You can specify a different period using the start and end options, and optionally filter on tags.

### Method
GET

### Endpoint
https://www.smtpeter.com/v1/events/template/{TEMPLATE}

### Parameters
#### Path Parameters
- **TEMPLATE** (string) - Required - The id of the template you are interested in.

#### Query Parameters
- **start** (string) - Optional - Start date for the period to retrieve events.
- **end** (string) - Optional - End date for the period to retrieve events.
- **tags** (string) - Optional - Comma-separated list of tags to filter events.

### Response
#### Success Response (200)
Returns a JSON object containing event information for the specified template.

#### Response Example
{
  "events": []
}
```

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

### GET /v1/events/email/{EMAILADDRESS}

Source: https://www.smtpeter.com/en/documentation/rest-events

Retrieves events for a specific email address for the last monthly period. You can specify a different period using the start and end options, and optionally filter on tags.

```APIDOC
## GET /v1/events/email/{EMAILADDRESS}

### Description
Retrieves event information for a particular email address for the last monthly period. You can specify a different period using the start and end options, and optionally filter on tags.

### Method
GET

### Endpoint
https://www.smtpeter.com/v1/events/email/{EMAILADDRESS}

### Parameters
#### Path Parameters
- **EMAILADDRESS** (string) - Required - The email address you are interested in.

#### Query Parameters
- **start** (string) - Optional - Start date for the period to retrieve events.
- **end** (string) - Optional - End date for the period to retrieve events.
- **tags** (string) - Optional - Comma-separated list of tags to filter events.

### Response
#### Success Response (200)
Returns a JSON object containing event information for the specified email address.

#### Response Example
{
  "events": []
}
```

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

### Create template POST request and response

Source: https://www.smtpeter.com/en/documentation/rest-templates

Example POST request to create a template and the corresponding HTTP response. The request includes the template name in JSON. The response includes a 201 Created status, a Location header with the new template URL, and a JSON object with the template ID.

```http
POST /v1/template/html?access_token=yourtoken
Host: www.smtpeter.com
Content-Type: application/json

{ "name" : "template..." }

HTTP/1.1 201 Created
Location: https://www.smtpeter.com/v1/template/2/html?access_token=yourtoken
Content-Type: application/json

{ "id" : 2 }
```

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

### GET /v1/events/tags/{TAG}

Source: https://www.smtpeter.com/en/documentation/rest-events

Retrieves events for one or more tags for the last monthly period. You can specify a different period using the start and end options. Multiple tags can be provided separated by semicolons.

```APIDOC
## GET /v1/events/tags/{TAG}

### Description
Retrieves event information for one or more tags for the last monthly period. You can specify a different period using the start and end options. Multiple tags can be provided separated by semicolons.

### Method
GET

### Endpoint
https://www.smtpeter.com/v1/events/tags/{TAG}

### Parameters
#### Path Parameters
- **TAG** (string) - Required - The tag you are interested in. For multiple tags, use semicolons: TAG1;TAG2;TAG3;...

#### Query Parameters
- **start** (string) - Optional - Start date for the period to retrieve events.
- **end** (string) - Optional - End date for the period to retrieve events.

### Response
#### Success Response (200)
Returns a JSON object containing event information for messages that have all specified tags set.

#### Response Example
{
  "events": []
}
```

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

### Set myhostname in /etc/postfix/main.cf

Source: https://www.smtpeter.com/en/documentation/postfix

Required before relaying: set myhostname to your server's fully-qualified domain name (FQDN) in /etc/postfix/main.cf.

```plaintext
myhostname = fqdn.yourdomain.com
```

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

### Get events by email address

Source: https://www.smtpeter.com/en/documentation/rest-events

Retrieves events for a specific email address for the last monthly period. Optionally specify the start and/or end option for a different period, and filter on tags with the tags option.

```text
https://www.smtpeter.com/v1/events/email/EMAILADDRESS
```

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

### Example MIME message

Source: https://www.smtpeter.com/en/documentation/rest-mime

Shows a minimal MIME message that could be passed in the 'mime' property. It includes a header and a plain-text body separated by an empty line.

```text
MIME-Version: 1.0
From: <info@example.com>
To: "John Doe" <john@doe.com>
Subject: This is the subject line
Date: Thu, 23 May 2019 15:07:11 +0200
Content-Type: text/html

Hello John,

This is a very minimal e-mail message.

Cheers,

Peter
```

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

### Get events by tags

Source: https://www.smtpeter.com/en/documentation/rest-events

Retrieves events for one or multiple tags. The first URL retrieves events for a single tag; the second extends the call to filter on multiple tags. The returned JSON only contains information for messages that have all tags set. Optionally specify the start and/or end option for a different period.

```text
https://www.smtpeter.com/v1/events/tags/TAG
```

```text
https://www.smtpeter.com/v1/events/tags/TAG1;TAG2;TAG3;...
```

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

### Take range from array with range modifier

Source: https://www.smtpeter.com/en/documentation/personalization-modifiers

Takes a range from an array input. The form is range:start:end where start is the start position and end is the exclusive end position. If the variable is not an array, the value is ignored.

```smarty
{$array|range:2:5}
```

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

### Example hyperlink prevented by preventscam

Source: https://www.smtpeter.com/en/documentation/rest-send-advanced

Example hyperlink that the preventscam option prevents SMTPeter from modifying.

```html
<a href="http://www.example.com">www.example.com</a>
```

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

### Send template with convenience properties

Source: https://www.smtpeter.com/en/documentation/rest-send-modified

Use convenience properties like subject and from to directly override template values. This example sends template 12 with a different subject and from address.

```http
POST /v1/send?access_token={YOUR_API_TOKEN} HTTP/1.0
Host: www.smtpeter.com
Content-Type: application/json
Content-Length: 116

{
    "recipient":    "john@doe.com",
    "template":     12,
    "subject":      "alternative subject line",
    "from":         "Sender Name <info@example.com>"
}
```

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

### substr modifier

Source: https://www.smtpeter.com/en/documentation/personalization-modifiers

Obtains a substring from the variable. The syntax is substr:start:length, where start is zero-indexed and length defaults to the remaining length of the string.

```smarty
If the variable is "0123456789" this will print 2 to 9
{$variable|substr:2}
and this will print 456
{$variable|substr:4:3}
```

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

### Send template with attachment URL

Source: https://www.smtpeter.com/en/documentation/rest-send-modified

Let SMTPeter download the attachment from a URL. Note the URL in the example contains a typo (http:://).

```http
POST /v1/send?access_token={YOUR_API_TOKEN} HTTP/1.0
Host: www.smtpeter.com
Content-Type: application/json
Content-Length: 152

{
    "recipient": "john@doe.com",
    "template": 12,
    "attachments": [{
        "url": "http:://example.com/path/to/document.pdf",
    }]
}
```

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

### GET /v1/dns/{domain}/recommended

Source: https://www.smtpeter.com/en/documentation/rest-dns

Retrieves the recommended DNS records that should be copied to the user's DNS server. These records typically use CNAMEs pointing to SMTPeter's domain for easier management.

```APIDOC
## GET /v1/dns/{domain}/recommended

### Description
Returns an array of DNS records that the user should copy to their DNS server. The records are recommended by SMTPeter and often use CNAMEs to point to SMTPeter's DNS records.

### Method
GET

### Endpoint
https://www.smtpeter.com/v1/dns/{domain}/recommended

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

### Response
#### Success Response (200)
Returns a JSON array of DNS record objects. Each object contains:
- **name** (string) - The DNS record name.
- **type** (string) - The DNS record type (e.g., CNAME, MX, TXT).
- **value** (string) - The value for the DNS record.

#### Response Example
[
    {
        "name": "zero._domainkey.example.com",
        "type": "CNAME",
        "value": "dkimX0.smtpeter.com"
    },
    {
        "name": "one._domainkey.example.com",
        "type": "CNAME",
        "value": "dkimX1.smtpeter.com"
    },
    {
        "name": "two._domainkey.example.com",
        "type": "CNAME",
        "value": "dkimX2.smtpeter.com"
    },
    {
        "name": "example.com",
        "type": "MX",
        "value": "0 mail.smtpeter.com"
    },
    {
        "name": "clicks.example.com",
        "type": "CNAME",
        "value": "clicks.smtpeter.com"
    },
    {
        "name": "example.com",
        "type": "TXT",
        "value": "v=spf1 include:spfX.smtpeter.com -all"
    },
    {
        "name": "_dmarc.example.com",
        "type": "CNAME",
        "value": "dmarcX.smtpeter.com"
    }
]
```

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

### Download XML log file

Source: https://www.smtpeter.com/en/documentation/rest-logfiles

Append '/xml' to the filename to download the log file in XML format.

```http
https://www.smtpeter.com/v1/logfiles/attempts.2016-03-20.log/xml
```

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

### JSON email data example for SMTPeter API

Source: https://www.smtpeter.com/en/documentation/python-example

Example JSON data structure for an email message, including envelope, recipient, subject, from, to, HTML and text versions.

```json
{
"envelope"  : "sender@example.com",
"recipient" : "receiver@example.com",
"subject"   : "This is the mail subject",
"from"      : "sender@example.com",
"to"        : "receiver@example.com",
"html"      : "<html><head><style>body { font-weight: 600; }</style></head><body>This is the html version.</body></html>",
"text"      : "And this is the text version"
}
```

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

### Create template URL

Source: https://www.smtpeter.com/en/documentation/rest-templates

HTTP POST call to create a new template. The {format} parameter specifies the template format (e.g., html). The request body must contain JSON data.

```http
https://www.smtpeter.com/v1/template/{format}
```

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

### GET /v1/attachments/MESSAGEID/NAME

Source: https://www.smtpeter.com/en/documentation/rest-messages

Downloads an attachment by its name.

```APIDOC
## GET /v1/attachments/MESSAGEID/NAME

### Description
Downloads an attachment by its name.

### Method
GET

### Endpoint
https://www.smtpeter.com/v1/attachments/MESSAGEID/NAME

### Parameters
#### Path Parameters
- **MESSAGEID** (string) - Required - The unique message ID of the email.
- **NAME** (string) - Required - The name of the attachment.

### Response
#### Success Response (200)
- **body** - The attachment file content.

#### Response Example
(binary content)
```

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

### POST /v1/template/{format}

Source: https://www.smtpeter.com/en/documentation/rest-templates

Creates a new template. The request body must contain JSON data with the template properties. The response includes the new template ID and a Location header pointing to the created template.

```APIDOC
## POST /v1/template/{format}

### Description
Creates a new template. The request body must contain JSON data with the template properties. The response includes the new template ID and a Location header pointing to the created template.

### Method
POST

### Endpoint
https://www.smtpeter.com/v1/template/{format}

### Parameters
#### Path Parameters
- **format** (string) - Required - The format of the template (e.g., html, json).

#### Request Body
- **name** (string) - Required - The name of the template.
- Additional properties as specified in the ResponsiveEmail documentation.

### Request Example
POST /v1/template/html?access_token=yourtoken
Host: www.smtpeter.com
Content-Type: application/json

{ "name" : "template..." }

### Response
#### Success Response (201 Created)
- **id** (integer) - The unique identifier of the created template.

#### Response Example
HTTP/1.1 201 Created
Location: https://www.smtpeter.com/v1/template/2/html?access_token=yourtoken
Content-Type: application/json

{ "id" : 2 }
```

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

### Run postmap on sasl_passwd

Source: https://www.smtpeter.com/en/documentation/postfix

Run this command after adding or changing credentials to update the Postfix lookup database.

```bash
$ postmap /etc/postfix/sasl_passwd
```

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

### GET /v1/embeds/MESSAGEID/NAME

Source: https://www.smtpeter.com/en/documentation/rest-messages

Downloads embedded content by its name.

```APIDOC
## GET /v1/embeds/MESSAGEID/NAME

### Description
Downloads embedded content by its name.

### Method
GET

### Endpoint
https://www.smtpeter.com/v1/embeds/MESSAGEID/NAME

### Parameters
#### Path Parameters
- **MESSAGEID** (string) - Required - The unique message ID of the email.
- **NAME** (string) - Required - The name of the embedded content.

### Response
#### Success Response (200)
- **body** - The embedded content file.

#### Response Example
(binary content)
```

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

### Download CSV log file with header

Source: https://www.smtpeter.com/en/documentation/rest-logfiles

Append '/header' to the URL to include variable names on the first line of the CSV file.

```http
https://www.smtpeter.com/v1/logfiles/attempts.2016-03-20.log/header
```

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

### Create or update sender domain with settings

Source: https://www.smtpeter.com/en/documentation/rest-sender-domains

POST call with JSON body to create or update a sender domain with optional settings. Properties include bounces, tracking, https, policy, percentage, startdate, enddate, and address. Unset properties receive default values.

```http
POST /v1/domain/yourdomain.com?access_token={YOUR_API_TOKEN} HTTP/1.0
Host: www.smtpeter.com
Content-Type: application/json
Content-Length:

{
    "bounces":      "bounces.yourdomain.com",
    "tracking":     "clicks.yourdomain.com",
    "https":        true,
    "policy":       "none|quarantine|reject",
    "percentage":   100,
    "startdate":    "2016-07-01",
    "enddate":      "2016-08-01",
    "address":      "dmarc@yourdomain.com"
}
```

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

### GET /v1/logfiles/FILENAME/header

Source: https://www.smtpeter.com/en/documentation/rest-logfiles

Downloads the header of a single log file.

```APIDOC
## GET /v1/logfiles/FILENAME/header

### Description
Downloads the header of a single log file.

### Method
GET

### Endpoint
https://www.smtpeter.com/v1/logfiles/FILENAME/header

### Parameters
#### Path Parameters
- **FILENAME** (string) - Required - The name of the log file.

### Response
#### Success Response (200)
Returns the header of the log file.
```

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

### GET /v1/attachments/MESSAGEID

Source: https://www.smtpeter.com/en/documentation/rest-messages

Retrieves the names and ranks of all attachments belonging to a message.

```APIDOC
## GET /v1/attachments/MESSAGEID

### Description
Retrieves the names and ranks of all attachments belonging to a message.

### Method
GET

### Endpoint
https://www.smtpeter.com/v1/attachments/MESSAGEID

### Parameters
#### Path Parameters
- **MESSAGEID** (string) - Required - The unique message ID of the email.

### Response
#### Success Response (200)
- **body** - List of attachments with names and ranks.

#### Response Example
[{"name":"file.pdf","number":0}]
```

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

### Simple math with variables: {$var + 10}

Source: https://www.smtpeter.com/en/documentation/personalization

Performs arithmetic on a numeric variable inside curly braces. Standard math operators (+, -, *, /) and modulo (%) are supported. If the variable is missing or non-numeric, it is treated as zero.

```text
{$var + 10}
```

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

### GET /v1/logfiles/FILENAME/xml

Source: https://www.smtpeter.com/en/documentation/rest-logfiles

Downloads a single log file in XML format.

```APIDOC
## GET /v1/logfiles/FILENAME/xml

### Description
Downloads a single log file in XML format.

### Method
GET

### Endpoint
https://www.smtpeter.com/v1/logfiles/FILENAME/xml

### Parameters
#### Path Parameters
- **FILENAME** (string) - Required - The name of the log file.

### Response
#### Success Response (200)
Returns the log file content in XML format.
```
Tokens:
Raw