New-PveClusterNotificationsEndpointsSendmail

Create a new sendmail endpoint

API: POST /cluster/notifications/endpoints/sendmail, Proxmox VE API viewer

Syntax

New-PveClusterNotificationsEndpointsSendmail
    [-PveTicket <PveTicket>]
    [-Author <string>]
    [-Comment <string>]
    [-Disable <bool>]
    [-FromAddress <string>]
    [-Mailto <array>]
    [-MailtoUser <array>]
    -Name <string>
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Description
-PveTicket	PveTicket	No	Ticket data connection.
-Author	string	No	Author of the mail.
-Comment	string	No	Comment.
-Disable	bool	No	Disable this target.
-FromAddress	string	No	From address for the mail.
-Mailto	array	No	List of email recipients.
-MailtoUser	array	No	List of users.
-Name	string	Yes	The name of the endpoint.

Every parameter also binds by property name from the pipeline, so an object with node and vmid properties (the output of Get-PveGuest, for one) fills -Node and -Vmid. Without -PveTicket the cmdlet uses the last connection, see Connection.

Output

A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.