class Asterisk::ARI::Mailboxes

Defined in:

asterisk/ari/resources/mailboxes.cr
asterisk/ari/models/mailboxes_mailbox.cr

Instance Method Summary

Instance methods inherited from class Asterisk::ARI::Resources

ari : ARI ari

Constructor methods inherited from class Asterisk::ARI::Resources

new(ari) new

Instance Method Detail

def delete(mailbox_name : String) #

Destroy a mailbox.

Arguments:

  • mailbox_name - name of the mailbox. (required);

Error responses:

  • 404 - Mailbox not found

[View source]
def get(mailbox_name : String) : HTTP::Client::Response | Mailboxes::Mailbox #

Retrieve the current state of a mailbox.

Arguments:

  • mailbox_name - name of the mailbox. (required);

Error responses:

  • 404 - Mailbox not found

[View source]
def list : HTTP::Client::Response | Array(Mailboxes::Mailbox) #

List all mailboxes.


[View source]
def update(mailbox_name : String, old_messages : Int32, new_messages : Int32) #

Change the state of a mailbox. (Note - implicitly creates the mailbox).

Arguments:

  • mailbox_name - name of the mailbox. (required);
  • old_messages - count of old messages in the mailbox. (required);
  • new_messages - count of new messages in the mailbox. (required);

Error responses:

  • 404 - Mailbox not found

[View source]