New-PveClusterNotificationsEndpointsSmtp

Create a new smtp endpoint

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

Syntax

New-PveClusterNotificationsEndpointsSmtp
    [-PveTicket <PveTicket>]
    [-Author <string>]
    [-Comment <string>]
    [-Disable <bool>]
    -FromAddress <string>
    [-Mailto <array>]
    [-MailtoUser <array>]
    [-Mode <string>]
    -Name <string>
    [-Password <SecureString>]
    [-Port <int>]
    -Server <string>
    [-Username <string>]
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Description
-PveTicket	PveTicket	No	Ticket data connection.
-Author	string	No	Author of the mail. Defaults to ‘Proxmox VE’.
-Comment	string	No	Comment.
-Disable	bool	No	Disable this target.
-FromAddress	string	Yes	From address for the mail.
-Mailto	array	No	List of email recipients.
-MailtoUser	array	No	List of users.
-Mode	string	No	Determine which encryption method shall be used for the connection. Values: insecure, starttls, tls.
-Name	string	Yes	The name of the endpoint.
-Password	SecureString	No	Password for SMTP authentication.
-Port	int	No	The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections.
-Server	string	Yes	The address of the SMTP server.
-Username	string	No	Username for SMTP authentication.

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.