Webitel: Documentation

Get Email

1. Description

It is used to get information about a message by ID.

This component is present in flow types like:

  • Voice;

  • Chat;

  • Forms;

  • Service.

The block (Fig.1(1)) is used in space to build the Flow. The settings panel for this component opens (Fig.1(2)) when you click on the block.

Get email.png
Fig.1. Get Email component

1.1. Get Email block

The block consists of the following elements:

  1. The name of the component;

  2. In branch — receiving (connecting with the previous block) branch;

  3. Out branch — outgoing (connecting with the following block) branch. When hovering over the Out field, a switch appears. The switch allows this component to be connected to a component that already has a connection.

The presence of an Screenshot 2024-11-07 154742.png icon indicates that the switch is on, and this component can be connected to a component that already has a connection.

Changing the switch position removes the outgoing branch of this component.

The Screenshot 2024-11-07 155145.png button deletes the block from the Flow schema.

1.2. Get Email settings panel

It consists of the following elements:

  1. Email Id;

  2. Message Id;

  3. Set variables;

  4. Break;

  5. Limit;

  6. Add description.

1.2.1. Email Id

In this field, you can enter an identifier from the database by which the variables will be transferred.

1.2.2. Message Id

In this field, you can enter an identifier of the message by which the variables will be transferred.

1.2.3. Set variables

It allows assigning an additional variable that can be used later.

It consists of the following:

  1. Key;

  2. Value;

  3. Remove tool;

  4. Add tool.

1.2.3.1. Key

The name of the variable is entered here.

1.2.3.2. Value

The value of the variable is entered here.

1.2.3.3. Remove tool

It is intended for removing a variable in a row with which it stands—clicking on the  Снимок экрана 2024-02-16 005633.png  button removes the variable.

1.2.3.4. Add tool

The icon image-20250701-130317.png is designed to add a new variable.

Possible Value:

  • body  — the main content of the email, the body of the message;

  • cc —  email addresses in the carbon copy;

  • from - information about the sender;

  • html — the message will be written in text or HTML format;

  • subject —  the title or topic described by the sender in the subject line;

  • to —  recipient's email address and name;

  • in_reply_to — identifier of the message on which the conversation will be maintained, that is, the previous message will be quoted in response to it;

  • reply_to — the email address to which the reply will be sent;

  • attachments - attached files.

When HTML is selected, the content is minified by default (Fig. 2).

Content minification.png
Fig. 2. Content is minified

To disable it (Fig. 3) you need to set the variable wbt_disable_htmlmin = true in the component Set variables component which is added to the Flow schema before the Get Email component.

Cancellation of content minification.png
Fig. 3. Cancellation of content minification

1.2.4. Break

Responsible for the completion of the flow execution.

  • image-20250701-130122.png — initiates the end of the flow execution after the given component.

  • image-20250701-130145.png — the switch is in the off position.

1.2.5. Limit

It is intended to determine the maximum number of passes through this component.

The failover branch appears in the edited component when the limit is set image2024-1-26_12-1-12.png .

The failover branch will be used if more passes are passed through the component than entered in the Max field.

Clicking on the Add Limit button adds a Max field and a Delete limit button.

The number of possible passes is indicated in the Max field.

Clicking on the Delete limit button removes the limit and returns the Add limit button.

Limit.png


Fig. 4. Setting a limit

1.2.6. Add description

When you click the Add description button, a Description field and a Delete description button will be added.

The Description field is used to add comments to the component.

Clicking the Delete description button removes the description field and brings back the Add description button.

Description.png

Fig. 5. Add description