View a Tugboat Service

Retrieves the details of one or more Tugboat Services.

Arguments

  • message - Optional, Required if preview is not set
    The message to list. This can be a single message ID, or an array of message IDs. If not specified, all messages that the user has permission to view are returned.

  • preview - Optional, Required if message is not set
    Only list messages in the provided preview. This can be a single preview ID, or an array of preview IDs. If message is also specified, this argument is ignored.

  • read - Optional
    If true, return messages that have been read. Only applies if message is not also set. Default: true

  • unread - Optional
    If true, return messages that have not been read. Only applies if message is not also set. Default: true

Example

socket.emit('tugboat', 'mail', 'list', args, callback);

Output

The requested messages. If a requested message is not returned, it either does not exist, or the API key used to make the request does not have permission to view it.

Errors

  • 1026: No Messages Found
    Returned if the requested messages do not exist, or the requestor does not have permission to view them.

results matching ""

    No results matching ""