doc-gen.receive-email-message-action.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of igor-plugin-message Show documentation

Igor plugin providing messaging functionality for various services.

There is a newer version: 0.6.8

# 'Receive E-Mail' Action

## Description
This action receives E-Mails and creates a new data item for every received E-Mail. 

## Example
For every data item processed by the action, E-Mails are retrieved from the configured server.


The created new data items contain the E-Mails data, e.g.: 

```
{
  "data": {
    ...
  },
  "meta": {
    ...
  },
  "message": {
    "headers": {
      "Return-Path": "",
      "Delivered-To": "[email protected]",
      "From": "[email protected]",
      "To": "[email protected]",
      "Subject": "Test E-Mail",
      "MIME-Version": "1.0",
      "Content-Type": "multipart/mixed"
    },
    "recipients": [
      "[email protected]"
    ],
    "bodies": [
      {
        "contentType": "text/plain; charset=us-ascii",
        "content": "Just a simple test..."
      }
    ],
    "from": "[email protected]"
  }
}
```

## Parameters
The component can be configured by the following parameters:

Parameter | Description
:---|:---
Email Connector | The E-Mail IMAP connector to use for receiving E-Mails.
Folder Name | The name of the IMAP folder to read mails from, e.g. 'INBOX'.
Only New | If checked, only new mails will be received by this action.
Delete Processed | If checked, received E-Mails will be deleted by the action.
Save Attachments | If checked, attachments of the received E-Mails are saved in the configured directory (see below).
Attachment Directory | The target directory for downloaded attachments.