User API

MailBox

Other API in Package

Web

Internal Tunnel

Internal Web

Tunnel

Represents a remote mail box (POP3 or IMAP or WS).

Method Summary
  closeConnection()

Closes the remote connection.

MailMessage getMessage(String messageId)

Returns the MailMessage identified by Message ID and associated with this MailBox. A message ID is provided to the console system workflow of a pal that is registered to the subscription service.

MailBoxList getMessages(int startRecord, int limit)

Returns a MailBoxList providing the ability to retrieve a group of messages (up to 100).

String toString()

Returns a description of this object.

Method Detail


closeConnection()

Closes the remote connection.

Since: 12-06-2013

top

MailMessage getMessage(String messageId)

Returns the MailMessage identified by Message ID and associated with this MailBox. A message ID is provided to the console system workflow of a pal that is registered to the subscription service.

Parameters:

  • String   messageId Required parameter.

Returns:  MailMessage

Since: 04-26-2014

top

MailBoxList getMessages(int startRecord, int limit)

Returns a MailBoxList providing the ability to retrieve a group of messages (up to 100).

Parameters:

  • int   startRecord  - Use 1 here if you don't know where to start..
  • int   limit Maximum allowed size of parameter: 100

Returns:  MailBoxList

Since: 12-06-2013

top

String toString()

Returns a description of this object.

Returns:  String

Since: 12-06-2013

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Dec 03, 2024 10:24 AM