Click or drag to resize
MailboxStatusAction Class
The MailboxStatusAction checks if a mailbox contains waiting messages.
The MailboxStatusAction returns a MailboxStatusResponse.
Inheritance Hierarchy

Namespace: AsterNET.Manager.Action
Assembly: AsterNET (in AsterNET.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public class MailboxStatusAction : ManagerAction

The MailboxStatusAction type exposes the following members.

Constructors
  NameDescription
Public methodMailboxStatusAction
Creates a new empty MailboxStatusAction.
Public methodMailboxStatusAction(String)
Creates a new MailboxStatusAction that checks for waiting messages in the given mailbox.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString (Inherited from ManagerAction.)
Top
Properties
  NameDescription
Public propertyAction
Get the name of this action, i.e. "MailboxStatus".
(Overrides ManagerActionAction.)
Public propertyActionId (Inherited from ManagerAction.)
Public propertyMailbox
Get/Set the name of the mailbox to query.
This can either be only the name of the mailbox or a string of the form mailboxnumber@context. If no context is specified "default" is assumed.
Multiple mailboxes may be given, separated by ','. In this case the action checks whether at least one of the given mailboxes has waiting messages.
This property is mandatory.
Example: "1234,1235@mycontext"
Public propertyProxyKey
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.)
Public propertyServer
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.)
Top
See Also