org.asteriskjava.manager.action

Class MailboxCountAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.MailboxCountAction

All Implemented Interfaces:

Serializable, ManagerAction

public class MailboxCountAction
extends AbstractManagerAction

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

The MailboxCountAction returns a MailboxStatusResponse.

Version:

$Id$

Author:

srt

See Also:

MailboxCountResponse, Serialized Form

Constructor Summary

Constructors

Constructor and Description
MailboxCountAction() Creates a new empty MailboxCountAction.
MailboxCountAction(String mailbox) Creates a new MailboxCountAction that queries the number of unread and read 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

MailboxCountAction

public MailboxCountAction()

Creates a new empty MailboxCountAction.

MailboxCountAction

public MailboxCountAction(String mailbox)

Creates a new MailboxCountAction that queries the number of unread and read messages in the given mailbox.

Parameters:

mailbox - 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.

Since:

0.2

Method Detail

getAction

public String getAction()

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

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 number of the mailbox or a string of the form [email protected] no context is specified "default" is assumed.

This property is mandatory.