GetEmailQueue

Description

This class is an instantion of the Command class, that executes a command pertaining to fetching email queue item information, in the default case from the database. This class should only be instantiated by dispatchMBAPI() found in include/mbapi/mbapi.php. Remember when passing in an email body that it should have

Attributes

package
modernbill
subpackage
mbapi
version
0.1
author
Vic Fryzel
author
Andy Christ

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<emailID><!-- None --></emailID>
			<clientContactID><!-- None --></clientContactID>
			<adminID><!-- None --></adminID>
			<emailToAddressIDs>
				<emailAddressID><!-- None --></emailAddressID>
			</emailToAddressIDs>
			<emailToAddresses>
				<emailAddress><!-- None --></emailAddress>
			</emailToAddresses>
			<emailCCAddressIDs>
				<emailAddressID><!-- None --></emailAddressID>
			</emailCCAddressIDs>
			<emailCCAddresses>
				<emailAddress><!-- None --></emailAddress>
			</emailCCAddresses>
			<emailBCCAddressIDs>
				<emailAddressID><!-- None --></emailAddressID>
			</emailBCCAddressIDs>
			<emailBCCAddresses>
				<emailAddress><!-- None --></emailAddress>
			</emailBCCAddresses>
			<emailReplyToAddressIDs>
				<emailAddressID><!-- None --></emailAddressID>
			</emailReplyToAddressIDs>
			<emailReplyToAddresses>
				<emailAddress><!-- None --></emailAddress>
			</emailReplyToAddresses>
			<emailSubject><!-- None --></emailSubject>
			<emailBody><!-- None --></emailBody>
			<emailTextBody><!-- None --></emailTextBody>
			<emailFromAddress><!-- None --></emailFromAddress>
			<emailFromName><!-- None --></emailFromName>
			<emailAttachmentIDs>
				<emailAttachmentID><!-- None --></emailAttachmentID>
			</emailAttachmentIDs>
			<emailAttachments>
				<emailAttachmentPath><!-- None --></emailAttachmentPath>
			</emailAttachments>
			<emailHeaderIDs>
				<emailHeaderID><!-- None --></emailHeaderID>
			</emailHeaderIDs>
			<emailHeaders>
				<emailHeader><!-- None --></emailHeader>
			</emailHeaders>
			<emailSent><!-- None --></emailSent>
			<emailFailed><!-- None --></emailFailed>
			<emailActive><!-- None --></emailActive>
			<emailSentType><!-- None --></emailSentType>
			<emailDateCreatedLessThan><!-- None --></emailDateCreatedLessThan>
			<emailDateCreated><!-- None --></emailDateCreated>
			<emailDateCreatedGreaterThan><!-- None --></emailDateCreatedGreaterThan>
			<emailDateSentLessThan><!-- None --></emailDateSentLessThan>
			<emailDateSent><!-- None --></emailDateSent>
			<emailDateSentGreaterThan><!-- None --></emailDateSentGreaterThan>
			<sortDir><!-- None --></sortDir>
			<sortColumn><!-- None --></sortColumn>
			<recordOffset><!-- None --></recordOffset>
			<numRecords><!-- None --></numRecords>
		</params>
	</mbapi>

		

Example Response

None
		

Request Elements

mbapi
Type
None
Description
None
Children
command
Type
None
Description
None
showXMLHeader
Type
None
Description
None
params
Type
None
Description
None
Children
emailID
Type
None
Description
None
clientContactID
Type
None
Description
None
adminID
Type
None
Description
None
emailToAddressIDs
Type
None
Description
None
Children
emailAddressID
Type
None
Description
None
emailToAddresses
Type
None
Description
None
Children
emailAddress
Type
None
Description
None
emailCCAddressIDs
Type
None
Description
None
Children
emailAddressID
Type
None
Description
None
emailCCAddresses
Type
None
Description
None
Children
emailAddress
Type
None
Description
None
emailBCCAddressIDs
Type
None
Description
None
Children
emailAddressID
Type
None
Description
None
emailBCCAddresses
Type
None
Description
None
Children
emailAddress
Type
None
Description
None
emailReplyToAddressIDs
Type
None
Description
None
Children
emailAddressID
Type
None
Description
None
emailReplyToAddresses
Type
None
Description
None
Children
emailAddress
Type
None
Description
None
emailSubject
Type
None
Description
None
emailBody
Type
None
Description
None
emailTextBody
Type
None
Description
None
emailFromAddress
Type
None
Description
None
emailFromName
Type
None
Description
None
emailAttachmentIDs
Type
None
Description
None
Children
emailAttachmentID
Type
None
Description
None
emailAttachments
Type
None
Description
None
Children
emailAttachmentPath
Type
None
Description
None
emailHeaderIDs
Type
None
Description
None
Children
emailHeaderID
Type
None
Description
None
emailHeaders
Type
None
Description
None
Children
emailHeader
Type
None
Description
None
emailSent
Type
None
Description
None
emailFailed
Type
None
Description
None
emailActive
Type
None
Description
None
emailSentType
Type
None
Description
None
emailDateCreatedLessThan
Type
None
Description
None
emailDateCreated
Type
None
Description
None
emailDateCreatedGreaterThan
Type
None
Description
None
emailDateSentLessThan
Type
None
Description
None
emailDateSent
Type
None
Description
None
emailDateSentGreaterThan
Type
None
Description
None
sortDir
Type
None
Description
None
sortColumn
Type
None
Description
None
recordOffset
Type
None
Description
None
numRecords
Type
None
Description
None

Response Elements

None