2023-08-27 10:55:55 +02:00
|
|
|
---
|
|
|
|
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.
|
2025-01-15 17:46:55 +05:30
|
|
|
- **Items**: Refer to *[#/definitions/nameEmailPair](#definitions/nameEmailPair)*.
|
2023-08-27 10:55:55 +02:00
|
|
|
- **`ccMails`** *(array)*: List of CC.
|
2025-01-15 17:46:55 +05:30
|
|
|
- **Items**: Refer to *[#/definitions/nameEmailPair](#definitions/nameEmailPair)*.
|
2023-08-27 10:55:55 +02:00
|
|
|
- **`bccMails`** *(array)*: List of BCC.
|
2025-01-15 17:46:55 +05:30
|
|
|
- **Items**: Refer to *[#/definitions/nameEmailPair](#definitions/nameEmailPair)*.
|
2023-08-27 10:55:55 +02:00
|
|
|
- **`subject`** *(string)*: Subject for Mail.
|
2025-01-15 17:46:55 +05:30
|
|
|
- **`contentType`** *(string)*: Must be one of: `["plain", "html"]`. Default: `"plain"`.
|
2023-08-27 10:55:55 +02:00
|
|
|
- **`content`** *(string)*: Content for mail.
|
|
|
|
## Definitions
|
|
|
|
|
|
|
|
- **`nameEmailPair`** *(object)*: Name Email Pair. Cannot contain additional properties.
|
|
|
|
- **`name`** *(string)*: Name.
|
2025-01-15 17:46:55 +05:30
|
|
|
- **`email`**: Email address of the user. Refer to *[../type/basic.json#/definitions/email](#/type/basic.json#/definitions/email)*.
|
2023-08-27 10:55:55 +02:00
|
|
|
|
|
|
|
|
2025-01-15 17:46:55 +05:30
|
|
|
Documentation file automatically generated at 2025-01-15 09:05:41.923720+00:00.
|