com.citrix.sdx.nitro.resource.config.mps

Class mail_profile

java.lang.Object

com.citrix.sdx.nitro.resource.base.base_resource

com.citrix.sdx.nitro.resource.config.mps.mail_profile

public class mail_profile
extends base_resource

Configuration for Mail profile resource

Field Summary

Fields inherited from class com.citrix.sdx.nitro.resource.base.base_resource

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
mail_profile()

Method Summary

Methods

Modifier and Type	Method and Description
static mail_profile	add(nitro_service client, mail_profile resource) Use this operation to add mail profile..
static mail_profile[]	add(nitro_service client, mail_profile[] resources) Use this operation to add mail profile.
static long	count_filtered(nitro_service service, filtervalue[] filter) Use this API to count the filtered set of mail_profile resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of mail_profile resources.
static long	count(nitro_service service) Use this API to count the mail_profile resources configured on NetScaler SDX.
static mail_profile	delete(nitro_service client, mail_profile resource) Use this operation to delete mail profile..
static mail_profile[]	delete(nitro_service client, mail_profile[] resources) Use this operation to delete mail profile.
String	get_bcc_list() List to whom BCC the mail.
String	get_cc_list() List to whom CC the mail.
static mail_profile[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of mail_profile resources.
static mail_profile[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of mail_profile resources.
String	get_id() Id is system generated key for all the mail profile.
protected base_resource[]	get_nitro_bulk_response(nitro_service service, String response) Converts API response of bulk operation into object and returns the object array in case of get request.
protected base_resource[]	get_nitro_response(nitro_service service, String response) Converts API response into object and returns the object array in case of get request.
protected String	get_object_id() Returns the value of object identifier argument.
protected String	get_object_type() Gets the resource type.
String	get_profile_name() Profile name for the mail setting.
String	get_server_name() SMTP server name
String	get_to_list() List of to whom send the mail.
static mail_profile[]	get(nitro_service client) Use this operation to get mail profile..
static mail_profile	get(nitro_service client, mail_profile resource) Use this operation to get mail profile..
void	set_bcc_list(String bcc_list) List to whom BCC the mail.
void	set_cc_list(String cc_list) List to whom CC the mail.
void	set_id(String id) Id is system generated key for all the mail profile.
void	set_profile_name(String profile_name) Profile name for the mail setting.
void	set_server_name(String server_name) SMTP server name
void	set_to_list(String to_list) List of to whom send the mail.
static mail_profile	update(nitro_service client, mail_profile resource) Use this operation to modify mail profile..
static mail_profile[]	update(nitro_service client, mail_profile[] resources) Use this operation to modify mail profile.
protected void	validate(String operationType) Performs generic data validation for the operation to be performed

Methods inherited from class com.citrix.sdx.nitro.resource.base.base_resource

add_resource, add_resource, delete_bulk_request, delete_resource, get_resource, get_resource, get_resources, get_resources, getfiltered, perform_operation_bulk_request, perform_operation, perform_operation, perform_operation, resource_to_string, resource_to_string, update_bulk_request, update_resource, update_resource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

mail_profile

public mail_profile()

Method Detail

get_object_type

protected String get_object_type()

Description copied from class: base_resource

Gets the resource type.

Overrides:

get_object_type in class base_resource

Returns:

Resource Type.

get_object_id

protected String get_object_id()

Returns the value of object identifier argument.

Specified by:

get_object_id in class base_resource

set_to_list

public void set_to_list(String to_list)

 List of to whom send the mail. 
 

get_to_list

public String get_to_list()

 List of to whom send the mail. 
 

set_bcc_list

public void set_bcc_list(String bcc_list)

 List to whom BCC the mail.
 

get_bcc_list

public String get_bcc_list()

 List to whom BCC the mail.
 

set_id

public void set_id(String id)

 Id is system generated key for all the mail profile.
 

get_id

public String get_id()

 Id is system generated key for all the mail profile.
 

set_cc_list

public void set_cc_list(String cc_list)

 List to whom CC the mail.
 

get_cc_list

public String get_cc_list()

 List to whom CC the mail.
 

set_server_name

public void set_server_name(String server_name)

 SMTP server name
 

get_server_name

public String get_server_name()

 SMTP server name
 

set_profile_name

public void set_profile_name(String profile_name)

 Profile name for the mail setting.
 

get_profile_name

public String get_profile_name()

 Profile name for the mail setting.
 

add

public static mail_profile add(nitro_service client,
               mail_profile resource)
                        throws Exception

 Use this operation to add mail profile..
 

Throws:

Exception

add

public static mail_profile[] add(nitro_service client,
                 mail_profile[] resources)
                          throws Exception

 Use this operation to add mail profile. in bulk.
 

Throws:

Exception

delete

public static mail_profile delete(nitro_service client,
                  mail_profile resource)
                           throws Exception

 Use this operation to delete mail profile..
 

Throws:

Exception

delete

public static mail_profile[] delete(nitro_service client,
                    mail_profile[] resources)
                             throws Exception

 Use this operation to delete mail profile. in bulk.
 

Throws:

Exception

get

public static mail_profile[] get(nitro_service client)
                          throws Exception

 Use this operation to get mail profile..
 

Throws:

Exception

get

public static mail_profile get(nitro_service client,
               mail_profile resource)
                        throws Exception

Use this operation to get mail profile..

Throws:

Exception

update

public static mail_profile update(nitro_service client,
                  mail_profile resource)
                           throws Exception

 Use this operation to modify mail profile..
 

Throws:

Exception

update

public static mail_profile[] update(nitro_service client,
                    mail_profile[] resources)
                             throws Exception

 Use this operation to modify mail profile. in bulk.
 

Throws:

Exception

get_filtered

public static mail_profile[] get_filtered(nitro_service service,
                          String filter)
                                   throws Exception

Use this API to fetch filtered set of mail_profile resources. filter string should be in JSON format.eg: "vm_state:DOWN,name:[a-z]+"

Throws:

Exception

get_filtered

public static mail_profile[] get_filtered(nitro_service service,
                          filtervalue[] filter)
                                   throws Exception

Use this API to fetch filtered set of mail_profile resources. set the filter parameter values in filtervalue object.

Throws:

Exception

count

public static long count(nitro_service service)
                  throws Exception

Use this API to count the mail_profile resources configured on NetScaler SDX.

Throws:

Exception

count_filtered

public static long count_filtered(nitro_service service,
                  String filter)
                           throws Exception

Use this API to count the filtered set of mail_profile resources. filter string should be in JSON format.eg: "vm_state:DOWN,name:[a-z]+"

Throws:

Exception

count_filtered

public static long count_filtered(nitro_service service,
                  filtervalue[] filter)
                           throws Exception

Use this API to count the filtered set of mail_profile resources. set the filter parameter values in filtervalue object.

Throws:

Exception

get_nitro_response

protected base_resource[] get_nitro_response(nitro_service service,
                                 String response)
                                      throws Exception

 Converts API response into object and returns the object array in case of get request.
 

Specified by:

get_nitro_response in class base_resource

Throws:

Exception

get_nitro_bulk_response

protected base_resource[] get_nitro_bulk_response(nitro_service service,
                                      String response)
                                           throws Exception

 Converts API response of bulk operation into object and returns the object array in case of get request.
 

Specified by:

get_nitro_bulk_response in class base_resource

Throws:

Exception

validate

protected void validate(String operationType)
                 throws Exception

 Performs generic data validation for the operation to be performed
 

Overrides:

validate in class base_resource

Parameters:

operationType - : add,delete,modify,get etc.

Throws:

Exception