MCM4XB Reference Manual - MarshallSoft Computing
Contents
1. 204 Body of email is missing 205 Cannot open MCM bin file 206 Cannot read MCM bin file 207 Invalid bin file format 208 Corrupted bin file xceeded in evaluation version 210 Max recipient list siz 21 Cannot allocate memory for letter buffers 21 TCP TP running on Ethernet 21 Path to MCM directory cannot be null i 2 4 215 Must specify path to MCM 6 No such macro 7 8 219 No such parameter 220 No such header 221 Unknown CharSet 222 Buffer too small directory aximum skip files exceeded aximum reply files exceeded 223 No channels allocated by mcmAttach 224 All channels have been disabled 225 Evaluation version expired 226 String too long Expect lt 256 227 String too long Expect lt 1000 228 Bad email address Expect lt name domain gt 229 Not authorized to use this version of MCM32 DLL 302 IstInit not called 303 Cannot open list file 304 No such string 305 Bad delimiter Expecting 306 Cannot determine delimit 307 Cannot determine delimit commas or tabs r on macro line 308 Delimiter character must r on entry line match delimiter on macro line 309 Number delimters must match number on macro line 310 List buffer is too small 311 Missing entry in recipient list 312 Recipient list string is 351 Cannot start SMTP thread 352 Maximum allowed channels 353 No channels specified2. too long exceeded 354 mcmSmtpClose already called 355 Not connected to servers 401 End of Fil letter 402 ltrInit not called 403 Cannot open letter fil 404 Cannot allocate memory for raw letter 37 405 406 408 409 410 411 412 413 414 415 451 452 453 454 455 ab 502 5 03 3 504 505 506s 507 541 542 543 544 602 701 702 703 704 105 s 801 802 803 902 903 951 95 2 9535 954 95 57 Letter file not opened acro not closed acro too big Illegal character inside macro acro not closed befor nd of lin solated macro definition character percent sign rror reading letter file acro cannot contain space characters acro not found Unknown file extension Expecting htm txt or rtf emory mutex operation failed Timed out waiting for memory mutex No such buffer exists bufInit not called Timed out waiting for free buffer Letter has not been loaded Macro not found in list macro line No such field in on list entry line Buffer overflow String table key too large max 40 chars String table replacement text too large max 256 chars String table overflow Supermacro not closed Illegal character in supermacro Supermacro too big Supermaccro table lookup fails logInit not called Max files exceeded Cannot allocate memory No such file No such file
3. 0 Error see Section 3 0 MCM Error List gt 0 No error EXAMPLE CODE SMTP_Server mail hiwaay net SMTP_User Chr 0 SMTP_Pass Chr 0 SMTP_From Chr 0 SMTP_Port 587 connect to SMTP server on port 587 Code XmcmSmtpConnect SMTP_Server SMTP_Port SMTP_User SMTP_Pass SMTP_From 0 0 EXAMPLE PROGRAMS SendMail 33 2 29 XmemStatistics Get runtime statistics SYNTAX Code XmcmStatistics ParmName ParamName Parameter number REMARKS The XmemStatistics function returns the runtime statistic corresponding to ParamName MCM_STAT_ TOTAL RECIPIENTS Total number of recipients MCM STAT BRACKETED ADDRESSES Number of bracketed addresses MCM STAT INVALID ADDRESSES Number of invalid addresses MCM STAT DUPLICATE ADDRESSES Number of duplicate addresses MCM_STAT WITH BAD ATTACHMENT Number of bad attachments MCM STAT SKIPPED ADDRESSES Number of skipped addresses MCM_ STAT WITH _UNKNOWN_CHARSETS Number of unknown char sets MCM_STAT AVG _SEND_TIME The average time milliseconds to send each email MCM STAT AVG CONNECT TIME The average time milliseconds to connect to the server RETURNS The selected runtime statistic EXAMPLE CODE DupAddresses XmcmStatistics MCM_STAT_DUPLICATE_ADDRESSES Str DupAddresses duplicate addresses seen EXAMPLE PROGRAMS SendMail ALSO SEE XmcemGetIntetger and XmcmGetlInterger2 34 2 30 mcemUtility MCM Utility
4. Server STRING POP3 server name or IP address Port INTEGER POP3 port normally 110 User STRING POP3 user name Pass STRING POP3 password REMARKS The XmcmPop3Connect function connects to the specified POP3 server for the purpose of 1 reading replies from servers reporting than email was undeliverable and 2 reading replies from recipients Once connected the number of messages in the POP3 account is returned Note XmcmPop3Connect and XmcmSmtpConnect should not be called in the same program RETURNS lt 0 Error see Section 3 0 MCM Error List 0 No messages on the server gt 0 The number of messages on the server EXAMPLE CODE connect to POP3 server POP3_Server mail hiwaay net POP3_User username POP3_Pass secret POP3_ Port 110 Code XmcmPop3Connect POP3_Server POP3_Port POP3_User POP3_Pass EXAMPLE PROGRAMS GetReply ALSO SEE XmcemPop3Close 24 2 20 XmcmReadReply Read next email from POP3 server SYNTAX Code XmcmReadReply SubjBuf SubjLen Flags SubjBuf STRING Reply buffer SubjLen INTEGER Size of buffer Flags INTEGER Delete flags REMARKS The XmcmReadReply function reads the next email from the POP3 server copying the subject to the UserBuf buffer The email read is classified as one of three types 1 Email from servers indicating that the email was undeliverable 2 Email from recipients who have responded to one of the
5. Function SYNTAX memUtility ParamName ParamString ParamName Parameter name ParamString Parameter string REMARKS The memUtility function can only be called before calling any other MCM functions ParamName ParamString Returns MCM_GET_FILE_LINE_COUNT File name lines in file RETURNS See above EXAMPLE CODE Lines mcemUtility MCM_GET_FILE_LINE_COUNT ListFile EXAMPLE PROGRAMS SendMail prg 35 2 31 XmcmWriteToLog Write to log file SYNTAX Code XmcmWriteToLog Text String STRING Text to write to the log file REMARKS The XmcemWriteToLog function writes the specified string to the MCM log file Note that XmemWriteToLog cannot be called until after XmemAttach is called RETURNS The length of the passed string EXAMPLE CODE Dim Text Text SendMail Example Program XmemWriteToLog Text EXAMPLE PROGRAMS SendMail and GetReply 36 3 0 MCM Error List The numerical list of MCM errors follows 1 End of Fil list 101 Cannot set SMTP port 102 Cannot connect to SMTP server 103 Invalid key code 104 Send mail fails 105 Cannot set SMTP user name 106 Cannot set SMTP password 107 Invalid email address 141 Cannot set POP3 port 142 Cannot connect to POP3 server 171 Too many reply files 201 Not authorized internal rror 202 First line of letter must start with To 203 Second line of letter must start with Subject
6. Lacy Marshall Although the comma is used in the above example as the delimiter character the semicolon tab carrot or tilde could be used instead Rewind the recipient list file by passing a NULL or empty string for ListPathName This allows a second pass through the list to send email when a first pass was a merge only pass RETURNS lt 0 Error see Section 3 0 MCM Error List gt 0 List file successfully opened EXAMPLE CODE ListFile c mcm4xb apps list txt Code XmcmOpenList ListFile EXAMPLE PROGRAMS SendMail ALSO SEE XmecmOpenLetter 20 2 16 XmcmOpenReply Open reply file for processing SYNTAX Code XmcmOpenReply RemoveFile RemoveString RemoveFile STRING Pathname of reply file RemoveString STRING Reply string REMARKS The XmcmOpenReply function opens a reply file that is associated with the specified subject string When reading client replies to previously sent email if the subject begins with the specified string as for example REMOVE m marshall0610 yahoo com then the email address following the string REMOVE in the example above is written to the reply file More than one reply file can be opened RETURNS lt 0 Error see Section 3 0 MCM Error List gt 0 No error EXAMPLE CODE RemoveFile c mcm4xb apps remove txt RemoveString REMOVE open file for replies on subject line REMOVE email address Code XmcmOpenReply Remove
7. also be found online on the MarshallSoft Client Mailer for Xbase product page http www marshallsoft com mcem4xb htm 2 0 MCM Functions All MCM functions are declared in file MCM32 CH 2 1 XmecmAttach Initialize MarshallSoft Client Mailer SYNTAX Code XmcmAttach KeyCode EditionCode ChansWanted DebugLevel PathToMCM KeyCode MCM key code identifies purchaser EditionCode MCM edition code no longer used ChansWanted Maximum channels requested DebugLevel Debug level 0 OFF 1 LOW 2 HIGH PathToMCM Pathname of files folder REMARKS The XmemAttach function initializes the Client Mailer DLL MCM32 DLL passing the initialization parameters 1 KeyCode 0 for the evaluation version 2 Edition Code pass 0 3 the maximum number of channels to use when sending email and 4 the debug level 0 for no debug for low and 2 for high and 5 PathToMCM the pathname of the log file folder A keycode file keycode ch containing the customer s keycode is included when MCM4XB is purchased XmemAttach must be the first MarshallSoft Client Mailer MCM function called excepting mcmUtility RETURNS Evaluation days remaining in the evaluation trial period Purchased 999 EXAMPLE CODE KeyCode 0 EditionCode 0 Chans Wanted 24 PathToMCM c mcm4xb apps Code XmcmAttach KeyCode EditionCode Chanswanted MCM_DEBUG_OFF PathToMCM EXAMPLE PROGRAMS TestMCM SendMail and Get
8. index String not found No space remaining in file table No such file bad file table entry File not open Cannot allocate memory Slot table overflow CM aborted Bad key code Evaluation version expired Bad edition code ust call mcmAttach first DI H 38
9. of last email sent into Butter MCM_GET_RECIPIENT Copies email address of last recipient RETURNS The number of characters copied EXAMPLE CODE Work Space 4096 Code XmcmGetString MCM_GET_LETTER Work 4095 if Code gt 0 EXAMPLE PROGRAMS SendMail and GetReply ALSO SEE XmemGetString2 XmcmGetInteger and XmcmGetInteger2 12 2 8 XmcemGetString2 Gets string parameter for MCM processing SYNTAX Code XmcmGetString2 ParmName Selection Buffer BufSize ParmName INTEGER Parameter number Selection INTEGER Selection index 1 2 Buffer STRING String buffer BufSize INTEGER Size of buffer REMARKS The memGetString2 function returns a string which contents depends on the value of the passed parameter ParamName as follows Note that MCM reads only the headers of incoming email MCM_GET_BOUNCE_STRING Copies the selected bounce string into Butter The bounce string must have been previously set by mcmSetString MCM_ADD_BOUNCE_STRING String Bounce strings are numbered 1 2 RETURNS The number of characters copied EXAMPLE CODE Work Space 256 Code XmcmGet String MCM_GET_BOUNCE_STRING 1 Work 255 if Code gt 0 EXAMPLE PROGRAMS GetReply ALSO SEE XmemGetString XmcmGetInteger and XmcmGetInteger2 13 2 9 XmcmLoadString Load substitution string SYNTAX Code XmcmLoadString StringKey StringText StringKey STRING String key StringText S
10. ET_BCC_ADDRESS Sets the BCC address string for all outgoing email Addresses must be enclosed in lt and gt brackets as in lt someone comcast net gt RETURNS lt 0 Error see Section 3 0 MCM Error List gt 0 Length of parameter string no error EXAMPLE CODE FromAddr m marshall0610 yahoo com set From address Code XmcmSetString MCM_SET_FROM_ADDRESS FromAddr EXAMPLE PROGRAMS None 30 2 26 XmcmSleep Sleeps specified milliseconds SYNTAX Code XmcmSleep MilliSecs MilliSecs INTEGER Milliseconds to sleep REMARKS The XmcmSleep function sleeps the number of specified milliseconds This function is the same as the Windows API Sleep function RETURNS MilliSecs EXAMPLE CODE sleep 3 seconds Code XmcmSleep 3000 EXAMPLE PROGRAMS SendMail and GetReply 31 2 27 XmcmSmtpClose Close SMTP server connection SYNTAX Code XmcmSmtpClose REMARKS The XmcmSmtpClose function closes all SMTP channels and will not return until all channels are closed Before calling XmcmSmtpClose the Code XmcmGetInteger MCM_GET_CHANNEL_STATUS should be called repeatedly until it returns 0 indicating that all channels have finished sending See the SendMail example program RETURNS lt 0 Error see Section 3 0 MCM Error List gt 0 No error EXAMPLE CODE close all connections to SMTP server XmcemSmtpClose EXAMPLE PROGRAMS SendMail ALSO SEE XmcemPop3Clo
11. File RemoveString EXAMPLE PROGRAMS GetReply ALSO SEE XmemOpenSkip and XmcmOpenBounce 21 2 17 XmcmOpenSkip Open skip file for processing SYNTAX Code XmcmOpenSkip SkipPathName SkipPathName STRING Pathname of skip file REMARKS The XmcmOpenSkip function opens a file containing email addresses of recipients to which email should not be sent even if the email address appears in the list of recipients Typically skip files are either a list of email addresses that were previously not deliverable or addresses of recipients who replied to previously sent email with one of the string specified in XmemOpenReply More than one skip file can be opened RETURNS lt 0 Error see Section 3 0 MCM Error List gt 0 No error EXAMPLE CODE BounceFile c mcm4xb apps bounce txt Open file containing addresses of undeliverable email Code XmcmOpenSkip BounceFile EXAMPLE PROGRAMS SendMail ALSO SEE XmcemOpenReply and XmcmOpenBounce 22 2 18 XmcmPop3Close Close POP3 connection SYNTAX Code XmcmPop3Close REMARKS The XmcmPop3Close program closes the connection to the POP3 server RETURNS lt 0 Error see Section 3 0 MCM Error List gt 0 No error EXAMPLE CODE close POP3 connection XmcmPop3Close EXAMPLE PROGRAMS GetReply ALSO SEE XmemPop3Connect 23 2 19 XmcmPop3Connect Connect to POP3 server SYNTAX Code XmcmPop3Connect Server Port User Pass
12. MarshallSoft Client Mailer Library for Xbase Reference Manual MCM4XB Version 5 0 October 28 2014 This software is provided as is There are no warranties expressed or implied Copyright C 2014 All rights reserved MarshallSoft Computing Inc Post Office Box 4543 Huntsville AL 35815 Email info marshallsoft com Web www marshallsoft com MARSHALLSOFT is a registered trademark of MarshallSoft Computing TABLE OF CONTENTS 1 Introduct ion 1 1 General Remarks 1 2 MCM Files 1 3 Documentation Set 2 Library Overview 2 1 mem 2 2 mem 2 3 mem 2 4 mem 2 5 mem 2 6 mem 2 7 mem 2 8 mem 2 9 mem 2 10 mcm 2 11 mem 2 12 mcm 2 13 mcm 2 14 mcm 2 15 mem 2 16 mcm 2 17 mem 2 18 mcm 2 19 mcm 2 20 mcm 2 21 mcm 2 22 mcm 2 23 mcm 2 24 mcm 2 25 mcm 2 26 mcm 2 27 mem 2 28 mcm 2 29 mcm 2 30 mcm 2 31 mcm 3 MCM Error Attach GetError GetInteger GetInteger2 GetLetterMacro GetListMacro GetString GetString2 LoadString MergeNext MergeText OpenBounce OpenHeader OpenLetter OpenList OpenReply OpenSkip Pop3Close Pop3Connect ReadReply Release SendMail SetInteger SetProxyssL SetString Sleep SmtpClose SmtpConnect Statistics Utility WriteToLog List Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Pag
13. P or POP3 server that requires SSL For details on using Stunnel see the section Using Stunnel online in the MCM User s Manual or http www marshallsoft com stunnel htm Set ProxyFlags 1 ifan icon is to be placed on the task bar Set ProxyDir to the path used to write the Stunnel configuration and log files Set ProxyCert to the filename or pathname of the X509 certificate in PEM format Set ProxyExe to the proxy executable filename or pathname Set ProxyPort to the proxy to be used to communicate with the proxy server or 0 to disable the proxy server Any unused port can be specified RETURNS lt 0 Error see Section 3 0 MCM Error List gt 0 No error EXAMPLE CODE ProxyDir c mcem4xb ssl ProxyCert c mcm4xb ssl stunnel pem ProxyExe c mcem4xb ssl stunnel exe Code XmcmSetProxySSL 0 1 ProxyDir ProxyCert ProxyExe 8801 EXAMPLE PROGRAMS SendMail 29 2 25 XmcmSetString Sets string for MCM processing SYNTAX Code XmcmSetString ParamName ParamString ParamName INTEGER Parameter number ParamString STRING Parameter string REMARKS The XmemSetString function sets a string parameter MCN SET FROM ADDRESS Sets the From address on subsequent outgoing email initially set by XmcmSmtpConnect MCM_SET_CC_ADDRESS Sets the CC address string for all outgoing email Addresses must be enclosed in lt and gt brackets as in lt someone comcast net gt MCM_S
14. Reply 2 2 XmcemGetError Get text associated with error code SYNTAX Code XmcmGetError ErrCode Buffer BufLen ErrCode INTEGER Error code Buffer STRING Error text buffer BufLen INTEGER Size of buffer REMARKS The XmcmGetError function is used to copy the error text associated with the error code ErrCode returned by a MCM function to the buffer where it can be displayed by the calling program code The size of the buffer should be 256 bytes RETURNS Return 0 No such error Return lt 0 The number of bytes copied into the buffer EXAMPLE CODE Buffer Space 256 if ErrCode lt 0 get MCM error message Code XmcmGetError ErrCode Buffer 255 EXAMPLE PROGRAMS SendMail and GetReply 2 3 XmcmGetInteger Gets MCM processing information SYNTAX Code XmcmGet Integer ParmName ParmName INTEGER Parameter number REMARKS The XmcmGetInteger function returns an integer whose value depends on the value of the passed parameter ParamName as follows RETURNS MCM_GET_VERSION The version of MCM in packed hexadecimal format X Y Z MCM_GET_VERSION_1ST_PART The first digit of the version of MCM MCM_GET_VERSION_2ND_PART The second digit of the version of MCM MCM_GET_VERSION_3RD_PART The third digit of the version of MCM MCM_GET_ BUILD The build number of MCM MCM_GET_LETTER_LINE_NBR The current letter line just processed MCM_GET_LETTER_CHAR_POS The current character positio
15. TRING String text REMARKS The XmcemLoadString loads the substitution string for advanced macros Advanced macros are not currently implemented in MCM RETURNS lt 0 Error see Section 3 0 MCM Error List gt 0 No error EXAMPLE CODE none EXAMPLE PROGRAMS none 14 2 10 XmcmMergeNext Merge next recipient for sending SYNTAX Code XmcmMergeNext REMARKS The XmcmMergeNext function merges the next recipient from the recipient list with the loaded letter in preparation for sending See the XmcemMergeText function for a list of the merge codes XmcemMergeNext is called by the application code that sends the email such as the SendMail example program RETURNS lt 1 Error see Section 3 0 MCM Error List 1 End of file MCM_EOF 0 OK to send gt 0 Don t send see XmcmMergeText EXAMPLE CODE send letter to each recipient for I 1 To 1000 merge letter with next recipient MergeCode XmcmMergeNext EXAMPLE PROGRAMS GetReply ALSO SEE XmcmMergeText 15 2 11 XmcmMergeText Get text for associated merge code SYNTAX Code XmcmMergeText MergeCode Buffer BufSize MergeCode INTEGER Merge code Buffer STRING String buffer BufSize INTEGER Size of buffer REMARKS The XmcmMergeText function copies the merge code text corresponding with the numerical MergeCode to Buffer so that it can be displayed by the calling application program Recall tha
16. ated by calling XmcmMergeNext RETURNS lt 0 Error see Section 3 0 MCM Error List gt 0 No error EXAMPLE CODE send letter to recipient Code XmcmSendMail EXAMPLE PROGRAMS SendMail 27 2 23 XmcmSetInteger Sets numeric parameter for MCM processing SYNTAX Code XmcmSetInteger ParamName ParamValue ParamName INTEGER Parameter number ParamValue INTEGER Parameter value REMARKS The XmcmSetInteger functions sets the specified integer parameter MCM_ALLOW_EMPTY_FIELDS Allows 1 or disallows 0 empty fields in the list of recipients with the exception of the first field which is reserved for the recipient s email address since an email address must always be present The default is 0 empty fields not allowed MCM_SET_DEBUG_LEVEL Changes the diagnostic debug level initially set by memAttach to MCM_DEBUG_OFF MCM_DEBUG_LOW or MCM_DEBUG_HIGH MCM_SET_DUPLICATE_DETECT Enables 1 or disables 0 detection of duplicate email addresses in the recipient list Does not affect operation of skip exclusion lists The default is enabled 1 MCM_ SET CHANNEL DIVISOR Sets the channel divisor D default 4 such that the number of channels N used is reduced so that ON lt L D where L the number of lines in the recipient list In order to take affect at runtime mcmOpenList must be called before memOpenLetter MCM_SET_MACRO_DELIMITER Specifies the macro substitution delimiter in the l
17. e w w OADM UW OO JO DG GA b i CH WBWWWWWWWNHNNNNNNNNDND YUDOBPWNFPOUO DANA L b t OO vo 1 Introduction The MarshallSoft Client Mailer for Xbase provides the capability to send personalized email to your clients or customers directly from your Xbase application program The MarshallSoft Client Mailer for Xbase Reference Manual contains details on each individual MCM function The most current version of the MarshallSoft Client Mailer for Xbase can be found at http www marshallsoft com mcm4xb htm 1 1 General Remarks This is the Xbase version of the MarshallSoft Client Mailer MCM Other versions are for C C Delphi Visual Basic Visual dBase and Visual FoxPro All versions employ the identical MCM32 DLL differing only in documentation and example programs All MarshallSoft Client Mailer MCM functions return an integer code Negative values are always errors Refer to Section 3 0 below MCM Error Return Code List The file XmcmErrors txt contains a list of all error codes and their corresponding numerical value Non negative return codes are never errors Note that the XmcemErrorText function is used to get the text message associated with any error code 1 2 MCM Files Xbase e mem32 ch MCM function declaration amp constants file e mem32 dl1l1 32 bit MarshallSoft Client Mailer DLL e prg Xbase example programs 1 3 Documentation Set There are five manuals in Adobe PDF format fo
18. e letter associated with the macro number 1 2 3 Macros may be up to 40 characters in length The first macro in a letter is 1 the second is 2 etc For example consider the letter as shown in section 2 12 XmcmOpenLetter The first macro in the letter is EmailAddress the second is Fullname etc RETURNS Return gt 0 The line number in the letter on which macro appears Return lt 0 The error code MCM_NO_SUCH_MACRO EXAMPLE CODE get macro string i 1 2 3 Buffer Space 256 Code XmcmGetLetterMacro i Buffer 255 if Code gt 0 find line in letter on which macro i occurs Code XmcmGetInteger2 MCM_GET_LETTER_MACRO_LINE i 2 Macro Buffer defined on line Str Code EXAMPLE PROGRAMS none ALSO SEE XmcemGetListMacro 10 2 6 XmcmGetListMacro Get Macro Substitution String in Recipient List SYNTAX Code XmcmGetListMacro ListNumber Buffer BufSize MacroNumber INTEGER Macro number 1 2 Buffer STRING Macro buffer BufSize INTEGER Size of buffer REMARKS The XmcemGetListMacro returns the macro substitution string in the recipient list associated with the macro number 1 2 3 Macros may be up to 40 characters in length and are defined on the first line of the list For example consider the recipient list as shown in section 2 13 XmcemOpenList There are three macros always appearing on the first line in the list The firs
19. etter to be sent Choose percent blackslash or backquote the default MCM_AUTO_LOAD HEADER _FILE Sets a flag so that the header file will be automatically loaded when memOpenLetter is called provided that the header file has the same name as the letter file except for extension hdr rather than txt or htm Avoid having to call memOpenHeader MCM_SET_SMTP_PROTOCOL Sets the SMTP protocol to ParamValue which should be one of SMTP_AUTHENTICATE CRAM SMTP_AUTHENTICATE LOGIN or SMTP_AUTHENTICATE_PLAIN Required by some SMTP servers See MCM4C SSL SSL_SERVERS TXT RETURNS lt 0 Error see Section 3 0 MCM Error List gt 0 Parameter value set no error EXAMPLE CODE set debug level to MCM_DEBUG_LOW Code XmcmSetInteger MCM_SET_DEBUG_LEVEL MCM_DEBUG_LOW EXAMPLE PROGRAMS None 28 2 24 XmcmSetProxySSL Set SSL Proxy Parameters SYNTAX FUNCTION XmcmSetProxySSL nProxyCode nProxyFlags cProxyDir cProxyCert cProxyExe nProxyPort nProxyCode proxy code reserved set to 0 nProxyFlags proxy server flags l icon on taskbar cProxyDir proxy directory on this machine cProxyCert proxy certificate STUNNEL PEM file or path cProxyExe proxy executable STUNNEL EXE file or path nProxyPort proxy port REMARKS The memSetProxySSL program sets parameters for the proxy server Stunnel and must be called before connecting to any SMT
20. n on the current letter line MCM_GET_LETTER_MACROS The number of macros substitution strings found in the letter MCM_GET_LIST_LINE_NBR The current list line just processed MCM_GET_MAX LIST_SIZE The maximum number of entries allowed in the list of recipients MCM_GET_MAX_ CHANNELS The number of channels being used to send email MCM_GET_CUSTOMER_ID The customer ID MCM_GET ALLOWED CHANNELS The maximum allowed number of channels MCM_GET_ ALLOWED LIST SIZE The maximum allowed list size MCM_GET_ALLOWED_SKIP_FILES The maximum allowed number o skip files MCM_GET_ALLOWED_REPLY_FILES The maximum number of reply files MCM_GET_EDITION The MCM edition no longer used MCM_GET_REGISTRATION The customer registration string MCM_GET_CHANNEL_STATUS The current channel status where each bit represents one channel MCM_GET_EMAIL QUEUED_COUNT The number of emails queued to be sent MCM_GET_EMAIL SENT_COUNT The number of emails successfully sent MCM_GET_EMAIL ERROR_COUNT The number of emails queued but not sent due to errors MCM_GET_LIST_LINES The number of lines in the list file MCM_GET_ LETTER LINES The number of lines in the letter file MCM_GET_SKIP_LINES The number of lines in last skip file loaded MCM_GET_LIST_MACRO_COUNT The number of macros substitution strings in the recipient list MCM_GET_LIST_DELIMITER The macro substitution string delimiter This will be either the comma semic
21. olon tab carrot or tilde MCM_GET_LIST_ERROR_STRING The line number of last error in the recipient list MCM_GET_SKIP_FILE_LIMIT The maximum number of skip files allowed MCM_GET_REPLY_FILE_LIMIT The maximum number of reply files allowed EXAMPLE CODE Customer ID is Str XmcmGet Integer MCM_GET_CUSTOMER_ID EXAMPLE PROGRAM SendMail 2 4 XmcmGetInteger2 Get information for macro processing SYNTAX Code XmcmGetInteger2 ParmName Selected ParmName INTEGER Parameter number Select INTEGER Selection number for ParamName REMARKS The XmcmGetInteger2 function returns an integer value corresponding to the passed parameters ParmName and Select RETURNS MCM_GET_LETTER_MACRO LINE Get the line on which the Select macro appears EXAMPLE CODE get macro string i 1 2 3 Buffer Space 256 Code XmcmGetLetterMacro i Buffer 255 if Code gt 0 find line in letter on which macro i occurs Code XmcmGetInteger2 MCM_GET_LETTER_MACRO_LINE i 2 Macro Buffer defined on line Str Code EXAMPLE PROGRAMS none 2 5 XmcmGetLetterMacro Get Macro Substitution String in Letter SYNTAX Code XmcmGetLetterMacro MacroNumber Buffer BufSize MacroNumber INTEGER Macro number 1 2 Buffer STRING Macro buffer BufSize INTEGER Size of buffer REMARKS The XmcemGetLetterMacro returns the macro substitution string in th
22. previous specified reply strings 3 All other email DeleteFlags specify if the email of the type specified in the above paragraph is to be deleted MCM_DELETE_BOUNCED 2 MCM_DELETE_MATCHED 2 MCM_DELETE_OTHER 4 The above Delete Codes can be added together to expand the messages deleted For example to specify that only type 1 bounced and type 2 recognized replied to emails are to be deleted but not others set Flags to 3 Hence Flag 3 will delete failure bounced email and recognized matched replies but keep all other messages If no messages are to be deleted use Flags 0 RETURNS lt 0 Error see Section 3 0 MCM Error List 0 No reply string matches gt 0 Matched reply string 1 to 24 999 Email was undeliverable EXAMPLE CODE DeleteCode MCM_DELETE_BOUNCED MCM_DELETE_MATCHED SubjectBuffer Space 256 Code XmcmReadReply SubjectBuffer 255 DeleteCode EXAMPLE PROGRAMS GetReply ALSO SEE 25 2 21 XmcmRelease Close down MCM SYNTAX Code XmcmRelease REMARKS The XmcmRelease function closes down all MarshallSoft Client Mailer MCM processing and should be the last MCM function called RETURNS lt 0 Error see Section 3 0 MCM Error List gt 0 No error EXAMPLE CODE XmcmRe lease EXAMPLE PROGRAMS SendMail and GetReply 26 2 22 XmcmSendMail Sends merged mail SYNTAX Code XmcmSendMail REMARKS The XmcmSendMail function sends the email cre
23. r the MarshallSoft Client Mailer e Tutorial Manual Introduces the basic functionality and overview of the MarshallSoft Client Mailer e Servers Manual Covers background information on SMTP amp POP3 servers e User Manual Covers information that is not programming language specific letter amp list preparation program logic purchasing performance SSL etc e Reference Manual Contains details for each individual MCM function specific for each programming language Xbase Visual FoxPro Delphi C C VB etc e Programmer Manual Contains programming language Xbase Visual FoxPro Delphi C C etc specific information such as compiling and running example programs The manuals can be found in the DOCS subdirectory folder in the MarshallSoft Client Mailer file structure when it is installed Note that for clarity purposes some information may have been provided in more than one manual e Tutorial Manual mcm_tutorial pdf or online at http www marshallsoft com mcm_tutorial pdf e Servers Manual mem_servers pdf or online at http www marshallsoft com mcm_servers pdf e User Manual mcm_users pdf or online at http www marshallsoft com mcm_users pdf e Reference Manuals mcm4xb_reference pdf or online at http www marshallsoft com mcm4xb_reference pdf e Programmer Manuals mcm4xb_programmer pdf or online at http www marshallsoft com mcm4xb_programmer pdf Links to the above manuals can
24. se 32 2 28 XmcmSmtpConnect Connect to SMTP server SYNTAX Code XmcmSmtpConnect Server Port User Pass From ReOpen Delay Server STRING SMTP server name of IP address Port INTEGER SMTP port normally 25 or 587 User STRING SMTP user name SMTP Authentication only Pass STRING SMTP password SMTP Authentication only From STRING Email address of sender ReOpen INTEGER Number of emails before closing amp reopening Delay INTEGER Number of seconds to delay before reopening connection REMARKS The XmcmSmtpConnect function connects to the specified SMTP server using the number of channels authorized by the MCM license but not more than the maximum that was passed to the XmemAttach function The well known port for SMTP is 25 However some servers require that port 587 be used reserving port 25 only for other known SMTP servers If the SMTP server requires SMTP Authentication the user and password must be specified Otherwise pass the empty string Chr 0 The ReOpen value specifies the number of emails sent by each channel before closing and reopening the connection and is normally used with servers that set a maximum number of emails that can be sent Pass 0 to disable the ReOpen feature The Delay value is the number of seconds to delay after closing the connection ReOpen gt 0 was specified before reopening it Pass 0 to specify no delay RETURNS lt
25. t if the value returned by the XmcemMergeNext function called the merge code is positive then email should not be sent to this particular recipient The numerical values of the merge codes are listed in Xmem h and include MCM MERGE INVALID ADDRESS Invalid email address MCM_MERGE_DUPLICATE_ADDRESS Duplicate email address MCM MERGE BRACKETS NOT ALLOWED lt and gt not allowed in email address MCM_MERGE_CANNOT_OPEN_ATTACH Cannot open attachment MCM MERGE UNKNOWN_CHARSET Unknown character set MCM_MERGE_EMTY_ MACRO STRING Empty macro string found in recipient list In addition merge codes between 1 and 24 indicate that the email address was found in a skip exclusion list MergeCode 1 Email address was found in skip list 1 MergeCode 24 Email address was found in skip list 24 XmcemMergeText is called by the application code that sends the email such as the SendMail example program RETURNS Number of characters copied to Buffer EXAMPLE CODE Buffer Space 256 if MergeCode gt 0 Code XmcmMergeText MergeCode Buffer 255 Buffer EXAMPLE PROGRAMS GetReply ALSO SEE XmcemMergeNext and XmcmOpenSkip 16 2 12 XmcmOpenBounce Open bounce file for processing SYNTAX Code XmcmOpenBounce PathName PathName STRING Pathname of bounce file REMARKS The XmcmOpenBounce opens the bounce file into which are written when checking for client replies the email addresses that have been re
26. t macro is EmailAddress the second is AppointmentTime and the third is Fullname XmemGetListMacro is called by the application code that sends the email such as the SendMail example program RETURNS Return gt 0 The macro index Return lt 0 The error code MCM_NO_SUCH_MACRO EXAMPLE CODE get list macro i 1 2 3 Buffer Space 256 Code XmcmGetListMacro i Buffer 255 if Code gt 0 Macro Buffer EXAMPLE PROGRAMS none ALSO SEE XmcemGetLetterMacro 11 2 7 XmcmGetString Gets string parameter for MCM processing SYNTAX Code XmcmGetString ParmName Buffer BufSize ParmName INTEGER Parameter number Buffer STRING String buffer BufSize INTEGER Size of buffer REMARKS The XmcemGetString function returns a string which contents depends on the value of the passed parameter ParmName as follows Note that MCM reads only the headers of incoming email MCM_GET_VERSION Copies the MCM version string into Buffer MCM_GET_LETTER Copies the entire letter into Buffer Requires SMTP connection MCM_GET_SUBJECT Copies the letter subject into Buffer Requires SMTP connection MCM_GET_BODY Copies the body of the letter into Buffer Requires SMTP connection MCM_GET_FROM Copies the From address into Buffer Requires SMTP connection MCM_GET_TIME_STAMP Copies the current date amp time string into Buffer MCM_GET_LAST EMAIL SENT Copies address
27. turned as undeliverable bounced This file is created when reading replies see the GetReply prg example program after previously sending email see the SendMail prg example program and can be used as one of the skip files the next time email is sent XmemOpenBouncee is called by the application code that reads replies to previously sent email such as the GetReply example program RETURNS lt 0 Error see Section 3 0 MCM Error List gt 0 Bounce file successfully opened EXAMPLE CODE BounceFile c mcm4xb apps bounce txt Code XmcmOpenBounce BounceFile EXAMPLE PROGRAMS GetReply ALSO SEE XmemOpenSkip 17 2 13 XmcmOpenHeader Open header file for processing SYNTAX Code XmcmOpenHeader HeaderName HeaderName STRING Filename of letter header fil REMARKS The XmcmOpenHeader file opens the letter header file and scans for macros An example of a header file is To EmailAddress Subject Your Dental Appointment Required headers are To Email recipient Subject Email subject Optional header lines are CharSet Character set CC Carbon copy recipients BCC Blind carbon copy recipients Attach List of attachments Header User specified SMTP header Refer to the MCM User s manual mcm_users pdf for details of all headers RETURNS lt 0 Error see Section 3 0 MCM Error List gt 0 Letter file successfully opened EXAMPLE CODE HeaderFile c mcm4xb apps header
28. txt Code XmcmOpenHeader HeaderFile EXAMPLE PROGRAMS SendMail ALSO SEE XmemOpenLetter 18 2 14 XmcmOpenLetter Open letter file for processing SYNTAX Code XmcmOpenLetter LetterName LetterName STRING Filename of letter fil REMARKS The XmcmOpenLetter file opens the text or HTML letter file and scans the letter for macros An example of a letter is Dear FullNameZ Your dental appointment is tomorrow at AppointmentTimes Sincerely Dr John H Holliday PS If you prefer that email notices not be sent reply to this email with subject REMOVE EmailAddress XmemOpenLetter is called by the application code that sends the email such as the SendMail example program RETURNS lt 0 Error see Section 3 0 MCM Error List gt 0 Letter file successfully opened EXAMPLE CODE LetterFile c mcm4xb apps letter txt Code XmcmOpenLetter LetterFile EXAMPLE PROGRAMS SendMail ALSO SEE XmcmOpenHeader 19 2 15 XmcmOpenList Open recipient list file for processing SYNTAX XmcmOpenList ListPathName ListPathName STRING Pathname of recipient list file REMARKS The XmcmOpenList file opens the recipient list file the first line of which contains the macro substitution string For example EmailAddress AppointmentTime FullName m marshall0610 yahoo com 10 00 am Mike Marshall p marshall0610 yahoo com Noon Paula Marshall l marshall0610 yahoo com 2 30 pm
Download Pdf Manuals
Related Search