MailboxCountAction Class

The MailboxCountAction queries the number of unread and read messages in a mailbox.
The MailboxCountAction returns a MailboxStatusResponse.

Inheritance Hierarchy

SystemObject
AsterNET.Manager.ActionManagerAction
AsterNET.Manager.ActionMailboxCountAction

Namespace: AsterNET.Manager.Action
Assembly: AsterNET (in AsterNET.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

public class MailboxCountAction : ManagerAction

Public Class MailboxCountAction
	Inherits ManagerAction

public ref class MailboxCountAction : public ManagerAction

type MailboxCountAction =  
    class
        inherit ManagerAction
    end

The MailboxCountAction type exposes the following members.

Constructors

	Name	Description
	MailboxCountAction	Creates a new empty MailboxCountAction.
	MailboxCountAction(String)	Creates a new MailboxCountAction that queries the number of unread and read messages in the given mailbox.

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	(Inherited from ManagerAction.)

Properties

	Name	Description
	Action	Get the name of this action, i.e. "MailboxCount". (Overrides ManagerActionAction.)
	ActionId	(Inherited from ManagerAction.)
	Mailbox	Get/Set the name of the mailbox to query. This can either be only the number of the mailbox or a string of the form mailboxnumber@context.If no context is specified "default" is assumed. This property is mandatory.
	ProxyKey	You can use this as a simple authentication mechanism. Rather than have to login with a username & password, you can specify a ProxyKey that must be passed from a client before requests are processed. This is helpful in situations where you would like to authenticate and execute an action in a single step. (Inherited from ManagerAction.)
	Server	Specify a server to which to send your commands (x.x.x.x or hostname). This should match the server name specified in your config file's "host" entry. If you do not specify a server, the proxy will pick the first one it finds -- fine in single-server configurations. (Inherited from ManagerAction.)