---
title: "Mail (Postman)"
slug: "mail-postman"
updated: 2026-07-13T16:16:10Z
published: 2026-07-13T16:16:10Z
canonical: "docs.datajet.app/mail-postman"
stale: true
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.datajet.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Mail (Postman)

The [postman](/v1/docs/postman) function allows **email** to be sent to a designated set of recipients. (See [Channel Management](/v1/docs/channel-management) for details on how to post to other channels such as slack, google meet etc)

If the containing script creates DataJet [reports](/v1/docs/introduction-to-reporting) (using the SaveReport method) then the option to attach those reports will be provided.

If the containing script generates external files then the option to attach those files will be provided.

Editing in the JSON PanelNote that postman is unlike other JSON methods - it must be edited using the EDIT dialog and cannot be edited directly in the JSON editor.   This is by design.

![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1695893110808.png)

#### Subject

Subject of Notification. Title that will appear in the email subject line.

![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1695827055413.png)

#### Message

Message Body. Content that will appear in the email message body.

![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1695840962696.png)

Line breaks will be converted to escape characters (\r\n)

![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1695909610446.png)

becomes:

```json
"body" : "ETL Processing has completed for file:\r\n\r\n[%ClientDataFileNameAndPath%] \r\n\r\nAttached are:\r\n - Input File Summary\r\n - Input File\r\n - Manual Processing Files\r\n - New Batch Generation Upload file (if applicable)",
```

#### Signature

A signature to apply to every email. It will be appended to the end of the message body.

![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1695840978759.png)

#### To

Recipient list. Each email address must be separated by a semi-colon (;)

![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1695893297702.png)

#### Attach Files

If any files are generated within the script (i.e., via [ExportIntoWorkbook](/v1/docs/exportintoworkbook), [Export](/v1/docs/export-1) or [ExecuteReport](/v1/docs/executereport) methods), these files will appear as a checklist in the postman dialog.

Selected files will be appended to the attached notification.

![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1695841041631.png)

#### To (Registered Users)

A checklist of all users that have been configured in the [management console/contact management](/v1/docs/contact-management) section will be available for selection:

![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1695893169082.png)

#### Attach Reports

If any reports are generated within the script (i.e., via SaveReport or AddToCollection - used to create a standardized report - methods), these files will appear as a checklist in the postman dialog.

Selected files will be appended to the attached notification.

![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1695841060608.png)

#### OK/Cancel

Selecting OK will add the postman method to the current script.

## JSON

The JSON for the [postman](/v1/docs/postman) call is as follows:

```json
{
  "method": "Postman",
  "subject": "Script Complete",
  "body": "This is an automated message from DataJet.\r\nYour script has completed.",
  "signature": "{Add signature here}",
  "to": [
    "info@datajetsoftware.com",
    "Something@domain.com"
  ],
  "attach": [
    "%OUTPUT%Crosstab_occupation.xlsx"
  ],
  "reportLinks": [
    "Standardized Report1"
  ],
  "project": "RegressionDB"
}
```