MCM4FP Reference Manual - MarshallSoft Computing
Contents
1. 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 mcmGetString MCM_GET_BOUNCE_STRING 1 Work 255 if Code gt 0 EXAMPLE PROGRAMS GetReply ALSO SEE memGetString mcmGetInteger and mcmGetInteger2 13 2 9 mcmLoadString Load substitution string SYNTAX DECLARE INTEGER mcmLoadString in MCM32 DLL STRING StringKey STRING StringText Code mcmLoadString StringKey StringText StringKey STRING String key StringText STRING String text REMARKS The mcemLoadString loads the substitution string for advanced macros Note Advanced macros have not been implemented yet RETURNS lt 0 Error see Section 3 0 MCM Error List gt 0 No error EXAMPLE CODE none EXAMPLE PROGRAMS none 14 2 10 mcmMergeNext Merge next recipient for sending SYNTAX DECLARE INTEGER mcmMergeNext in MCM32 DLL Code mcmMergeNext REMARKS The mcmMergeNext function merges the next recipient from the recipie2. ProxyCode proxy code reserved set to 0 ProxyFlags proxy server flags l icon on taskbar ProxyDir proxy directory on this machine ProxyCert proxy certificate STUNNEL PEM file or path ProxyExe proxy executable STUNNEL EXE file or path ProxyPort proxy port REMARKS The mcemSetProxySSL program sets parameters for the proxy server Stunnel and must be called before connecting to any SMTP or POP3 server that requires SSL For details on using Stunnel see the section Using Stunnel in the MCM User s Manual mcm4fp_usr pdf in the DOCS directory or online at http www marshallsoft com stunnel htm Set ProxyFlags 1 if an 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 mcem4fp ssl ProxyCert c mcem4fp ssl stunnel pem ProxyExe c mcm4fp ssl stunnel exe Code mcmSetProxySSL 0 1 ProxyDir ProxyCert ProxyExe 8801 EXAMPLE PROGRAMS SendMail 29 2 25 mcmSetString Sets string for MCM processing SYNTAX DECLARE INTEGER mcmSetSt
3. Buffer Space 256 Code mcmGetLetterMacro i Buffer 255 if Code gt 0 find line in letter on which macro i occurs Code mcmGetInteger2 MCM_GET_LETTER_MACRO_LINE i 2 Macro Buffer defined on line Str Code EXAMPLE PROGRAMS none 2 5 mcemGetLetterMacro Get Macro Substitution String in Letter SYNTAX DECLARE INTEGER mcmGetLetterMacro in MCM32 DLL INTEGER MacroNumber STRING Buffer INTEGER BufSize Code mcmGetLetterMacro MacroNumber Buffer BufSize MacroNumber INTEGER Macro number 1 2 Buffer STRING Macro buffer BufSize INTEGER Size of buffer REMARKS The memGetLetterMacro returns the macro substitution string in the 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 memOpenLetter 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 mcmGetLetterMacro i Buffer 255 if Code gt 0 find line in letter on which macro i occurs Code mcmGetInteger2 MCM_GET_LETTER_MACRO_LINE i 2 Macro Buffer defined on line S
4. 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 mcemMergeText 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 mcmMergeText MergeCode Buffer 255 Buffer EXAMPLE PROGRAMS GetReply ALSO SEE mcmMergeNext and mcmOpenSkip 16 2 12 mcmOpenBounce Open bounce file for processing SYNTAX DECLARE INTEGER mcmOpenBounce in MCM32 DLL STRING PathName Code mcmOpenBounce PathName PathName STRING Pathname of bounce file REMARKS The memOpenBounce opens the bounce file into which are written when checking for client replies the email addresses that have been returned 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 mcmOpenBounce is called by the application code that rea
5. 218 Maximum reply files exceeded 219 No such parameter 220 No such header 221 Unknown CharSet 222 Buffer too small 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 230 File does not exist 231 Email address should start with letter delimiter not list delimiter 232 Illegal letter delimiter Expecting 233 Too many addresses Limit is one address 234 Brackets lt gt not allowed in email addresses 302 lstInit not called 303 Cannot open list file 304 No such string 305 Bad delimiter Expecting commas or tabs 306 Cannot determine delimiter on macro line 307 Cannot determine delimiter on entry line 308 Delimiter character must match delimiter on macro line 309 Number delimters must match number on macro line 310 List buffer is too small oe issing entry in recipient list 312 Recipient list string is too long 351 Cannot start SMTP thread 392 aximum allowed channels exceeded 353 No channels specified 37 354 SR 401 ER 403 404 memSmtpClose already called Not connected to servers End of Fil letter ltrInit not called Cannot open letter fil Cannot allocate memory for raw letter 405 406 4
6. EXAMPLE CODE mcmRelease EXAMPLE PROGRAMS SendMail and GetReply 26 2 22 mcmSendMail Sends merged mail SYNTAX DECLARE INTEGER mcmSendMail in MCM32 DLL Code mcmSendMail REMARKS The memSendMail function sends the email created by calling memMergeNext RETURNS lt 0 Error see Section 3 0 MCM Error List gt 0 No error EXAMPLE CODE send letter to recipient Code mcmSendMail EXAMPLE PROGRAMS SendMail 27 2 23 mcmSetInteger Sets numeric parameter for MCM processing SYNTAX DECLARE INTEGER mcmSetInteger in MCM32 DLL INTEGER ParamName INTEGER ParamValue Code mcmSetInteger ParamName ParamValue ParamName INTEGER Parameter number ParamValue INTEGER Parameter value REMARKS The memSetInteger 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_ SE
7. INTEGER mcmPop3Connect in MCM32 DLL STRING Server INTEGER Port STRING User STRING Pass Code mcmPop3Connect Server Port User Pass 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 mcmPop3Connect 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 mcemPop3Connect and mcmSmtpConnect 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 mcmPop3Connect POP3_Server POP3_Port POP3_User POP3_Pass EXAMPLE PROGRAMS GetReply ALSO SEE mcmPop3Close 24 2 20 mcmReadReply Read next email from POP3 server SYNTAX DECLARE INTEGER mcmReadReply in MCM32 DLL STRING SubjBuf INTEGER SubjLen INTEGER Flags Code mcmReadReply SubjBuf SubjLen Flags SubjBuf STRING Reply buffer SubjLen INTEGER Size of buffer Flags INTEGER Delete flags REMARKS The memReadReply function reads the next ema
8. of channels authorized by the MCM license but not more than the maximum that was passed to the memAttach 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 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_Port 587 connect to SMTP server on port 587 Code mcmSmtpConnect SMTP_Server SMTP_Port SMTP_User SMTP_Pass SMTP_From 0 0 EXAMPLE PROGRAMS SendMail 33 2 29 mcmStatistics Get runtime statistics SYNTAX DECLARE INTEGER mcmStatistics in MCM32 DLL INTEGER ParamName Code mcmStatistics ParamName ParamName Parameter number REMARKS The memStatistics function returns the runtime statistic corresponding to ParamName MCM_STAT_ TOTA
9. 08 409 410 411 412 413 414 415 451 452 453 454 455 501 502 5 03 504 505 506 507 541 542 543 544 545 546 602 STOL 702 703 704 CT HES 801 802 803 90 2 90 3 Se E EE 95 3 954 955 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 Error reading INCLUDE file Include file too large gt 1024 chars logInit not called ax files exceeded Cannot allocate memory No such file No such file 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 ve
10. 4fp_programmer pdf or online at http www marshallsoft com mcm4fp_programmer pdf Links to the above manuals can also be found online on the MarshallSoft Client Mailer for Visual FoxPro product page http www marshallsoft com mcm4fp htm 2 0 MCM Functions All MCM functions are declared in file MCM32FUN FOX 2 1 memAttach Initialize MarshallSoft Client Mailer SYNTAX DECLARE INTEGER mcmAttach in MCM32 DLL INTEGER KeyCode INTEGER EditionCode INTEGER ChansWanted INTEGER DebugLevel STRING PathToMCM Code mcmAttach 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 memA ttach function initializes the Client Mailer DLL MCM32 DLL passing the initialization parameters 1 KeyCode 0 for the evaluation version 2 Edition Code 0 for the evaluation version 3 the maximum number of channels to use when sending email and 4 the debug level 0 for no debug 1 for low and 2 for high and 5 PathToMCM the pathname of the log file folder A keycode file keycode fox containing the customer s keycode are included when MCM4FP is purchased memAttach must be the first MarshallSoft Client Mailer MCM function called
11. Buffer INTEGER BufSize Code mcmGetString ParamName Buffer BufSize ParamName INTEGER Parameter number Buffer STRING String buffer BufSize INTEGER Size of buffer REMARKS The mcemGetString 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_VERSION Copies the MCM version string into Buffer MCM_GET_LETTER Copies the entire letter into Butter 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 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 mcmGetString MCM_GET_LETTER Work 4095 if Code gt 0 Work EXAMPLE PROGRAMS SendMail and GetReply ALSO SEE mcmGetInteger and mcmGetInteger2 12 2 8 mecmGetString2 Gets string parameter for MCM processing SYNTAX Code XmcmGetString2 ParmName Selection Buffer BufSize ParmName INTEGER Parameter number Selection INTEGER Selection index 1 2
12. L 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 mcmStatistics MCM_STAT_DUPLICATE_ADDRESSES Str DupAddresses duplicate addresses seen EXAMPLE PROGRAMS SendMail ALSO SEE mcmGetIntetger and mcmGetInterger2 34 2 30 mcemUtility MCM Utility Function SYNTAX DECLARE INTEGER mcmUtility in MCM32 DLL INTEGER ParamName STRING 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 mcmWriteToLog Write to log file SYNTAX DECLARE INTEGER mcmWriteToLog in MCM32 DLL STRING Text Code mcmWriteToLo
13. MarshallSoft Client Mailer Library for Visual FoxPro Reference Manual MCM4FP Version 5 0 October 24 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 Pag
14. T CHANNEL DIVISOR Sets the channel divisor D default 4 such that the number of channels N used is reduced so that N 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 letter 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 T 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 mcmSet Integer MCM_SET_DEBUG_LEVEL MCM_DEBUG_LOW EXAMPLE PROGRAMS None 28 2 24 mcmSetProxySSL Set SSL Proxy Parameters SYNTAX DECLARE INTEGER mcmSetProxySSL in MCM32 DLL INTEGER ProxyCode INTEGER ProxyFlags STRING ProxyDir STRING ProxyCert STRING ProxyExe INTEGER ProxyPort
15. d instead To rewind the recipient list file pass 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 mcm4fp apps list txt Code mcmOpenList ListFile EXAMPLE PROGRAMS SendMail ALSO SEE mcmOpenLetter 20 2 16 mcmOpenReply Open reply file for processing SYNTAX DECLARE INTEGER mcmOpenReply in MCM32 DLL STRING RemoveFile STRING RemoveString Code mcmOpenReply RemoveFile RemoveString RemoveFile STRING Pathname of reply file RemoveString STRING Reply string REMARKS The memOpenReply 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 mcm4fp apps remove txt RemoveString REMOVE open file for replies on subject line REMOVE email address Code mcmOpenReply RemoveFile RemoveString EXAMPLE PROGRAMS GetReply ALSO SEE mcmO
16. ds 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 mcm4fp apps bounce txt Code mcmOpenBounce BounceFile EXAMPLE PROGRAMS GetReply ALSO SEE memOpenSkip 17 2 13 mcmOpenHeader Open header file for processing SYNTAX DECLARE INTEGER mcmOpenHeader in MCM32 DLL STRING HeaderName Code mcmOpenHeader HeaderName HeaderName STRING Filename of header fil REMARKS The mcmOpenHeader file opens the letter header file and scans for macros An example of a letter is To EmailAddress Subject Your Dental Appointment Required headers are To Email recipient Subject Email subject Optional header lines are CharSet Character set GE 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 mcm4fp apps letter hdr Code mcmOpenHeader HeaderFile EXAMPLE PROGRAMS SendMail ALSO SEE mcmOpenLetter 18 2 14 mcmOpenLetter Open letter file for processing SYNTAX DECLARE INTEGER mcmOpenLetter in MCM32 DLL STRING LetterName Code mcmOpenLetter Lett
17. e Close SMTP server connection SYNTAX DECLARE INTEGER mcmSmtpClose in MCM32 DLL Code mcmSmtpClose REMARKS The mcemSmtpClose function closes all SMTP channels and will not return until all channels are closed Before calling memSmtpClose the Code mcmGetInteger 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 mcemSmtpClose EXAMPLE PROGRAMS SendMail ALSO SEE mcmPop3Close 32 2 28 mcmSmtpConnect Connect to SMTP server SYNTAX DECLARE INTEGER mcmSmtpConnect in MCM32 DLL STRING Server INTEGER Port STRING User STRING Pass STRING From INTEGER ReOpen INTEGER Delay Code mcmSmtpConnect 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 memSmtpConnect function connects to the specified SMTP server using the number
18. e Page OAD O BWW WwW OO JO DG GA b i CH WBWWWWWWWNHNNNNNNNNDND YUDOBPWNFPOUO DANA L b t OO vo 1 Introduction The MarshallSoft Client Mailer for Visual FoxPro provides the capability to send personalized email to your clients or customers directly from your Visual FoxPro application program The MarshallSoft Client Mailer for Visual FoxPro Reference Manual contains details on each individual MCM function The most current version of the MarshallSoft Client Mailer for Visual FoxPro can be found at http www marshallsoft com mcm4fp htm 1 1 General Remarks This is the reference manual for the Visual FoxPro version of the MarshallSoft Client Mailer MCM There are also versions of MCM for C C Visual Basic Delphi dBase and Xbase 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 mcmErrors txt contains a list of all error codes and their corresponding numerical value Non negative return codes are never errors Note that the memErrorText function is used to get the text message associated with any error code 1 2 MCM Files Visual FoxPro e mem32con fox MCM constants file e mem32fun fox MCM function declaration file e mem32 dl1l1 32 bit MarshallSoft Client Mailer DLL e prg F
19. 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 semicolon 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 mcmGet Integer MCM_GET_CUSTOMER_ID EXAMPLE PROGRAM SendMail 2 4 mcemGetInteger2 Get information for macro processing SYNTAX DECLARE INTEGER mcmGetInteger2 in MCM32 DLL INTEGER ParmName INTEGER Selected Code mcmGetInteger2 ParmName Selected ParamName INTEGER Parameter number Selected INTEGER Selection number for ParamName REMARKS The memGetInteger2 function returns an integer value corresponding to the passed parameters ParamName and Selected RETURNS MCM_GET_LETTER_MACRO LINE Get the line on which the Selected macro appears EXAMPLE CODE get macro string i 1 2 3
20. erName LetterName STRING Filename of letter fil REMARKS The mcmOpenLetter 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 mecmOpenLetter 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 mcm4fp apps letter txt Code mcmOpenLetter LetterFile EXAMPLE PROGRAMS SendMail ALSO SEE mcmOpenHeader 19 2 15 mcmOpenList Open recipient list file for processing SYNTAX DECLARE INTEGER mcmOpenList in MCM32 DLL STRING ListPathName mcmOpenList ListPathName ListPathName STRING Pathname of recipient list file REMARKS The mcemOpenList 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 Lacy Marshall Although the comma is used in the above example as the delimiter character the semicolon tab carrot or tilde could be use
21. g Text String STRING Text to write to the log file REMARKS The memWriteToLog function writes the specified string to the MCM log file Note that memWriteToLog cannot be called until after memAttach is called RETURNS The length of the passed string EXAMPLE CODE Dim Text Text SendMail Example Program mcemWriteToLog Best 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 121 Cannot connect to both SMTP and POP3 141 Cannot set POP3 port 142 Cannot connect to POP3 server 171 Too many reply files 201 Not authorized internal error 202 First line of letter must start with To 203 Second line of letter must start with Subject 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 210 Max recipient list siz xceeded in evaluation version 211 Cannot allocate memory for letter buffers 212 TCP TP running on Ethernet 214 Path to MCM directory cannot be null 215 Must specify path to MCM directory 216 No such macro 217 Maximum skip files exceeded
22. il from the POP3 server copying the subject to the SubjBuf 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 previous specified reply strings 3 All other email Flags specify if the email of the type specified in the above paragraph is to be deleted MCM_DELETE_BOUNCED 1 MCM_DELETE_MATCHED 2 MCM_DELETE_OTHER 4 only type 1 bounced and type 2 recognized replied to emails are to be deleted but not others set Flags to 3 Hence Flags 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 mcmReadReply SubjectBuffer 255 DeleteCode EXAMPLE PROGRAMS GetReply ALSO SEE 25 2 21 mcemRelease Close down MCM SYNTAX DECLARE INTEGER mcmRelease in MCM32 DLL Code mcmRelease REMARKS The mcemRelease 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
23. nt list with the loaded letter in preparation for sending See the mcmMergeText function for a list of the merge codes mcmMergeNext 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 mcmMergeText EXAMPLE CODE send letter to each recipient for I 1 To 1000 merge letter with next recipient MergeCode mcmMergeNext EXAMPLE PROGRAMS GetReply ALSO SEE mcmMergeText 15 2 11 mcmMergeText Get text for associated merge code SYNTAX DECLARE INTEGER mcmMergeText in MCM32 DLL INTEGER MergeCode STRING Buffer INTEGER BufSize Code mcmMergeText MergeCode Buffer BufSize MergeCode INTEGER Merge code Buffer STRING String buffer BufSize INTEGER Size of buffer REMARKS The memMergeText function copies the merge code text corresponding with the numerical MergeCode to Butter so that it can be displayed by the calling application program Recall that if the value returned by the memMergeNext 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 mem32con fox and include MCM MERGE INVALID ADDRESS Invalid email address MCM_MERGE_DUPLICATE_ADDRESS Duplicate email address MCM MERGE BRACKETS NOT ALLOWED lt and
24. oxPro example programs 1 3 Documentation Set There are five manuals in Adobe PDF format for 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 Visual FoxPro Delphi C C VB etc e Programmer Manual Contains programming language Visual FoxPro Delphi C C etc specific information such as compiling and running example programs It is highly recommended that the tutorial manual be read first 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 mcem_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 mcem_users pdf or online at http www marshallsoft com mcm_users pdf e Reference Manuals mcm4fp_reference pdf or online at http www marshallsoft com mcm4fp_reference pdf e Programmer Manuals mcm
25. penSkip and mcmOpenBounce 21 2 17 mcmOpenSkip Open skip file for processing SYNTAX DECLARE INTEGER mcmOpenSkip in MCM32 DLL STRING SkipPathName Code mcmOpenSkip SkipPathName SkipPathName STRING Pathname of skip file REMARKS The memOpenSkip 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 mcmOpenReply 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 mcem4fp apps bounce txt Open file containing addresses of undeliverable email Code mcmOpenSkip BounceFile EXAMPLE PROGRAMS SendMail ALSO SEE mcmOpenReply and mcmOpenBounce 22 2 18 mcmPop3Close Close POP3 connection SYNTAX DECLARE INTEGER mcmPop3Close in MCM32 DLL Code mcmPop3Close REMARKS The mcmPop3Close 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 mcemPop3Close EXAMPLE PROGRAMS GetReply ALSO SEE mcmPop3Connect 23 2 19 mcmPop3Connect Connect to POP3 server SYNTAX DECLARE
26. ring in MCM32 DLL INTEGER ParamName STRING ParamString Code mcmSetString ParamName ParamString ParamName INTEGER Parameter number ParamString STRING Parameter string REMARKS The mcemSetString function sets a string parameter MCN SET FROM ADDRESS Sets the From address on subsequent outgoing email initially set by mcmSmtpConnect 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_SET_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 mcmSetString MCM_SET_FROM_ADDRESS FromAddr EXAMPLE PROGRAMS None 30 2 26 mcmSleep Sleeps specified milliseconds SYNTAX DECLARE INTEGER mcmSleep in MCM32 DLL INTEGER MilliSecs Code mcmSleep MilliSecs MilliSecs INTEGER Milliseconds to sleep REMARKS The memSleep 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 mcmSleep 3000 EXAMPLE PROGRAMS SendMail and GetReply 31 2 27 mcmSmtpClos
27. rsion expired Bad edition code ust call mcmAttach first ELH 38
28. s 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 position 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
29. tr Code EXAMPLE PROGRAMS none ALSO SEE mcmGetListMacro 10 2 6 mcmGetListMacro Get Macro Substitution String in Recipient List SYNTAX DECLARE INTEGER mcmGetListMacro in MCM32 DLL INTEGER MacroNumber STRING Buffer INTEGER BufSize Code mcmGetListMacro MacroNumber Buffer BufSize MacroNumber INTEGER Macro number 1 2 Buffer STRING Macro buffer BufSize INTEGER Size of buffer REMARKS The memGetListMacro 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 memOpenList There are three macros always appearing on the first line in the list The first macro is EmailAddress the second is AppointmentTime and the third is Fullname memGetListMacro 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 mcmGetListMacro i Buffer 255 if Code gt 0 2 Macro Buffer EXAMPLE PROGRAMS none ALSO SEE mcmGetLetterMacro 11 2 7 memGetString Gets string parameter for MCM processing SYNTAX DECLARE INTEGER mcmGetString in MCM32 DLL INTEGER ParamName STRING
30. with the exception of memUtility RETURNS Evaluation days remaining in the evaluation trial period Purchased 999 EXAMPLE CODE KeyCode 0 EditionCode 0 ChansWanted 24 PathToMCM c mcem4fp apps Code mcmAttach KeyCode EditionCode Chanswanted MCM_DEBUG_OFF PathToMCM EXAMPLE PROGRAMS TestMCM SendMail and GetReply 2 2 memGetError Get text associated with error code SYNTAX DECLARE INTEGER mcmGetError in MCM32 DLL INTEGER ErrCode STRING Buffer INTEGER BufLen Code mcemGetError ErrCode Buffer BufLen ErrCode INTEGER Error code Buffer STRING Error text buffer BufLen INTEGER Size of buffer REMARKS The memGetError 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 mcemGetError ErrCode Buffer 255 EXAMPLE PROGRAMS SendMail and GetReply 2 3 memtetlnteger Gets MCM processing information SYNTAX DECLARE INTEGER mcmGetInteger in MCM32 DLL INTEGER ParmName Code mcmGet Integer ParmName ParmName INTEGER Parameter number REMARKS The memGetInteger function returns an integer whose value depend
Download Pdf Manuals
Related Search