Web Mail Object Class Definitions

This document outlines the class definitions for the MEWebMail object. All object classes are referenced as MEWebMail.{ClassName}, eg: MEWebMail.Messages

Appointment

This class is used to manage Calendaring Appointments

Properties

Name	Type
Mailbox	String
Postoffice	String
StartDate As Variant	Variant or Recordset
FinishDate As Variant	Variant or Recordset
MessageID	String

Methods

Method	Paramater Syntax
AddAppointment	Public Function AddAppointment() As Long
RemoveAppointment	Public Function RemoveAppointment() As Long
MoveAppointment	Public Function MoveAppointment(ByVal NewStartDate As Variant, ByVal NewFinishDate As Variant) As Long

AppointmentItem

This class is used to manage the content associated with a Calendaring Appointment. A calandaering appointment has a mail message associated with it. This class allows you to manage the content of this mail message.

Properties

Name	Type
Mailbox	String
Postoffice	String
Subject	String
StartTime As Variant	Variant or Recordset
FinishTime As Variant	Variant or Recordset
MessageBody	String
Headers	String
MessageID	String

Methods

Method	Paramater Syntax
AddAppointmentItem	Function AddAppointmentItem()
GetAppointmentItem	Function GetAppointmentItem(MessageFile As String) As Long
GetHeader	Function GetHeader(ByVal HeaderName As String) As String
SetHeader	Function SetHeader(ByVal HeaderName As String, ByVal HeaderValue As String) As Long
UpdateAppointmentItem	Function UpdateAppointmentItem() As Long
RemoveAppointmentItem	Function RemoveAppointmentItem() As Long

Calendar

This class allows you to access the calendar associated with a mailbox. This object will return the users calendar or schedule for the period specified.

Properties

Name	Type
TimeUnit	String
StartDate As Variant	Variant or Recordset
FinishDate As Variant	Variant or Recordset
TimeUnitSize	Long
NumAppointmentBlocks	Long
Postoffice	String
Mailbox	String
AppointmentCount	Long
ConcurrentAppointmentCount	Long

Methods

Method	Paramater Syntax
GetStartIndex	Function GetStartIndex(ByVal StartTime As Variant, ByVal AppointmentStartTime As Variant)
GetFinishIndex	Function GetFinishIndex(ByVal StartTime As Variant, ByVal FinishTime As Variant, ByVal AppointmentFinishTime As Variant)
ListAppointments	Function ListAppointments()

Contacts

This class manages the contact list associated with a users mailbox.

Properties

Name	Type
Postoffice	String
UserName	String
Password	String
RelativeFolderPath	String
SortOrder	String
TopRecord	Long
RecordsPerPage	Long
NumRecords	Long

Methods

Method	Paramater Syntax
XMLOrderBy	Function XMLOrderBy(OrderString)
ZeroPrefixString	Function ZeroPrefixString(ByVal InString As String, ByVal MaxLen As Long)
ListContacts	Function ListContacts()

MailFolder

This class is used to manage the folders within a users mailbox

Methods

Method	Paramater Syntax
DeleteFolder	Public Function DeleteFolder(ByVal PostOffice, ByVal Username, ByVal Password, ByVal RelativeFolderPath)
CreateFolder	Public Function CreateFolder(ByVal PostOffice, ByVal Username, ByVal Password, ByVal ParentRelativeFolderPath As String, ByVal FolderName)
MoveFolder	Public Function MoveFolder(ByVal PostOffice, ByVal Username, ByVal Password, ByVal RelativeFolderPath, ByVal ParentRelativeFolderPath)
RenameFolder	Public Function RenameFolder(ByVal PostOffice, ByVal Username, ByVal Password, ByVal RelativeFolderPath, ByVal NewFolderName)

MailFolders

Thisd class is used to return a collection of the folders associated with a users mailbox.

Methods

Method	Paramater Syntax
StripNulls	Function StripNulls(OriginalStr As String) As String
GetFolders	Public Function GetFolders(ByVal Postoffice, ByVal UserName, ByVal Password, ByVal RelativeFolderPath)
InitialiseFolders	Public Function InitialiseFolders(ByVal Postoffice, ByVal UserName, ByVal Password) As Long

Mailbox

This class is used to manage mailboxes and to change the properties of a users mailbox

Properties

Name	Type
Postoffice	String
Mailbox	String
RedirectAddress	String
RedirectStatus	Long
Status	Long
Limit	Long
Size	Long
Host	String

Methods

Method	Paramater Syntax
SetHost	Public Function SetHost() As Long
FindFirstMailbox	Public Function FindFirstMailbox() As Long
FindNextMailbox	Public Function FindNextMailbox() As Long
AddMailbox	Public Function AddMailbox() As Long
GetMailbox	Public Function GetMailbox() As Long
RemoveMailbox	Public Function RemoveMailbox() As Long
EditMailbox	Public Function EditMailbox(ByVal NewPostoffice As String, ByVal NewMailbox As String, ByVal NewRedirectAddress As String, ByVal NewRedirectStatus As Long, ByVal NewStatus As Long, ByVal NewLimit As Long, ByVal NewSize As Long) As Long
SetAutoResponderStatus	Public Function SetAutoResponderStatus(ByVal bEnabled As Boolean) As Long
SetAutoResponderContents	Public Function SetAutoResponderContents(ByVal Headers As String, ByVal MessageBody As String) As Long
GetAutoResponderContents	Public Function GetAutoResponderContents() As String
GetAutoResponderStatus	Public Function GetAutoResponderStatus() As Boolean
GetTimeZone	Public Function GetTimeZone()
SetTimeZone	Public Function SetTimeZone(ByVal TimeZone)
GetCharset	Public Function GetCharset()
SetCharset	Public Function SetCharset(ByVal CharSet)
GetGMTAdjustment	Public Function GetGMTAdjustment(TimeZone)
SetSignature	Function SetSignature(Postoffice As String, Mailbox As String, SignitureText As String) As Long
GetSignature	Function GetSignature(Postoffice As String, Mailbox As String) As String
GetAutoSignatureStatus	Public Function GetAutoSignatureStatus(sAccount As Variant, sMailbox As Variant) As Long
SetAutoSignatureStatus	Public Function SetAutoSignatureStatus(sAccount As Variant, sMailbox As Variant, lStatus As Long) As Long

MailMessage

This class allows you to manage the properties of an individual mail message. This includes composing and reading the message.

Properties

Name	Type
Postoffice	String
UserName	String
Password	String
RelativeFolderPath	String
ToRecipients	String
ToRecipientsAlias	String
ToRecipientsEmail	String
CCRecipients	String
CCRecipientsAlias	String
CCRecipientsEmail	String
BCCRecipients	String
FromRecipients	String
FromRecipientsEmail	String
FromRecipientsAlias	String
ReplyTo	String
Size	Long
Subject	String
MessageID	String
Body	String
Importance	String
FlagStatus	String
Attachment	String
MessageDate	String
Received	String
MarkAsRead	Long
Recipient	String
Recipients As MailRecipients	Variant or Recordset
MessageHeader	String
ResolvedRecipients	Variant or Recordset
UnResolvedRecipients	Variant or Recordset
SaveToSentItems	Long
ComposeMode As Boolean	Variant or Recordset
CharSet	String
ApplicationPath	String
MIMEContentType	String
MIMEBoundary	String
MIMEVersion	String
MIMECharset	String
MIMETransferEncoding	String
HTMLFormattingEnabled As Boolean	Variant or Recordset

Methods

Method	Paramater Syntax
GetHeaderField	Function GetHeaderField(ByVal HeaderTag As String) As String
Compose_SaveMessageDetails	Function Compose_SaveMessageDetails() As Long
GetAttachments	Function GetAttachments()
Compose_SetOptions	Function Compose_SetOptions() As Long
Compose_SendMessage	Function Compose_SendMessage() As Long
GetMIMEDetails	Function GetMIMEDetails()
Compose_AddAttachment	Function Compose_AddAttachment(ByVal ContentType As String, ByVal FilePath As String, ByVal FileName As String, ByVal MIMEFileName As String, ByVal MIMEFileTitle As String) As Long
Compose_RemoveAttachment	Function Compose_RemoveAttachment(ByVal FileName As String) As Long
Compose_ClearAttachments	Function Compose_ClearAttachments() As Long
GetUniqueMessageID	Function GetUniqueMessageID() As String
GetQueueDirectory	Function GetQueueDirectory() As String
GetMailRoot	Function GetMailRoot() As String
CopyFile	Public Function CopyFile(SourceFile, DestinationFile) As Long
CopyForwardFile	Public Function CopyForwardFile(SourceFile, DestinationFile) As Long
GetMessageDetails	Public Sub GetMessageDetails()
GetHeaderToken	Function GetHeaderToken(ByVal HeaderLine As String) As String
EndOfHeader	Function EndOfHeader(FileLine) As Boolean
GetMessage	Public Function GetMessage()
ClearMessageDetails	Public Function ClearMessageDetails()
GetMessageSummary	Public Function GetMessageSummary()
DeleteMessage	Function DeleteMessage() As Long
GetNewMIMEBoundary	Public Function GetNewMIMEBoundary() As String
FormatStringAsHTML	Function FormatStringAsHTML(ByVal InString)
FormatHTMLAsString	Function FormatHTMLAsString(ByVal InString)
SendMessage	Public Function SendMessage() As Long
AddHeader	Function AddHeader(ByVal HeaderTag As String, HeaderItem As String) As Long
RemoveHeader	Function RemoveHeader(ByVal HeaderTag As String) As Long
MoveMessage	Function MoveMessage(ByVal RelativeTargetFolder) As Long
IsInvalidAddress	Function IsInvalidAddress(Address)
ResolveAddressList	Function ResolveAddressList(FrmMsgTo, ResolvedRecipients, UnResolvedRecipients)
ResolveRecipients	Public Function ResolveRecipients() As Long
FormatRecipientHeader	Function FormatRecipientHeader(FrmMsgTo)

MailMessages

This class allows you to manage the messages within a folder. This primary function in this class is the ListMessages function, which returns a recordset of the messages within a folder

Properties

Name	Type
Postoffice	String
UserName	String
Password	String
RelativeFolderPath	String
SortOrder	String
TopRecord	Long
RecordsPerPage	Long
NumRecords	Long

Methods

Method	Paramater Syntax
GetNewMessageCount	Function GetNewMessageCount() As Long
ConvertDate	Function ConvertDate(ByVal InDate As String)
ZeroPrefixString	Function ZeroPrefixString(ByVal InString As String, ByVal MaxLen As Long)
ListMessages	Function ListMessages()

Options

This class is used to get and set system options. Options are set and retreived by a user defined name.

Methods

Method	Paramater Syntax
GetOptionValue	Public Function GetOptionValue(ByVal OptionName As String, ByVal Account As String, ByVal User As String) As Long
GetOptionString	Public Function GetOptionString(ByVal OptionName As String, ByVal Account As String, ByVal User As String)
GetSystemOption	Public Function GetSystemOption(lScope As Variant, sQuery As Variant, sValueName As Variant)
SetSystemOption	Public Function SetSystemOption(lScope As Variant, sQuery As Variant, sValueName As Variant, sValue As Variant)

Features

This class is used to access specific features and settings associated with WebMail.

Methods

Method	Paramater Syntax
Enabled	Public Function Enabled(ByVal FeatureName As String, ByVal Account As String, ByVal User As String) As Boolean
AvailableSkins	Public Function AvailableSkins(ByVal Postoffice As String, ByVal Path As String) As String
GetAccountFeatureStatus	Public Function GetAccountFeatureStatus(sAccount As Variant, sFeatureName As Variant) As Boolean
GetSiteSkinName	Function GetSiteSkinName(SiteName)
GetDataElement	Function GetDataElement(Module, Key)
GetServiceStatus	Public Function GetServiceStatus(sAccount As Variant, sMailbox As Variant) As Long

FreeBusy

This function is used to access the free and busy times associated with a users calendar.

Properties

Name	Type
Mailbox	String
Postoffice	String
Period	String
Interval	Long
ItemData	String
ItemDataSize	Long
Sequence	Long

Methods

Method	Paramater Syntax
GetFreeBusyData	Function GetFreeBusyData() As Long