Skip to content

mail_profile

Configuration for Mail profile resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
to_list<String>Read-writeList of to whom send the mail. .
Minimum length = 6
sender_mail_address<String>Read-writeEmail Address from where mail is send.
bcc_list<String>Read-writeList to whom BCC the mail..
id<String>Read-writeId is system generated key for all the mail profile..
cc_list<String>Read-writeList to whom CC the mail..
server_name<String>Read-writeSMTP server name.
Minimum length = 1
Maximum length = 128
profile_name<String>Read-writeProfile name for the mail setting..
Minimum length = 1
Maximum length = 128
tenant_id<String>Read-onlyTenant Id of the Config Jobs.

Operations

(click to see Properties)

ADD| DELETE| GET (ALL)| GET| UPDATE

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>.

add

URL: https://<MGMT-IP>/nitro/v1/config/mail_profile?onerror=<String_value>

HTTP Method: null

Request Payload:

{mail_profile: {
<b>"to_list":<String_value></b>,
<b>"server_name":<String_value></b>,
<b>"profile_name":<String_value></b>,
"bcc_list":<String_value>,
"id":<String_value>,
"cc_list":<String_value>,
"sender_mail_address":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mail_profile":[{
"tenant_id":<String_value>,
"to_list":<String_value>,
"sender_mail_address":<String_value>,
"bcc_list":<String_value>,
"id":<String_value>,
"cc_list":<String_value>,
"server_name":<String_value>,
"profile_name":<String_value>}]}

delete

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

HTTP Method: null

Response Payload:

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

get (all)

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mail_profile":[{
"tenant_id":<String_value>,
"to_list":<String_value>,
"sender_mail_address":<String_value>,
"bcc_list":<String_value>,
"id":<String_value>,
"cc_list":<String_value>,
"server_name":<String_value>,
"profile_name":<String_value>}]}

get

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

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mail_profile":[{
"tenant_id":<String_value>,
"to_list":<String_value>,
"sender_mail_address":<String_value>,
"bcc_list":<String_value>,
"id":<String_value>,
"cc_list":<String_value>,
"server_name":<String_value>,
"profile_name":<String_value>}]}

update

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

HTTP Method: null

Request Payload:

{mail_profile:{
<b>"id":<String_value></b>,
"bcc_list":<String_value>,
"to_list":<String_value>,
"server_name":<String_value>,
"cc_list":<String_value>,
"sender_mail_address":<String_value>,
"profile_name":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mail_profile":[{
"tenant_id":<String_value>,
"to_list":<String_value>,
"sender_mail_address":<String_value>,
"bcc_list":<String_value>,
"id":<String_value>,
"cc_list":<String_value>,
"server_name":<String_value>,
"profile_name":<String_value>}]}