> For the complete documentation index, see [llms.txt](https://docs.enate.net/enate-help/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.enate.net/enate-help/ru/elektronnaya-pochta/komponenty-elektronnoi-pochty.md).

# Составление емейлов

{% embed url="<https://enate.cdn.spotlightr.com/watch/MTM2MTY2OQ==>" %}

Вы можете написать новое электронное письмо на вкладке «Электронная почта» Рабочего элемента.

![](https://3859925423-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MWYnDNwe3Cuo4zlGbs5-887967055%2Fuploads%2FUndPccUgucI68JhL8tll%2Fimage.png?alt=media\&token=ecdb684c-2074-411a-939b-56232fe8de98)

Вы можете [сохранить письмо в качестве черновика](https://docs.enate.net/enate-help/ru/elektronnaya-pochta/sokhranenie-emeila-kak-chernovika.md), [запланировать время отправки письма](https://docs.enate.net/enate-help/ru/elektronnaya-pochta/planirovanie-otpravki-emeilov.md) и отправить письмо сразу.

Примечание: нельзя отправить письмо, размер которого [превышает установленный в Builder предел](https://docs.enate.net/enate-help/builder/builder/system-wide-settings/general-settings#maximum-email-size).

После отправки письмо появится на таймлайне, где вы сможете увидеть, кто его написал, его содержание (если развернуть), а также время создания и отправки. У вас также будет возможность ответить на письмо, переслать его, развернуть или распечатать.

{% hint style="info" %}
Вы можете написать совершенно новое письмо, даже если Рабочий элемент вам не назначен.
{% endhint %}

## Отправка письма получателю, не связанному с Рабочим элементом

В целях защиты конфиденциальной информации Enate проверяет адресатов каждого электронного письма, которое Вы составляете в рамках Рабочего элемента, и предупреждает Вас, если кто-либо из них принадлежит к домену электронной почты, не связанному с данным Рабочим элементом. Домен — это часть адреса электронной почты, следующая за символом @, например, brightwellpayroll.com в адресе <jane.smith@brightwellpayroll.com>.

Домен получателя считается связанным с рабочим элементом, если он совпадает с доменом:

* адреса отправителя, с которого вы отправляете письмо, либо
* адреса электронной почты любого контакта на [карте контактов](https://docs.enate.net/enate-help/ru/kontakty/karta-kontaktov.md) Рабочего элемента, независимо от его метки контакта. Удаленные контакты не учитываются.

Проверка охватывает поля «Кому», «Копия» и «Bcc» новых писем, ответов, пересылок и черновиков, которые вы вновь открываете, включая письма, написанные в всплывающем окне электронной почты. Она выполняется во время написания письма и повторяется при каждом добавлении или удалении получателя, изменении адреса отправителя или изменении контактов в Рабочем элементе.

Если у одного или нескольких получателей указан домен, не связанный с Рабочим элементом:

* каждый из этих получателей выделяется в поле «Кому», «Копия» или «Bcc». Наведите курсор на выделенного получателя, чтобы увидеть сообщение «Этот домен не связан с этим рабочим элементом».
* над панелью инструментов электронной почты появляется предупреждение: «Будьте осторожны, делясь конфиденциальной информацией. Некоторые получатели принадлежат к доменам электронной почты, не связанным с этим рабочим элементом». Наведите курсор на значок информации рядом с ним, чтобы узнать, как работает эта проверка.

<figure><img src="https://3859925423-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MWYnDNwe3Cuo4zlGbs5-887967055%2Fuploads%2FbhMPszWTlfRFMCXQPTFx%2Fimage.png?alt=media&#x26;token=28299f9b-0cde-4769-8aeb-d89e818e48c2" alt=""><figcaption></figcaption></figure>

Предупреждение не препятствует отправке письма. Увидев его:

1. Проверьте каждого выделенного получателя и решите, следует ли ему отправить письмо.
2. Чтобы удалить всех выделенных получателей сразу, нажмите «Удалить получателей» в окне предупреждения. При этом все выделенные получатели будут удалены из полей «Кому», «Копия» и «Bcc», а предупреждение исчезнет.
3. Чтобы удалить только некоторых из них, нажмите значок «x» напротив каждого получателя, которого вы хотите удалить.
4. Если выделенный получатель должен получить это письмо, оставьте его в списке и отправьте письмо в обычном режиме. Если он будет участвовать в работе над этим Рабочим элементом в дальнейшем, [добавьте его в качестве контакта](https://docs.enate.net/enate-help/ru/kontakty/karta-kontaktov.md#dobavlenie-kontaktov-vruchnuyu-v-kartu-kontaktov) на карте контактов данного Рабочего элемента. После этого выделение снимется со всех получателей с этим доменом, и предупреждение исчезнет, если другие получатели не будут выделены.

### Пример

Вы работаете над Заявкой для компании «Brightwell Payroll». Письма по этой Заявке отправляются с адреса <payroll.support@harbourservices.com>, а на карте контактов указаны два контакта: Джейн Смит (<jane.smith@brightwellpayroll.com>) и Том Рид (<tom.reid@brightwellpayroll.com>).

Вы отвечаете на последнее письмо Джейн, указав следующих получателей:

| Поле   | Получатель                         | Выделено? | Почему                                                                                                       |
| ------ | ---------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------ |
| Кому   | <jane.smith@brightwellpayroll.com> | Нет       | brightwellpayroll.com — это домен контактов в Рабочем элементе.                                              |
| Копия: | <team.lead@harbourservices.com>    | Нет       | harbourservices.com — это домен адреса отправителя.                                                          |
| Копия: | <a.khan@brightwell-hr.com>         | Да        | brightwell-hr.com не является доменом адреса отправителя или какого-либо контакта.                           |
| Bcc:   | <finance@uk.brightwellpayroll.com> | Да        | Поддомен считается отдельным доменом, поэтому uk.brightwellpayroll.com не совпадает с brightwellpayroll.com. |

Появится предупреждение. После этого выполните одно из следующих действий:

* Нажмите «Удалить получателей». Адреса <a.khan@brightwell-hr.com> и <finance@uk.brightwellpayroll.com> будут удалены, при этом Джейн останется в поле «Кому», а руководитель команды — в поле «Копия».
* Добавьте А. Хана в карту контактов, поскольку он теперь участвует в обработке Заявки. Выделение адреса <a.khan@brightwell-hr.com> снимется, но адрес <finance@uk.brightwellpayroll.com> останется выделенным, поэтому предупреждение будет отображаться до тех пор, пока вы не удалите этого получателя. Вы по-прежнему можете отправить письмо с включением этих адресатов.

### Что не охватывает данная проверка

Проверка сравнивает домены, а не отдельные адреса электронной почты, поэтому она не может указать на всех получателей, которым не следует отправлять письмо:

* **Пользователи, относящиеся к связанному домену, не выделяются.** Если контакт в Рабочем элементе использует общедоступный почтовый домен, например gmail.com, каждый получатель с адресом gmail.com считается связанным. То же самое относится ко всем, кто использует домен адреса отправителя. Перед отправкой самостоятельно проверьте этих получателей, особенно если письмо содержит конфиденциальную информацию.
* **Регистр букв не имеет значения.** Адрес <Jane.Smith@BrightwellPayroll.com> рассматривается так же, как и <jane.smith@brightwellpayroll.com>.
* **Предупреждение не фиксируется.** Ни в таймлайне, ни в отправленном письме не отображается информация о том, что появилось предупреждение или что письмо было отправлено с выделенными получателями. Если вам требуется запись о том, почему вы отправили письмо получателю, не указанному в Рабочем элементе, [добавьте Примечание](https://docs.enate.net/enate-help/ru/tipy-rabochikh-elementov-zayavki-sluchai-i-deistviya/dobavlenie-primechaniya.md) к данному Рабочему элементу.

## Отправка электронного письма другой команде, использующей Enate

Если вы адресуете электронное письмо на адрес другой команды, использующей Enate (через [маршрут электронной почты](https://docs.enate.net/enate-help/builder/builder/email-mailbox-configuration/email-routes), настроенный в Builder), при нажатии кнопки «Отправить» появится всплывающее окно «Требуется дополнительная информация». Оттуда вы можете либо привязать письмо к рабочему элементу, который уже находится в процессе запуска для этой команды, либо создать для них новый связанный рабочий элемент в рамках отправки письма.

При создании нового связанного рабочего элемента таким образом контакты из рабочего элемента, с которого вы отправляете письмо, копируются только в том случае, если новый рабочий элемент является «Случаем», в настройках типа которого выбран параметр «Обязательное указание контактов». Например, если вы отправляете письмо на адрес команды по расчёту заработной платы из заявки, а их процесс представляет собой заявку, новый тикет создаётся без контактов. Если их процесс представляет собой Случай, требующий указания контактов, раздел «Контакты» во всплывающем окне заполняется контактами из вашей заявки, чтобы вы могли их проверить перед нажатием кнопки «Создать и отправить».

Подробную информацию см. в разделе [Создание связанного рабочего элемента путем отправки электронного письма другой команде](https://docs.enate.net/enate-help/ru/rabota-so-svyazannymi-zadachami/sozdanie-novykh-svyazannykh-zadach.md).

## Ответ на электронные письма из таймлайна <a href="#f-responding-to-emails" id="f-responding-to-emails"></a>

Вы также можете отвечать на электронные письма или пересылать их из таймлайна, нажимая на доступные ссылки. Эти кнопки становятся активными при наведении курсора мыши на карточку электронного письма.

<figure><img src="https://3859925423-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MWYnDNwe3Cuo4zlGbs5%2F-MjEJi2N6N-uLY5hw_8-%2F-MjEQNzl2Zg1nSwVSx_f%2FResponding-to-an-email-from-the.gif?alt=media&#x26;token=1affb6b1-936e-4944-8395-56ee720b6487" alt=""><figcaption></figcaption></figure>

## Правила для полей «Кому», «От», «Копия» и «Bcc:» <a href="#h-rules-for-to-from-cc-bcc-addresses" id="h-rules-for-to-from-cc-bcc-addresses"></a>

Система работает следующим образом при вводе адресов электронной почты:

* При отправке нового письма система по умолчанию устанавливает в поле «Кому» адрес Основного контакта из раздела «Контакты». Поле «Копия» также по умолчанию заполняется адресами, введенными в разделе «Копии».
* Если настроено более одного возможного адреса электронной почты в поле «От», система заполнит поле адресом по умолчанию (настроенным в Builder) и отобразит раскрывающийся список, позволяющий выбрать альтернативные адреса.
* Эти стандартные правила для адресов по умолчанию и рекомендуемых адресов можно переопределить для полей «Кому», «Копия» и «Скрытая копия» в настройках «Случаев» и «Действий» в Builder. Адреса, установленные по умолчанию, будут заполняться автоматически (таким образом можно установить более одного адреса). Адреса, не установленные по умолчанию, будут доступны для быстрого выбора при нажатии на кнопку «Кому» / «Копия» / «Bcc:»
* При поиске контакта в полях «Кому» («To»), «Копия» («CC:») и «Скрытая копия» («Bcc:») вы сможете просматривать только контакты из той же компании, что и Рабочий элемент. Однако вы можете вручную ввести адрес электронной почты контакта из другой компании.

{% hint style="info" %}
Примечание: Адрес «От» всегда отображается в разделе создания письма при написании электронного письма. Это гарантирует, что отправитель всегда будет видеть адрес электронной почты, используемый в качестве адреса отправителя при отправке писем из конкретного рабочего элемента.
{% endhint %}

![](https://3859925423-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MWYnDNwe3Cuo4zlGbs5%2F-MWsY65S_d9Pto44HgLB%2F-MWsea8p01g1B2QlmpnT%2Fimage.png?alt=media\&token=caaf9daa-47b2-48b9-b534-0e6ea43a8ab1)

{% hint style="info" %}
Примечание: Вы сможете видеть только адреса электронной почты контактов из тех компаний, к которым у вас есть доступ. Однако вы можете вручную ввести любой адрес электронной почты. Эти разрешения можно настроить в Builder; нажмите [здесь ](https://docs.enate.net/enate-help/builder/builder/system-wide-settings#external-contact-scoping)для получения дополнительной информации.
{% endhint %}

### Копирование и вставка адресов электронной почты между полями «Кому», «CC:» и «Bcc:»

При составлении писем вы можете легко копировать адреса электронной почты между полями «Кому», «CC:» и «Bcc:» с помощью значка «копировать», который появляется при нажатии на соответствующее поле адреса.

![](https://3859925423-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MWYnDNwe3Cuo4zlGbs5%2F-MYp8XDI6leEQSQrhkBx%2F-MYpBEL1-NjkOuUl2hcl%2FCopy-Addresses.gif?alt=media\&token=88961724-2e4b-45a7-9ff2-9a894ba5ce86)

### Запрос на создание внешних контактов для новых адресов электронной почты

При отправке письма, содержащего новые адреса электронной почты (т. е. не связанные с существующими контактами), система отобразит всплывающее окно, позволяющее создать их в качестве новых записей контактов.

![](https://3859925423-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MWYnDNwe3Cuo4zlGbs5%2F-MWsY65S_d9Pto44HgLB%2F-MWsf08Vx5_v_1yk_7-P%2Fimage.png?alt=media\&token=7915f188-7699-406f-9519-d6797d50c40b)

Если есть адреса электронной почты, для которых вы не хотите создавать новую запись, просто наведите курсор на строку и нажмите значок удаления. Кроме того, есть флажок «Больше не показывать», при установке которого это всплывающее окно больше не будет появляться при вводе последующих новых адресов электронной почты (эту настройку можно снова включить в [разделе профиля пользователя](https://docs.enate.net/enate-help/ru/nastroiki-polzovatelya.md#other-system-personalisation-options), где также находятся настройки вашей электронной подписи).

![](https://3859925423-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MWYnDNwe3Cuo4zlGbs5%2F-MjEJi2N6N-uLY5hw_8-%2F-MjENAZm2Pl7V2yil7sF%2Fimage.png?alt=media\&token=59fd53f8-b060-479b-8eb7-716aea978990)

## Панель инструментов электронной почты <a href="#a-email-toolbar" id="a-email-toolbar"></a>

С помощью панели инструментов электронной почты вы можете:

![](https://3859925423-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MWYnDNwe3Cuo4zlGbs5-887967055%2Fuploads%2FKcDigOh4e2YnA6Dxldkz%2Fimage.png?alt=media\&token=fb429cf6-8216-4bba-884d-926be50efebd)

* [Прикрепить файлы](https://docs.enate.net/enate-help/ru/elektronnaya-pochta/prikreplenie-failov-k-elektronnomu-pismu.md) к письму
* Открыть [панель инструментов форматирования текста письма](https://docs.enate.net/enate-help/ru/elektronnaya-pochta/komponenty-elektronnoi-pochty.md#d-email-body-formatting-toolbar)
* Закрепить панель инструментов форматирования текста письма
* Вставить [шаблон текста](https://docs.enate.net/enate-help/ru/elektronnaya-pochta/gotovye-teksty.md)
* Установить высокий уровень важности письма

### Панель инструментов форматирования текста письма

Нажатие на значок форматирования текста письма открывает параметры форматирования основного текста письма.

![](https://3859925423-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MWYnDNwe3Cuo4zlGbs5-887967055%2Fuploads%2FPzkTr3GNsQdkRTYE4j1V%2Fimage.png?alt=media\&token=bb700e72-7036-4b64-88a8-95b7d28eb402)

У вас также есть возможность закрепить панель инструментов форматирования текста письма.

![](https://3859925423-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MWYnDNwe3Cuo4zlGbs5-887967055%2Fuploads%2F8aKINEpXy4c8tumGJTQD%2Fimage.png?alt=media\&token=edb497cd-3b96-4ae0-81a8-896f748ab39a)

Панель инструментов форматирования текста письма предоставляет следующие возможности:

* Выбрать шрифт
* Выбрать размер шрифта
* Сделать текст жирным, курсивом или подчеркнутым
* Отменить предыдущие изменения (также доступно с помощью Ctrl + Z)
* Повторить предыдущие изменения (также доступно с помощью Ctrl + Shift + Z)
* Развернуть письмо на весь экран
* Выбрать цвет фона
* Выбрать цвет текста
* Выбрать способ выравнивания текста
* Добавить нумерованный список
* Добавить маркированный список
* Параметры текста в строке: возможность увеличить или уменьшить отступ текста
* Вставить горизонтальную линию
* Настроить высоту строки
* Выбрать стиль в строке
* Оформить стиль ячейки
* Вставить зачеркивание (также доступно при выделении текста и нажатии Ctrl + S)
* Добавить нижний или верхний индекс
* Добавление специальных символов
* Вставка ссылки
* Вставка таблицы
* Вставка изображения
* У вас также есть возможность просмотреть список сочетаний клавиш

#### Настройки шрифта сохранены

При составлении электронного письма (будь то шаблон письма в Builder или любая форма нового письма, ответа или пересылки в разделе «Рабочие элементы» в Work Manager) ваши настройки шрифта (т. е. стиль и размер шрифта), то есть тип и размер шрифта, использованные в последний раз, сохраняются в качестве шрифта для написания текста, поэтому вам не нужно настраивать их заново.

Эти значения сохраняются в профиле пользователя, поэтому остаются неизменными при переходе между Builder и Work Manager.

Это относится только к самой верхней части создаваемого письма: если пользователь перейдёт к любому уже существующему тексту ниже в письме, будут использоваться стиль и размер шрифта, уже применяемые к этому тексту. См. Примечание для получения более подробной информации. В рамках этого изменения урегулированы несоответствия в отношении «новых пустых строк» в письмах: при написании нового письма в его начало всегда будут вставляться 2 пустые строки.

Примечание: для стандартных текстов и шаблонов будут использоваться настройки шрифта, действовавшие на момент их создания.

Стиль и размер шрифта в письме, используемые при его составлении, будут зависеть от того, нажимает ли пользователь на уже существующий текст. Логика выбора используемых шрифтов следующая и зависит от новой функции автоматической вставки двух пустых строк в начало каждого нового письма:

* 1-я автоматически вставленная строка: используются настройки шрифта, сохраненные пользователем в его последнем письме.
* 2-я автоматически вставленная строка. Для неё всегда устанавливается шрифт Arial, размер 10.

Содержание последующих писем может поступать из: - предыдущих писем в цепочке переписки

* содержания шаблона письма
* содержания подписи письма. Стиль и размер шрифта в этих разделах будут зависеть от уже существующего содержания, в зависимости от того, куда нажмет пользователь.

## Копирование/вставка информации из Excel, Word и веб-страниц <a href="#e-copy-paste-of-excel-word-and-web-information" id="e-copy-paste-of-excel-word-and-web-information"></a>

Вы можете копировать и вставлять в электронные письма информацию из внешних документов, например, таблицы Excel и содержимое документов Word, а также HTML-информацию с веб-страниц.

![](https://3859925423-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MWYnDNwe3Cuo4zlGbs5%2F-MYjsnFTQ5VLGmtJzs44%2F-MYk2ggE9I7eFv0uuxbj%2FCopy-from-Excel-into-Email.gif?alt=media\&token=a8d43ce7-1392-41d6-bd61-530e4f0f64b3)

## Всплывающее окно электронной почты <a href="#g-email-pop-out" id="g-email-pop-out"></a>

Если вы хотите выделить больше места на экране для просмотра писем, вы можете воспользоваться доступной функцией всплывающего окна:

![](https://3859925423-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MWYnDNwe3Cuo4zlGbs5%2F-MYjsnFTQ5VLGmtJzs44%2F-MYk4eYtpA-7DtwWQ7k-%2FEmail-Popout.gif?alt=media\&token=b3337661-da4d-4765-8373-4c9f5bea6ed5)

![](https://3859925423-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MWYnDNwe3Cuo4zlGbs5%2F-MjERJfytdZskUYwP-2d%2F-MjESLF3srSji3R6O9GN%2FOpen-Email-Popout-from-Timeline.gif?alt=media\&token=f6e4c73e-a7cf-4374-9485-af5fc8b096c1)

## Настройка «Отменить отправку»

Настройка «Отмена отправки» позволяет установить задержку перед отправкой писем, что дает вам возможность отменить отправку письма или проверить его содержание перед отправкой.

Вы можете установить время отмены отправки в [Настройках пользователя](https://docs.enate.net/enate-help/ru/nastroiki-polzovatelya.md#undo-send).

![](https://3859925423-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MWYnDNwe3Cuo4zlGbs5-887967055%2Fuploads%2F7C5Oei3m1jS327X4DxI5%2F8-Cancel-Send-Setting.gif?alt=media\&token=be3fa04c-cbdd-4ac1-bb90-5eed13efa148)

Когда установлено время отмены отправки, появится всплывающее окно, позволяющее отменить отправку письма.

![](https://3859925423-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MWYnDNwe3Cuo4zlGbs5-887967055%2Fuploads%2FyQJOVV5jTRERBiCvABAD%2F8-Cancel-Sending-an-Email.gif?alt=media\&token=7286cbfc-f464-4616-9d3b-fbd32b8fef1e)

Кроме того, если установлено время отмены отправки, у вас будет возможность отправить письмо «Сейчас» на Таймлайне, что отменит задержку, заданную в настройках «Отмена отправки», а также у вас будет возможность полностью отменить отправку письма.

![](https://gblobscdn.gitbook.com/assets%2F-MR4uErt41EMkGUOTvyd%2F-M_5gMeG-gAiOmge9mMj%2F-M_5hm6ySU30Ampha6ca%2Fimage.png?alt=media\&token=6649922f-bb14-4fa0-9ea5-d9ab727bbd66)

Если установлено время отмены отправки, письма будут отображаться на странице «Исходящие» со статусом отправки «В Очереди».

## Загрузка письма

Для всех типов писем (входящие / исходящие / отмененные / с ошибкой / запланированные) у вас есть возможность загрузить исходный файл .eml. Эта функция доступна в различных разделах системы, где отображаются письма, например, в разделах «Сообщения по рабочим элементам» и «Таймлайн», а также в представлениях «Входящие» и «Отправленные».

{% hint style="info" %}
Примечание: если письмо, которое вы пытаетесь скачать, содержит вложение, которое было явно удалено пользователем вручную (например, по соображениям конфиденциальности данных), опция скачивания файла .eml для этого письма будет отключена, а при нажатии на значок скачивания система отобразит сообщение с объяснением причины отключения.
{% endhint %}

### Как включить проверку орфографии в Enate

Вы можете легко проверить орфографию и грамматику всего, что вы пишете в Enate (включая ваши электронные письма), включив проверку орфографии в браузере. Для получения информации о том, как включить проверку орфографии в самых популярных интернет-браузерах, перейдите по этой ссылке «[Как включить проверку орфографии в Enate](https://docs.enate.net/enate-help/work-manager/work-manager-2021.1/appendix/how-to-enable-spell-check-in-enate)».


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.enate.net/enate-help/ru/elektronnaya-pochta/komponenty-elektronnoi-pochty.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
