EmailClient (preview:2025-01-15)

2025/01/15 • 2 new methods

Email_GetSendResult (new)
Description :  Gets the status of the email send operation.
Reference :  Link ¶

⚼ Request

GET:  /emails/operations/{operationId}
{
operationId:
{
Description: ID of the long running operation (GUID) returned from a previous call to send email ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code - this will be the same as the code in the error property in the response body. ,
}
string ,
}
,
$schema:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: This header will only be present when the status is a non-terminal status. It indicates the minimum amount of time in seconds to wait before polling for operation status again. ,
}
integer ,
}
,
$schema:
{
Description: Status of the long running operation ,
}
{
id:
{
Description: The unique id of the operation. Use a UUID. ,
Required: True ,
}
string ,
status:
{
Description: Status of operation. ,
Enum:
{
NotStarted: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error details when status is a non-success terminal state. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
Email_Send (new)
Description :  Queues an email message to be sent to one or more recipients
Reference :  Link ¶

⚼ Request

POST:  /emails:send
{
Operation-Id:
{
Description: This is the ID provided by the customer to identify the long running operation. If an ID is not provided by the customer, the service will generate one. ,
Format: uuid ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: Tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
emailMessage:
{
Description: Message payload for sending an email ,
Required: True ,
}
{
headers:
{
Description: Custom email headers to be passed. ,
Required: False ,
}
object ,
senderAddress:
{
Description: Sender email address from a verified domain. ,
Required: True ,
}
string ,
senderDisplayName:
{
Description: Email display name of the sender. ,
Required: False ,
}
string ,
content:
{
Description: Email content to be sent. ,
Required: True ,
}
{
subject:
{
Description: Subject of the email message ,
Required: True ,
}
string ,
plainText:
{
Description: Plain text version of the email message. ,
Required: False ,
}
string ,
html:
{
Description: Html version of the email message. ,
Required: False ,
}
string ,
}
,
recipients:
{
Description: Recipients for the email. ,
Required: True ,
}
{
to:
{
Description: Email To recipients ,
Required: True ,
}
[
{
address:
{
Description: Email address. ,
Required: True ,
}
string ,
displayName:
{
Description: Email display name. ,
Required: False ,
}
string ,
}
,
]
,
cc:
{
Description: Email CC recipients ,
Required: False ,
}
[
{
address:
{
Description: Email address. ,
Required: True ,
}
string ,
displayName:
{
Description: Email display name. ,
Required: False ,
}
string ,
}
,
]
,
bcc:
{
Description: Email BCC recipients ,
Required: False ,
}
[
{
address:
{
Description: Email address. ,
Required: True ,
}
string ,
displayName:
{
Description: Email display name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
attachments:
{
Description: List of attachments. Please note that we limit the total size of an email request (which includes both regular and inline attachments) to 10MB. ,
Required: False ,
}
[
{
name:
{
Description: Name of the attachment ,
Required: True ,
}
string ,
contentType:
{
Description: MIME type of the content being attached. ,
Required: True ,
}
string ,
contentInBase64:
{
Description: Base64 encoded contents of the attachment ,
Format: byte ,
Required: True ,
}
string ,
contentId:
{
Description: Unique identifier (CID) to reference an inline attachment. ,
Required: False ,
}
string ,
}
,
]
,
replyTo:
{
Description: Email addresses where recipients' replies will be sent to. ,
Required: False ,
}
[
{
address:
{
Description: Email address. ,
Required: True ,
}
string ,
displayName:
{
Description: Email display name. ,
Required: False ,
}
string ,
}
,
]
,
userEngagementTrackingDisabled:
{
Description: Indicates whether user engagement tracking should be disabled for this request if the resource-level user engagement tracking setting was already enabled in the control plane. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code - this will be the same as the code in the error property in the response body. ,
}
string ,
}
,
$schema:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: Location url of where to poll the status of this operation from. ,
}
string ,
retry-after:
{
Description: This header will only be present when the operation status is a non-terminal status. It indicates the minimum amount of time in seconds to wait before polling for operation status again. ,
}
integer ,
}
,
$schema:
{
Description: Status of the long running operation ,
}
{
id:
{
Description: The unique id of the operation. Use a UUID. ,
Required: True ,
}
string ,
status:
{
Description: Status of operation. ,
Enum:
{
NotStarted: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error details when status is a non-success terminal state. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}