- Steps to follow
- Writing an email with an Email variable
- Writing an email with the Email structure
- Example that uses EmailImportHTML
- Example that uses the Email structure
- Using the EML format to customize emails
There are two methods to handle emails in WLanguage:
- the Email structure, which allows you to easily handle messages.
In this case, to write an email, you must use the different variables of Email structure.
- the advanced Email type, which offers advanced functionalities (data binding, serialization, multiple instances, etc.).
In this case, to write an email, you must declare and initialize a variable of type Email. The possible attachments will be declared in the emailAttach variables and added to the Attach property of the Email variable.
When sending the message (EmailSendMessage
), the data found in the email variable or structure will constitute the outgoing message.
Writing an email with an Email variable
To write an email with an Email variable:
- Declare and initialize a variable of type Email by specifying the recipients and subject with the Recipient, Cc, Bcc and Subject properties, for example.
To manage a conversation follow-up, specify the MessageID property as well.
- If the email is in text format:
- Initialize the Message property with the text of the email.
- Specify the attached files if necessary by declaring variables of type emailAttach and adding them to the Attach property of the variable representing the email.
- If the email is in HTML format: Use EmailImportHTML to initialize the properties of the email. If the email contains images or media files, they will be automatically added in attachment and the content of HTML email will be modified to support the attachments.
EmailImportHTML is not available. You must use the method that is using the Email structure presented below.
- Specify additional headers if necessary via the Header property.
- Send the email with EmailSendMessage. If the subject (or one of the email elements) contains special characters or accented characters, use the emailOptionEncodeHeader constant when the message is sent by EmailSendMessage. The email is sent to the server. The server stores the email until the session is closed. During this closing, the email is actually sent to the recipients.
Writing an email with the Email structure
To write an email with the Email structure:
- Initialize the Email structure by specifying the recipients and subject with the Email.Recipient, Email.NbRecipient, Email.NbCc, Email.Cc and Email.Subject variables, for example.
To follow the progress of conversion, fill Email.MessageID.
- If the email is in HTML format:
- 1st case: EmailImportHTML is available:
- Use EmailImportHTML to initialize the different variables of Email structure.
- 2nd case: EmailImportHTML is not available:
- Initialize the Email.Message and Email.HTML variables.
Remark: We recommend that you use a message in text format for the messaging systems that do not support the emails in HTML format.
- Analyze the HTML message to detect all media files included in the message.
- For each media file found:
- Create an attached file. This attached file corresponds to the multimedia file (Email.Attach and Email.NbAttach variables).
- Create an identifier (Email.AttachIdentifier). This identifier must have the following format "wdcid"+number of attached file. For example, WDCID5 if the corresponding file is the fifth attached file.
- Search for the media file in the HTML message and replace its name by the string: "cid:"+Email.AttachIdentifier.
Initial HTML code: <IMG src="C:\MyImages\Image.gif">
Replaced HTML code: <IMG src="cid:WDCID5">
- Send the email with EmailSendMessage.
Remark: If the subject (or one of the email elements) contains special characters or accented characters, use the emailOptionEncodeHeader constant when the message is sent by EmailSendMessage.
Example that uses EmailImportHTML
This example is used to send an email containing images:
// Start an SMTP session
MySession is emailSMTPSession
MySession.ServerAddress = "smtp.mycompany.com"
// Build the message
MyMessage is Email
MyHTMLText = fLoadText("C:\Email\MyEmail.htm")
EmailImportHTML(MyMessage, MyHTMLText, "C:\Email")
MyMessage.Recipient = "firstname.lastname@example.org"
MyMessage.Subject = "Test"
// Send the message
EmailSendMessage(MySession, MyMessage, emailOptionEncodeHeader)
Example that uses the Email structure
This example is used to replace the references to the media files (images, sounds, ...) found in the Email.HTML variable by their "CID" identifiers. This procedure is called for each file found.
PROCEDURE SetAttachFile(FileName, Subscript)
Email.Attach[Subscript] = FileName
// Replace in Email.HTML all references to the attached files
// by the cid identifier
CID is string = "cid:wdcid" + Subscript
// The HTML file was not necessarily created in the current directory
// It can reference the attached files in any path
// Therefore, extract the file name without path
SimpleName is string = fExtractPath(FileName, fFile + fExtension)
// Find the name of the file in Email.HTML
Pos is int = 0
StartPos, EndPos are int
SubString is string
Pos = Position(Email.HTML, SimpleName, Pos)
IF Pos <> 0 THEN
EndPos = Pos + Length(SimpleName)
// Find the start position of reference
// Find the " marker
SubString = Email.HTML[[Pos]]
WHILE Pos > 1 AND SubString <> """"
SubString = Email.HTML[[Pos]]
StartPos = Pos + 1
SubString = Middle(Email.HTML, StartPos, EndPos - StartPos)
Email.HTML = Replace(Email.HTML, SubString, CID)
Using the EML format to customize emails
In some cases, the structure of outgoing emails may not correspond to the requested information.
- The communication with some organizations (emails for SESAM-VITALE) may require specific structures.
- You may also want to force a specific character set (for a non-Latin language).
- You may want to specify a return address that differs from the sender address.
To customize these emails, WLanguage allows you to create the buffer of the email, to modify it and to send this email.
The following functions are used:
- EmailImportSource: This functions is used to read an existing EML file and to automatically fill the variables of the Email structure.
- EmailBuildSource: This function is used to generate the source code of an email. This function allows you to entirely define the source code of email by using the flexibility of Email structure.
- EmailSend: This functions sends a "buffer" in EML format containing the structured email (created by EmailBuildSource for example).
Complete examples (WINDEV): WD Mail
Training (WINDEV): WD Mailshot
Unit examples (WINDEV): Sending an email in HTML format
Complete examples (WEBDEV): WW_CMS
This page is also available for…
Click [Add] to post a comment