Console API

MailBox

List of Classes

ConsoleController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

CommonPacket

ConsoleManager

ConsolePacket

ConsoleResponse

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

DownloadResponse

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

FtpRequest

GeoUtil

GroupConcat

ImageFile

Inspector

Installer

InstallerPal

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

MobileManager

Modules

Monitor

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

TextEmail

TextMessage

TiffBuilder

TransactionPacket

TransactionUtil

Tunnel

TunnelResult

UnknownFile

Upload

User

VCardFile

Validator

ValidityCheck

Wizard

WorkflowResponse

XMLReader

ZoneAccess

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: Nov 18, 2024 01:04 PM