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

Class sent_mails

java.lang.Object

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

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

public class sent_mails
extends base_resource

Configuration for Sent mail record item keeping. resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
sent_mails()

Method Summary

Methods

Modifier and Type	Method and Description
static long	count_filtered(nitro_service service, filtervalue[] filter) Use this API to count the filtered set of sent_mails resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of sent_mails resources.
static long	count(nitro_service service) Use this API to count the sent_mails resources configured on NetScaler SDX.
static sent_mails	delete(nitro_service client, sent_mails resource) Use this operation to delete sent mail details..
static sent_mails[]	delete(nitro_service client, sent_mails[] resources) Use this operation to delete sent mail details.
String	get_bcc_list() List to whom BCC the mail.
String	get_cc_list() List to whom CC the mail.
String	get_failed_message() Subject of the mail sent.
static sent_mails[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of sent_mails resources.
static sent_mails[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of sent_mails resources.
String	get_id() Id is system generated key for all the sent mail record.
Boolean	get_is_auth() Is authentication enabled for this smtp server
Boolean	get_is_sent() Is this mail sent successfully.
Boolean	get_is_ssl() Is this smtp server is SSL support configured.
String	get_message() Content of the mail sent.
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.
Integer	get_port() SMTP Server port address.
String	get_profile_name() Profile name through which mail sent.
String	get_server_name() SMTP server name
String	get_subject() Subject of the mail sent.
Double	get_timestamp() Time when the mail was sent
String	get_to_list() List of to whom send the mail.
String	get_username() Username for the smtp server
static sent_mails[]	get(nitro_service client) Use this operation to get sent mail details..
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_failed_message(String failed_message) Subject of the mail sent.
void	set_id(String id) Id is system generated key for all the sent mail record.
void	set_is_auth(Boolean is_auth) Is authentication enabled for this smtp server
void	set_is_sent(Boolean is_sent) Is this mail sent successfully.
void	set_is_ssl(Boolean is_ssl) Is this smtp server is SSL support configured.
void	set_message(String message) Content of the mail sent.
void	set_port(Integer port) SMTP Server port address.
void	set_profile_name(String profile_name) Profile name through which mail sent.
void	set_server_name(String server_name) SMTP server name
void	set_subject(String subject) Subject of the mail sent.
void	set_to_list(String to_list) List of to whom send the mail.
void	set_username(String username) Username for the smtp server
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

sent_mails

public sent_mails()

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_failed_message

public void set_failed_message(String failed_message)

 Subject of the mail sent.
 

get_failed_message

public String get_failed_message()

 Subject of the mail sent.
 

set_subject

public void set_subject(String subject)

 Subject of the mail sent.
 

get_subject

public String get_subject()

 Subject of the mail sent.
 

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_is_auth

public void set_is_auth(Boolean is_auth)

 Is authentication enabled for this smtp server
 

get_is_auth

public Boolean get_is_auth()

 Is authentication enabled for this smtp server
 

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_port

public void set_port(Integer port)

 SMTP Server port address.
 

get_port

public Integer get_port()

 SMTP Server port address.
 

set_is_sent

public void set_is_sent(Boolean is_sent)

 Is this mail sent successfully.
 

get_is_sent

public Boolean get_is_sent()

 Is this mail sent successfully.
 

set_message

public void set_message(String message)

 Content of the mail sent.
 

get_message

public String get_message()

 Content of the mail sent.
 

set_username

public void set_username(String username)

 Username for the smtp server
 

get_username

public String get_username()

 Username for the smtp server
 

get_timestamp

public Double get_timestamp()

 Time when the mail was sent
 

set_id

public void set_id(String id)

 Id is system generated key for all the sent mail record.
 

get_id

public String get_id()

 Id is system generated key for all the sent mail record.
 

set_is_ssl

public void set_is_ssl(Boolean is_ssl)

 Is this smtp server is SSL support configured.
 

get_is_ssl

public Boolean get_is_ssl()

 Is this smtp server is SSL support configured.
 

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 through which mail sent.
 

get_profile_name

public String get_profile_name()

 Profile name through which mail sent.
 

delete

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

 Use this operation to delete sent mail details..
 

Throws:

Exception

delete

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

 Use this operation to delete sent mail details. in bulk.
 

Throws:

Exception

get

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

 Use this operation to get sent mail details..
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

Use this API to fetch filtered set of sent_mails 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 sent_mails 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 sent_mails 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 sent_mails 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