Type Definitions
AdditionalEmailOptions
- Description:
Additional options for sending emails
- Source:
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
attachments |
Array.<Attachment> |
<optional> |
Optional list of email attachments |
category |
string |
<optional> |
Optional category for the email |
send_at |
Date |
<optional> |
Optional scheduled send time |
Additional options for sending emails
Type:
- Object
Attachment
- Description:
Email attachment configuration
- Source:
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
contentURL |
string | URL or path to the attachment content |
|
filename |
string | Name of the file shown to recipients |
|
contentType |
string |
<optional> |
Optional MIME type |
contentDisposition |
string |
<optional> |
Optional content disposition (inline/attachment) |
Email attachment configuration
Type:
- Object
EmailAddress
- Description:
Email address with optional display name
- Source:
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
email |
string | The email address |
|
name |
string |
<optional> |
Optional display name |
Email address with optional display name
Type:
- Object
EmailContent
- Description:
Email content type
- Source:
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
from |
string | Sender email address |
|
subject |
string | Subject of the email |
|
category |
string | Optional category for the email |
|
html |
string |
<optional> |
Optional HTML content of the email |
text |
string |
<optional> |
Optional plain text content of the email |
tracking |
boolean |
<optional> |
Optional flag for tracking links in the email |
Email content type
Type:
- Object
EmailData
- Description:
Recipient email value
- Source:
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
email |
string | The email address (when using object form) |
|
name |
string |
<optional> |
Optional display name (object form only) |
Recipient email value
Type:
- Object | string
EmailRecord
- Description:
Group entry record to insert
- Source:
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
email |
EmailData | Recipient email as string or object with optional name |
|
substitutions |
Object.<string, string> |
<optional> |
Optional key-value substitutions available in templates |
Group entry record to insert
Type:
- Object
FailHandling
- Description:
Failure handling strategy for group insert operations
- Source:
Failure handling strategy for group insert operations
Type:
- "ABORT" | string
Images
- Description:
Image attachment configuration
!Sendlix Plus feature
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
placeholder |
string | Placeholder string in the email content to be replaced by the image |
data |
ArrayBuffer | Binary data of the image |
type |
"PNG" | "JPG" | "GIF" | Type of the image |
Image attachment configuration
!Sendlix Plus feature
Type:
- Object
SendEmailResponse
- Description:
Response type for the email sending operation
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
messageList |
Array.<string> | List of the email messages ids sent |
emailsLeft |
number | Number of email credits left in the account |
Response type for the email sending operation
Type:
- Object
mailOption
- Description:
Configuration object for sending an email
- Source:
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
from |
EmailAddress | Sender email address and optional name |
|
to |
Array.<EmailAddress> | List of recipient email addresses |
|
cc |
Array.<EmailAddress> |
<optional> |
Optional list of CC recipients |
bcc |
Array.<EmailAddress> |
<optional> |
Optional list of BCC recipients |
subject |
string | Email subject line |
|
replyTo |
EmailAddress |
<optional> |
Optional reply-to address |
html |
string |
<optional> |
Optional HTML content of the email |
text |
string |
<optional> |
Optional plain text content of the email |
tracking |
boolean |
<optional> |
Optional flag for tracking links in the email |
images |
Array.<Images> |
<optional> |
Optional list of images to embed in the email |
Configuration object for sending an email
Type:
- Object