Developer Documentation
NetScaler SDX 14.1 NITRO API Reference

sent_mails

March 20, 2024
Contributed by: 
C

Configuration for Sent mail record item keeping. resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
to_list Read-write List of to whom send the mail. .
failed_message Read-write Subject of the mail sent..

Minimum length = 1

Maximum length = 2000
subject Read-write Subject of the mail sent..

Minimum length = 1

Maximum length = 2000
bcc_list Read-write List to whom BCC the mail..
is_auth Read-write Is authentication enabled for this smtp server.
cc_list Read-write List to whom CC the mail..
port Read-write SMTP Server port address..

Maximum value =
is_sent Read-write Is this mail sent successfully..
message Read-write Content of the mail sent..

Minimum length = 1

Maximum length = 20000
username Read-write Username for the smtp server.

Maximum length = 128
id Read-write Id is system generated key for all the sent mail record..
is_ssl Read-write Is this smtp server is SSL support configured..
server_name Read-write SMTP server name.

Minimum length = 1

Maximum length = 128
profile_name Read-write Profile name through which mail sent..

Minimum length = 1

Maximum length = 128
timestamp Read-only Time 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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

delete

URL: https://<MGMT-IP>/nitro/v2/config/sent_mails/id_value<String> HTTPS Method: DELETE

Request Headers: X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload: 

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

<!--NeedCopy-->

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/sent_mails Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/sent_mails ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of sent_mails resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/sent_mails ?pagesize=#no;pageno=#no Use this query-parameter to get the sent_mails resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/sent_mails ?count=yes Use this query-parameter to get the count of sent_mails resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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>}]}

<!--NeedCopy-->
sent_mails
March 20, 2024
Contributed by: 
C
March 20, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.