SMTP_SetPrefs

Home

4D Internet Commands v16

SMTP_SetPrefs


SMTP_SetPrefs ( lineFeed ; charset&Encoding ; lineLength ) -> Function result

Parameter	Type	Description
lineFeed	Integer	1 = [default] Add, 0 = Don't Add, -1 = No Change
charset&Encoding	Longint	Charset of the message body, headers and attachment filenames as well as encoding of the body (-1 = No Change)
lineLength	Longint	Maximum line length (0 = [default] Auto-detect, -1 = No Change)
Function result	Integer	Error Code

Description

The SMTP_SetPrefs command sets the preferences of messages to be sent using the SMTP commands. The command has a global scope and will affect all subsequent messages created with the SMTP commands. The configurable options affect the format of a mail message as it is sent to a SMTP server using the SMTP_QuickSend or SMTP_Send commands. The preference settings have an interprocess scope and effect mail creation in any 4D process.

SMTP servers recognize the end of a line to be a combined carriage return/line feed (CR/LF) character pair. This differs from most Mac applications, which view a single carriage return as the end of line/paragraph marker.

lineFeed is an integer value which specifies how to handle carriage returns within the body of a mail message. Passing a value of zero in this parameter will leave the message body text untouched, permitting the developer to control their own line feed additions. A value of 1 (default setting) will replace all carriage return/line feed pairings with carriage returns for you. A value of -1 will leave the current value of the preference unchanged. If you are unsure which option to choose, you should choose 1, the default value.

charset&Encoding specifies the charset used in the message body, headers and attachment filenames to be sent as well as the encoding to apply to the message body, according to the values in the table below. For example, “US-ASCII & 7 bit” (value 2) means that the message body charset currently in use is supposed to be US ASCII — includes only standard ASCII codes (0 through 127) which are common to Windows and Mac— and that 4D Internet Commands will encode the message body using the 7 bit encoding. Note that the SMTP_SetPrefs command does NOT convert the message body using the specified charset, this has to be managed by the user if necessary. If you want to force the charset conversion, refer to the SMTP_Charset command description.
If not changed, the default content type is 1.

Value	Body charset & encoding	Headers and attachment filenames charset (encoding always base64)
-1	No change	No change
0	Application & binary; no encoding	ISO-8859-1
1	Default: UTF-8 & base64	Default: UTF-8 for subject, ISO-8859-1 for other fields
2	US-ASCII & 7bit	ISO-8859-1
3	US-ASCII & quotable-printable	ISO-8859-1
4	US-ASCII & base64	ISO-8859-1
5	ISO-8859-1 & quotable-printable	ISO-8859-1
6	ISO-8859-1 & base64	ISO-8859-1
7	ISO-8859-1 & 8bit	ISO-8859-1
8	ISO-8859-1 & binary	ISO-8859-1
9	Reserved	Reserved
10	ISO-2022-JP (Japanese) & 7 bit	ISO-2022-JP
11	ISO-2022-KR (Korean) & 7 bit	ISO-2022-KR
12	ISO-2022-CN (Traditional & Simplified Chinese) & 7 bit	ISO-2022-CN
13	HZ-GB-2312 (Simplified Chinese) & 7 bit	HZ-GB-2312
14	Shift-JIS (Japanese) & base64	Shift-JIS
15	UTF-8 & quoted-printable	UTF-8
16	UTF-8 & base64	UTF-8

Note: We recommend using default settings, which are appropriate for most current systems/applications.

Warning: The € ("euro") character is not part of ISO-8859-1.

lineLength specifies a maximum SMTP line length for text within the message body. The SMTP commands will "line wrap" the body text by inserting a carriage return/line feed pair before the maximum line length when the text is encoded. Any number may be specified but RFC 2822 requires that line length does not exceed 998 and recommends a maximum of 78. A value of -1 will leave the current value unchanged.

The lineLength parameter defaults to zero. A value of zero will cause the SMTP commands to use the recommended values specified within the RFC definitions for the charset&encoding. If the lineLength parameter is set to zero, wrapping will occur based on the following table:

Body Type	Wrap at
Base64	76
Quoted-Printable	76
Other…	no wrapping

Line wrapping is strongly suggested since many systems and mail programs have problems handling messages containing unlimited line lengths. Also, keep in mind that mail often travels through a number of systems before reaching its final destination and any computer along the delivery path may reject a message if it is unable to handle the message's format.

Example

The following code sends a message with body in UTF-8 encoded in quotedprintable (headers remain in default charset):

 $err:=SMTP_SetPrefs(-1;15;-1)

 $err:=SMTP_Charset(0;1) //apply preferences

 $err:=SMTP_QuickSend("mymail.com";"myaddress";"destination";"the Euro €";"the Euro symbol is €")