MixERP.Net.Api.Config.SmtpController Class Reference

Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Smtps. More...

Inheritance diagram for MixERP.Net.Api.Config.SmtpController:

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "smtp" entity. More...
long	Count ()
	Counts the number of smtps. More...
IEnumerable< MixERP.Net.Entities.Config.Smtp >	Get ()
	Returns collection of smtp for export. More...
MixERP.Net.Entities.Config.Smtp	Get (int smtpId)
	Returns an instance of smtp. More...
IEnumerable< MixERP.Net.Entities.Config.Smtp >	Get ([FromUri] int[] smtpIds)
IEnumerable< MixERP.Net.Entities.Config.Smtp >	GetPagedResult ()
	Creates a paginated collection containing 25 smtps on each page, sorted by the property SmtpId. More...
IEnumerable< MixERP.Net.Entities.Config.Smtp >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 smtps on each page, sorted by the property SmtpId. More...
long	CountWhere ([FromBody]dynamic filters)
	Counts the number of smtps using the supplied filter(s). More...
IEnumerable< MixERP.Net.Entities.Config.Smtp >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 smtps on each page, sorted by the property SmtpId. More...
long	CountFiltered (string filterName)
	Counts the number of smtps using the supplied filter name. More...
IEnumerable< MixERP.Net.Entities.Config.Smtp >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 smtps on each page, sorted by the property SmtpId. More...
IEnumerable< DisplayField >	GetDisplayFields ()
	Displayfield is a lightweight key/value collection of smtps. More...
IEnumerable< PetaPoco.CustomField >	GetCustomFields ()
	A custom field is a user defined field for smtps. More...
IEnumerable< PetaPoco.CustomField >	GetCustomFields (string resourceId)
	A custom field is a user defined field for smtps. More...
void	AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
	Adds or edits your instance of Smtp class. More...
void	Add (MixERP.Net.Entities.Config.Smtp smtp)
	Adds your instance of Smtp class. More...
void	Edit (int smtpId, [FromBody] MixERP.Net.Entities.Config.Smtp smtp)
	Edits existing record with your instance of Smtp class. More...
List< object >	BulkImport ([FromBody]dynamic collection)
	Adds or edits multiple instances of Smtp class. More...
void	Delete (int smtpId)
	Deletes an existing instance of Smtp class via SmtpId. More...

Properties
long	LoginId [get]
int	UserId [get]
int	OfficeId [get]
string	Catalog [get]

Detailed Description

Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Smtps.

Member Function Documentation

void MixERP.Net.Api.Config.SmtpController.Add

(

MixERP.Net.Entities.Config.Smtp

smtp

)

Adds your instance of Smtp class.

Parameters

smtp	Your instance of smtps class to add.

void MixERP.Net.Api.Config.SmtpController.AddOrEdit

(

[FromBody] Newtonsoft.Json.Linq.JArray

form

)

Adds or edits your instance of Smtp class.

Parameters

smtp	Your instance of smtps class to add or edit.

List<object> MixERP.Net.Api.Config.SmtpController.BulkImport

(

[FromBody] dynamic

collection

)

Adds or edits multiple instances of Smtp class.

Parameters

collection

Your collection of Smtp class to bulk import.

Returns

Returns list of imported smtpIds.

Exceptions

MixERPException

Thrown when your any Smtp class in the collection is invalid or malformed.

long MixERP.Net.Api.Config.SmtpController.Count

(

)

Counts the number of smtps.

Returns

Returns the count of the smtps.

long MixERP.Net.Api.Config.SmtpController.CountFiltered

(

string

filterName

)

Counts the number of smtps using the supplied filter name.

Parameters

filterName

The named filter.

Returns

Returns the count of filtered smtps.

long MixERP.Net.Api.Config.SmtpController.CountWhere

(

[FromBody] dynamic

filters

)

Counts the number of smtps using the supplied filter(s).

Parameters

filters

The list of filter conditions.

Returns

Returns the count of filtered smtps.

void MixERP.Net.Api.Config.SmtpController.Delete

(

int

smtpId

)

Deletes an existing instance of Smtp class via SmtpId.

Parameters

smtpId

Enter the value for SmtpId in order to find and delete the existing record.

void MixERP.Net.Api.Config.SmtpController.Edit	(	int	smtpId,
		[FromBody] MixERP.Net.Entities.Config.Smtp	smtp
	)

Edits existing record with your instance of Smtp class.

Parameters

smtp	Your instance of Smtp class to edit.
smtpId	Enter the value for SmtpId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Config.Smtp> MixERP.Net.Api.Config.SmtpController.Get

(

)

Returns collection of smtp for export.

Returns

MixERP.Net.Entities.Config.Smtp MixERP.Net.Api.Config.SmtpController.Get

(

int

smtpId

)

Returns an instance of smtp.

Parameters

smtpId

Enter SmtpId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Config.SmtpController.GetCustomFields

(

)

A custom field is a user defined field for smtps.

Returns

Returns an enumerable custom field collection of smtps.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Config.SmtpController.GetCustomFields

(

string

resourceId

)

A custom field is a user defined field for smtps.

Returns

Returns an enumerable custom field collection of smtps.

IEnumerable<DisplayField> MixERP.Net.Api.Config.SmtpController.GetDisplayFields

(

)

Displayfield is a lightweight key/value collection of smtps.

Returns

Returns an enumerable key/value collection of smtps.

EntityView MixERP.Net.Api.Config.SmtpController.GetEntityView

(

)

Creates meta information of "smtp" entity.

Returns

Returns the "smtp" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.Config.Smtp> MixERP.Net.Api.Config.SmtpController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 smtps on each page, sorted by the property SmtpId.

Parameters

pageNumber	Enter the page number to produce the resultset.
filterName	The named filter.

Returns

Returns the requested page from the collection using the supplied filters.

IEnumerable<MixERP.Net.Entities.Config.Smtp> MixERP.Net.Api.Config.SmtpController.GetPagedResult

(

)

Creates a paginated collection containing 25 smtps on each page, sorted by the property SmtpId.

Returns

Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Config.Smtp> MixERP.Net.Api.Config.SmtpController.GetPagedResult

(

long

pageNumber

)

Creates a paginated collection containing 25 smtps on each page, sorted by the property SmtpId.

Parameters

pageNumber

Enter the page number to produce the resultset.

Returns

Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Config.Smtp> MixERP.Net.Api.Config.SmtpController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 smtps on each page, sorted by the property SmtpId.

Parameters

pageNumber	Enter the page number to produce the resultset.
filters	The list of filter conditions.

Returns

Returns the requested page from the collection using the supplied filters.

---

The documentation for this class was generated from the following file:

• C:/Users/nirvan/Desktop/mixerp/0. GitHub/src/Libraries/Web API/Config/SmtpController.cs