asternet/Asterisk.2013/Asterisk.NET/Manager/Action/MailboxCountAction.cs
2015-01-03 15:37:29 +00:00

48 lines
1.7 KiB
C#

namespace AsterNET.Manager.Action
{
/// <summary>
/// The MailboxCountAction queries the number of unread and read messages in a mailbox.<br />
/// The MailboxCountAction returns a MailboxStatusResponse.
/// </summary>
/// <seealso cref="Manager.Response.MailboxCountResponse" />
public class MailboxCountAction : ManagerAction
{
/// <summary>
/// Creates a new empty MailboxCountAction.
/// </summary>
public MailboxCountAction()
{
}
/// <summary>
/// Creates a new MailboxCountAction that queries the number of unread and
/// read messages in the given mailbox.
/// </summary>
/// <param name="mailbox">
/// the name of the mailbox to query.<br />
/// 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.
/// </param>
public MailboxCountAction(string mailbox)
{
Mailbox = mailbox;
}
/// <summary>
/// Get the name of this action, i.e. "MailboxCount".
/// </summary>
public override string Action
{
get { return "MailboxCount"; }
}
/// <summary>
/// Get/Set the name of the mailbox to query.<br />
/// 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.<br />
/// This property is mandatory.
/// </summary>
public string Mailbox { get; set; }
}
}