org.asteriskjava.manager.action

Class MailboxStatusAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.MailboxStatusAction

All Implemented Interfaces:

Serializable, ManagerAction

public class MailboxStatusAction
extends AbstractManagerAction

The MailboxStatusAction checks if a mailbox contains waiting messages.

The MailboxStatusAction returns a MailboxStatusResponse.

Version:

$Id$

Author:

srt

See Also:

MailboxStatusResponse, Serialized Form

Constructor Summary

Constructors

Constructor and Description
MailboxStatusAction() Creates a new empty MailboxStatusAction.
MailboxStatusAction(String mailbox) Creates a new MailboxStatusAction that checks for waiting messages in the given mailbox.

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of this action, i.e.
String	getMailbox() Returns the name of the mailbox to query.
void	setMailbox(String mailbox) Sets the name of the mailbox to query.

Methods inherited from class org.asteriskjava.manager.action.AbstractManagerAction

getActionId, setActionId, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MailboxStatusAction

public MailboxStatusAction()

Creates a new empty MailboxStatusAction.

MailboxStatusAction

public MailboxStatusAction(String mailbox)

Creates a new MailboxStatusAction that checks for waiting messages in the given mailbox.

Parameters:

mailbox - the name of the mailbox to check.

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.

Since:

0.2

Method Detail

getAction

public String getAction()

Returns the name of this action, i.e. "MailboxStatus".

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getMailbox

public String getMailbox()

Returns the name of the mailbox to query.

setMailbox

public void setMailbox(String mailbox)

Sets 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"