POST api/Mail/SendEmail
Request Information
URI Parameters
None.
Body Parameters
SendMailPropName | Description | Type | Additional information |
---|---|---|---|
Attachments | Collection of AttachmentsApi |
None. |
|
FromEmail | string |
None. |
|
FromName | string |
None. |
|
To | Collection of ToApi |
None. |
|
Html | string |
None. |
|
Images | Collection of ImagesApi |
None. |
|
Subject | string |
None. |
|
CC | Collection of CCApi |
None. |
|
BCC | Collection of BCCApi |
None. |
|
EmailTag | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Attachments": [ { "AttachmentsType": "sample string 1", "AttachmentsName": "sample string 2", "AttachmentsPathbase64": "sample string 3" }, { "AttachmentsType": "sample string 1", "AttachmentsName": "sample string 2", "AttachmentsPathbase64": "sample string 3" } ], "FromEmail": "sample string 1", "FromName": "sample string 2", "To": [ { "ToEmail": "sample string 1", "ToName": "sample string 2" }, { "ToEmail": "sample string 1", "ToName": "sample string 2" } ], "Html": "sample string 3", "Images": [ { "ImagesType": "sample string 1", "ImagesName": "sample string 2", "ImagesPath": "sample string 3" }, { "ImagesType": "sample string 1", "ImagesName": "sample string 2", "ImagesPath": "sample string 3" } ], "Subject": "sample string 4", "CC": [ { "CCEmail": "sample string 1", "CCName": "sample string 2" }, { "CCEmail": "sample string 1", "CCName": "sample string 2" } ], "BCC": [ { "BCCEmail": "sample string 1", "BCCName": "sample string 2" }, { "BCCEmail": "sample string 1", "BCCName": "sample string 2" } ], "EmailTag": "sample string 5" }
application/xml, text/xml
Sample:
<SendMailProp xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Attachments> <AttachmentsApi> <AttachmentsType>sample string 1</AttachmentsType> <AttachmentsName>sample string 2</AttachmentsName> <AttachmentsPathbase64>sample string 3</AttachmentsPathbase64> </AttachmentsApi> <AttachmentsApi> <AttachmentsType>sample string 1</AttachmentsType> <AttachmentsName>sample string 2</AttachmentsName> <AttachmentsPathbase64>sample string 3</AttachmentsPathbase64> </AttachmentsApi> </Attachments> <FromEmail>sample string 1</FromEmail> <FromName>sample string 2</FromName> <To> <ToApi> <ToEmail>sample string 1</ToEmail> <ToName>sample string 2</ToName> </ToApi> <ToApi> <ToEmail>sample string 1</ToEmail> <ToName>sample string 2</ToName> </ToApi> </To> <Html>sample string 3</Html> <Images> <ImagesApi> <ImagesType>sample string 1</ImagesType> <ImagesName>sample string 2</ImagesName> <ImagesPath>sample string 3</ImagesPath> </ImagesApi> <ImagesApi> <ImagesType>sample string 1</ImagesType> <ImagesName>sample string 2</ImagesName> <ImagesPath>sample string 3</ImagesPath> </ImagesApi> </Images> <Subject>sample string 4</Subject> <CC> <CCApi> <CCEmail>sample string 1</CCEmail> <CCName>sample string 2</CCName> </CCApi> <CCApi> <CCEmail>sample string 1</CCEmail> <CCName>sample string 2</CCName> </CCApi> </CC> <BCC> <BCCApi> <BCCEmail>sample string 1</BCCEmail> <BCCName>sample string 2</BCCName> </BCCApi> <BCCApi> <BCCEmail>sample string 1</BCCEmail> <BCCName>sample string 2</BCCName> </BCCApi> </BCC> <EmailTag>sample string 5</EmailTag> </SendMailProp>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
VCAPIResponseOfBooleanName | Description | Type | Additional information |
---|---|---|---|
Result | boolean |
None. |
|
Version | string |
None. |
|
dateTime | string |
None. |
|
StatusCode | integer |
None. |
|
ErrorMessage | string |
None. |
|
Result | Object |
None. |
Response Formats
application/json, text/json
Sample:
{ "Result": true, "Version": "1.0.0", "dateTime": "2025/04/28 13:45:04", "StatusCode": 2, "ErrorMessage": "sample string 3" }