Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Mailboxes

Hierarchy

  • Mailboxes

Index

Methods

Methods

delete

  • delete(params: { mailboxName: string }, callback: (err: Error) => void): void
  • delete(params: { mailboxName: string }): Promise<void>

  • Destroy a mailbox.

    Parameters

    • params: { mailboxName: string }
      • mailboxName: string

        Name of the mailbox.

    • callback: (err: Error) => void
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns void

  • Destroy a mailbox.

    Parameters

    • params: { mailboxName: string }
      • mailboxName: string

        Name of the mailbox.

    Returns Promise<void>

get

  • get(params: { mailboxName: string }, callback: (err: Error, mailbox: Mailbox) => void): void
  • get(params: { mailboxName: string }): Promise<Mailbox>

  • Retrieve the current state of a mailbox.

    Parameters

    • params: { mailboxName: string }
      • mailboxName: string

        Name of the mailbox.

    • callback: (err: Error, mailbox: Mailbox) => void
        • (err: Error, mailbox: Mailbox): void

        • Parameters

          Returns void

    Returns void

  • Retrieve the current state of a mailbox.

    Parameters

    • params: { mailboxName: string }
      • mailboxName: string

        Name of the mailbox.

    Returns Promise<Mailbox>

list

  • list(callback: (err: Error, mailboxs: Mailbox[]) => void): void
  • list(): Promise<Mailbox[]>

  • List all mailboxes.

    Parameters

    • callback: (err: Error, mailboxs: Mailbox[]) => void
        • (err: Error, mailboxs: Mailbox[]): void

        • Parameters

          Returns void

    Returns void

  • List all mailboxes.

    Returns Promise<Mailbox[]>

update

  • update(params: { mailboxName: string; newMessages: number; oldMessages: number }, callback: (err: Error) => void): void
  • update(params: { mailboxName: string; newMessages: number; oldMessages: number }): Promise<void>

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

    Parameters

    • params: { mailboxName: string; newMessages: number; oldMessages: number }
      • mailboxName: string

        Name of the mailbox.

      • newMessages: number

        Count of new messages in the mailbox.

      • oldMessages: number

        Count of old messages in the mailbox.

    • callback: (err: Error) => void
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns void

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

    Parameters

    • params: { mailboxName: string; newMessages: number; oldMessages: number }
      • mailboxName: string

        Name of the mailbox.

      • newMessages: number

        Count of new messages in the mailbox.

      • oldMessages: number

        Count of old messages in the mailbox.

    Returns Promise<void>

Generated using TypeDoc