Skip to content

sent_mails

Configuration for Sent mail record item keeping. resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
to_list<String>Read-writeList of to whom send the mail. .
failed_message<String>Read-writeSubject of the mail sent..
Minimum length = 1
Maximum length = 2000
subject<String>Read-writeSubject of the mail sent..
Minimum length = 1
Maximum length = 2000
bcc_list<String>Read-writeList to whom BCC the mail..
is_auth<Boolean>Read-writeIs authentication enabled for this smtp server.
cc_list<String>Read-writeList to whom CC the mail..
port<Integer>Read-writeSMTP Server port address..
Maximum value =
is_sent<Boolean>Read-writeIs this mail sent successfully..
message<String>Read-writeContent of the mail sent..
Minimum length = 1
Maximum length = 20000
username<String>Read-writeUsername for the smtp server.
Maximum length = 128
id<String>Read-writeId is system generated key for all the sent mail record..
is_ssl<Boolean>Read-writeIs this smtp server is SSL support configured..
server_name<String>Read-writeSMTP server name.
Minimum length = 1
Maximum length = 128
profile_name<String>Read-writeProfile name through which mail sent..
Minimum length = 1
Maximum length = 128
timestamp<Double>Read-onlyTime when the mail was sent.

Operations

(click to see Properties)

DELETE| GET (ALL)

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

delete

URL: https://<MGMT-IP>/nitro/v1/config/sent_mails/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/sent_mails

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "sent_mails":[{
"to_list":<String_value>,
"failed_message":<String_value>,
"subject":<String_value>,
"bcc_list":<String_value>,
"is_auth":<Boolean_value>,
"cc_list":<String_value>,
"port":<Integer_value>,
"is_sent":<Boolean_value>,
"message":<String_value>,
"username":<String_value>,
"timestamp":<Double_value>,
"id":<String_value>,
"is_ssl":<Boolean_value>,
"server_name":<String_value>,
"profile_name":<String_value>}]}