<Email variable>.BuildSource (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Email variable>.BuildSource (Function)

In french: <Variable Email>.ConstruitSource

Generates the source code of the outgoing email from an Email variable.

The source code is generated in the ..Source property of the Email variable. Then, this source code can be saved in a .eml file for example.

Remark: This function is useful to modify an element found in an outgoing email. The email can be sent by EmailSend. For more details, see Writing a custom email.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

// Initialize the variable
MyMessage is Email

Add(MyMessage..Recipient, "support_test@pcsoft_test.fr")
MyMessage..Sender = "customer@company.fr"
MyMessage..Message = "Auto Email Test"

// Create the .eml file
IF MyMessage.BuildSource() = True THEN
fSaveText("c:\MyEmails\Test.eml", MyMessage..Source)
END

Syntax

<Result> = <Email>.BuildSource([<Advanced options>])

<Result>: Boolean

True if the source code was generated,
False otherwise. The ErrorOccurred variable is set to True if an error occurred.
To find out the name of the error, use the function ErrorInfo with the constant errMessage. The generated code can be read in the Email.Source variable of current thread.

<Email>: Email variable

Versions 15 and later
Name of the Email variable to use.
New in version 15
Name of the Email variable to use.
Name of the Email variable to use.

<Advanced options>: Optional Integer constant

Versions 22 and later
Combination of following constants:
emailOptionEncodeHeader Encodes the message headers in Quoted-Printable if necessary.
The message header is not encoded by default. This constant prevents the emails with wrongly encoded accented characters.
Versions 22 and later
emailOptionHeaderBcc
New in version 22
emailOptionHeaderBcc
emailOptionHeaderBcc Used to add the non-official recipients into the source code of email header.
New in version 22
Combination of following constants:
emailOptionEncodeHeader Encodes the message headers in Quoted-Printable if necessary.
The message header is not encoded by default. This constant prevents the emails with wrongly encoded accented characters.
Versions 22 and later
emailOptionHeaderBcc
New in version 22
emailOptionHeaderBcc
emailOptionHeaderBcc Used to add the non-official recipients into the source code of email header.
Combination of following constants:
emailOptionEncodeHeader Encodes the message headers in Quoted-Printable if necessary.
The message header is not encoded by default. This constant prevents the emails with wrongly encoded accented characters.
Versions 22 and later
emailOptionHeaderBcc
New in version 22
emailOptionHeaderBcc
emailOptionHeaderBcc Used to add the non-official recipients into the source code of email header.

Remarks

To fill a variable of type Email from the contents of its Property ..Source, use the <Email variable>.ImportSource function.

Component: wd260com.dll