Console API

MailMessage

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 the original message sent using Email APIs.

Method Summary
  deleteMessage()

Deletes the message. Messages are automatically deleted after a certain amount of time determined by the activation key. Calling this method forces an immediate delete.

Date getDateSent()

Returns the date the email was sent.

String getDeliveryWorkflow()

Returns the delivery workflow, if any.

String getId()

Returns the Message ID associated with this email.

String getPalId()

Returns the Pal ID of the pal that sent this email.

String getReplyWorkflow()

Returns the reply workflow, if any.

String getSubject()

Returns the subject of the email.

String getTo()

Returns the email address the message was sent to.

String getTxId()

Returns the Transaction ID, if any, associated with this email.

boolean isDeliveryEnabled()

Returns true if this email has delivery enabled.

boolean isReplyEnabled()

Returns true if this email has reply enabled.

  setDeliveryStatus(String deliveryStatus)

Sets the status of this email.

String toString()

Returns a description of this object

Method Detail


deleteMessage()

Deletes the message. Messages are automatically deleted after a certain amount of time determined by the activation key. Calling this method forces an immediate delete.

Since: 12-06-2013

top

Date getDateSent()

Returns the date the email was sent.

Returns:  Date

Since: 12-06-2013

top

String getDeliveryWorkflow()

Returns the delivery workflow, if any.

Returns:  String

Since: 05-09-2014

top

String getId()

Returns the Message ID associated with this email.

Returns:  String

Since: 04-24-2014

top

String getPalId()

Returns the Pal ID of the pal that sent this email.

Returns:  String

Since: 12-06-2013

top

String getReplyWorkflow()

Returns the reply workflow, if any.

Returns:  String

Since: 05-09-2014

top

String getSubject()

Returns the subject of the email.

Returns:  String

Since: 12-06-2013

top

String getTo()

Returns the email address the message was sent to.

Returns:  String

Since: 12-06-2013

top

String getTxId()

Returns the Transaction ID, if any, associated with this email.

Returns:  String

Since: 12-06-2013

top

boolean isDeliveryEnabled()

Returns true if this email has delivery enabled.

Returns:  boolean

Since: 05-09-2014

top

boolean isReplyEnabled()

Returns true if this email has reply enabled.

Returns:  boolean

Since: 05-09-2014

top

setDeliveryStatus(String deliveryStatus)

Sets the status of this email.

Parameters:

  • String   deliveryStatus Allowed values: Relayed, Expanded, Delivered, Failed, Complaint, Blocked.

Since: 04-26-2014

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