SetBody (Email subroutine): Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 7: | Line 7: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>email</th> | <tr><th>email</th> | ||
<td> | <td>An <var>Email</var> object.</td></tr> | ||
</td></tr> | |||
<tr><th>content</th> | <tr><th>content</th> | ||
<td>A <var>Stringlist</var> or <var>Longstring</var> that contains the actual e-mail body. | <td>A <var>Stringlist</var> or <var>Longstring</var> that contains the actual e-mail body. | ||
| Line 22: | Line 22: | ||
<tr><th><var>Type</var></th> | <tr><th><var>Type</var></th> | ||
<td>This [[Notation conventions for methods#Name required|name required]] parameter specifies the MIME type of the content. | <td>This [[Notation conventions for methods#Name required|name required]] parameter specifies the MIME type of the content. | ||
MIME content type strings consist of a primary type and a subtype delimited by a forward slash ( / ) character, for example, <code>text/xml</code>. | MIME content-type strings consist of a primary type and a subtype delimited by a forward slash ( / ) character, for example, <code>text/xml</code>. | ||
<var>SetBody</var> performs no validity checking, but it does distinguish between text MIME types ("text"; is the primary type) and non-text types. | <var>SetBody</var> performs no validity checking, but it does distinguish between text MIME types ("text"; is the primary type) and non-text types. | ||
| Line 36: | Line 36: | ||
To enable base64 encoding for text content, specify <code>encoding=base64</code>. To disable encoding for non-text content, specify <code>encoding=none</code>. | To enable base64 encoding for text content, specify <code>encoding=base64</code>. To disable encoding for non-text content, specify <code>encoding=none</code>. | ||
Specifying <code>encoding=none</code> for non-text content is not recommended: the likely result is that the recipient receives corrupt data, or otherwise the SMTP gateway may simply discard the message.</td></tr> | Specifying <code>encoding=none</code> for non-text content is ''not'' recommended: the likely result is that the recipient receives corrupt data, or otherwise the SMTP gateway may simply discard the message.</td></tr> | ||
</table> | </table> | ||
| Line 62: | Line 62: | ||
... | ... | ||
</p> | </p> | ||
<li>For <var>SetBody</var> method examples, see [[Email class#Basic e-mail|"Basic e-mail"]] and | <li>For more <var>SetBody</var> method examples, see [[Email class#Basic e-mail example|"Basic e-mail example"]] and | ||
[[Email class#E-mail with attachment|"E-mail with attachment"]]. | [[Email class#E-mail with attachment|"E-mail with attachment"]]. | ||
</ul> | </ul> | ||
Latest revision as of 21:54, 14 August 2012
Add body content to the message (Email class)
Syntax
email:SetBody( content, [Type= string], [Name= string], [Encoding= string])
Syntax terms
| An Email object. | |
| content | A Stringlist or Longstring that contains the actual e-mail body.
If a Stringlist is passed, each item in the Stringlist is delimited with a carriage-return/line-feed (CR/LF) character pair. To override this line-ending, you can specify a non-text content type as the value of the Type optional argument. In this case, no delimiter is added at the end of an item. If a longstring is passed, no delimiters are added to the content. |
| Type | This name required parameter specifies the MIME type of the content.
MIME content-type strings consist of a primary type and a subtype delimited by a forward slash ( / ) character, for example, SetBody performs no validity checking, but it does distinguish between text MIME types ("text"; is the primary type) and non-text types. If non-text, SetBody encodes the content in base64 format to ensure correct translation at SMTP gateways. You can override this encoding by specifying the Encoding option set to the valuenone. |
| Name | This name required parameter provides a name for the message body or a message part. This option is rarely used for the mail body, and it is usually ignored by the mail client. It is most often used for attachments, which are added with AddPart. |
| Encoding | This name required parameter forces or suppresses encoding for the attachment.
Since base64 encoding is automatically enabled for any non-text content, the Encoding option is usually unnecessary.
To enable base64 encoding for text content, specify encoding=none for non-text content is not recommended: the likely result is that the recipient receives corrupt data, or otherwise the SMTP gateway may simply discard the message. |
Usage notes
- The Type, Name, and Encoding options may be specified in any combination, but each may be specified only once.
- Subsequent invocations of the SetBody method completely replace any existing content.
Examples
- The following code fragment adds HTML text to the to the body of an
SMTP message:
... %greet is object Email %sl is object Stringlist html to %sl <html> <h1> Hello world! </h1> </html> end html %greet:SetBody(%sl, type='text/html') ...
- For more SetBody method examples, see "Basic e-mail example" and "E-mail with attachment".