Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

31 lines
1.1 KiB
Markdown
Raw Normal View History

---
title: emailRequest
slug: /main-concepts/metadata-standard/schemas/email/emailrequest
---
# EmailRequest
*This schema defines the Email Request for creating Email*
## Properties
- **`senderName`** *(string)*: Sender Name.
- **`senderMail`** *(string)*: From Email Address.
- **`recipientMails`** *(array)*: List of Receiver Name with Email.
- **Items**: Refer to *#/definitions/nameEmailPair*.
- **`ccMails`** *(array)*: List of CC.
- **Items**: Refer to *#/definitions/nameEmailPair*.
- **`bccMails`** *(array)*: List of BCC.
- **Items**: Refer to *#/definitions/nameEmailPair*.
- **`subject`** *(string)*: Subject for Mail.
- **`contentType`** *(string)*: Must be one of: `['plain', 'html']`. Default: `plain`.
- **`content`** *(string)*: Content for mail.
## Definitions
- **`nameEmailPair`** *(object)*: Name Email Pair. Cannot contain additional properties.
- **`name`** *(string)*: Name.
- **`email`**: Email address of the user. Refer to *../type/basic.json#/definitions/email*.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.