| |
OScript API/Built-in Package Index |
The built-in functions in the MailMessage class provide the ability to create and read email messages for SMTP or POP3 sessions.
The MailMessage class offers the following functionality:
Add a recipient as a blind-carbon-copy (BCC) recipient of an e-mail message.
Add a recipient as a carbon-copy (CC) recipient of an e-mail message.
Set the Content-Disposition for a message part to 'attachment'.
Set the Content-Disposition for a message part to 'inline'.
Set the message Content-Transfer-Encoding to '7-bit'.
Set the message Content-Transfer-Encoding to '8-bit'.
Set the message Content-Transfer-Encoding to 'base64'.
Set the message Content-Transfer-Encoding to 'quoted-printable'.
Add a recipient as the primary recipient of an e-mail message.
Returns a new MailMessage instance, or undefined if an error occured.
Adds inline content to a multipart email message.
Same as calling AddFilePart (attachmentName, filename, CONTENT_ATTACHMENT, contentTransferEncodingType,"text/plain" ) .
Adds data to a multi-part email from a file.
Add a recipient to an email.
Same as calling AddStringPart (attachmentName, stringData, CONTENT_INLINE, contentTransferEncodingType,"text/plain" ) .
Adds string data to a multi-part email.
Retrieves the body of the message.
retrieves the email content type.
Retrieves the date of the email.
Retrieves the field data for a specific header field.
Returns a list of all the email message headers.
Retrieve the a string for the last error code.
Retrieves a list of the multipart content.
Retrieves the full text of the raw message.
Returns a RecArray of recipients.
Retrieves the sender of the email.
Returns the subject from the email.
Checks if the message is a multi-part email.
Adds content to the body of the email.
Set the email content type.
Sets the date of the email.
Sets a generic header field in the message.
Sets the sender of the email.
Set the email subject.
Add a recipient as a blind-carbon-copy (BCC) recipient of an e-mail message.
Add a recipient as a carbon-copy (CC) recipient of an e-mail message.
Set the Content-Disposition for a message part to 'attachment'.
Set the Content-Disposition for a message part to 'inline'.
Set the message Content-Transfer-Encoding to '7-bit'.
Set the message Content-Transfer-Encoding to '8-bit'.
Set the message Content-Transfer-Encoding to 'base64'.
Set the message Content-Transfer-Encoding to 'quoted-printable'.
Add a recipient as the primary recipient of an e-mail message.
Returns a new MailMessage object
A new MailMessage object or undefined if there was an error constructing the object.
Adds inline content to a multipart email message.
the content to inline
the content transfer encoding type, see above for constants
Returns 0 for success and -1 if an error occurred.
Same as calling AddFilePart ( attachmentName, filename, CONTENT_ATTACHMENT, contentTransferEncodingType ). mimeType param is optional and defaults to 'text/plain'.
the name for the attachment
the filename of the attachment
the content encoding
the content mimeType
Returns 0 for success and -1 if an error occurred.
Adds parts to a multipart email, from a file. Content disposition constants are CONTENT_INLINE or CONTENT_ATTACHMENT. See above for content type encodings. The mimeType string is optional and defaults to "text/plain".
the name for the part
the filename to use for the part data
the content disposition type
the content encoding
the content mimeType
Returns 0 for success and -1 if an error occurred.
The type can be one of PRIMARY_RECIPIENT, CC_RECIPIENT or BCC_RECIPIENT. The email param should be the fully qualified email address and the fullName parameter is optional and can contain the users full name ie, "John Doe". You can add as many recipients as you like.
type can be one of PRIMARY_RECIPIENT, CC_RECIPIENT or BCC_RECIPIENT
fully qualified email address of the recipient
optional, can be the full name of the user
Returns 0 for success and -1 if an error occurred.
Same as calling AddStringPart ( attachmentName, stringData, CONTENT_INLINE, contentTransferEncodingType ). mimeType param is optional and defaults to 'text/plain'.
the name for the attachment
the string data of the attachment
the content encoding
the content mimeType
Returns 0 for success and -1 if an error occurred.
Adds parts to a multipart email, from a text source. See above for content disposition constants. See above for content type encodings. The mimeType string is optional and defaults to "text/plain".
the name for the part
the string data to use for the part data
the content disposition type
the content encoding
the content mimeType
Returns 0 for success and -1 if an error occurred.
Returns a string containing the content, or body, of the email. No parameters. Only applicable for non-multipart messages.
Returns a string containing the content, or body, of the email.
Gets the content type of the email.
Returns the content type of the email.
Gets the data of the specified header field. If the message doesn't contain the fieldname, then the string is empty.
the name of the field to retrieve
Returns the data of the field. If the message doesn't contain the fieldname, then the string is empty.
Returns a List of all the message headers. The list will be undefined if an error occurred.
Returns a List of all the message headers. The list will be undefined if an error occurred.
No parameters. Returns an error string for the last error that occured.
Returns an error string for the last error that occured.
Returns a RecArray of all of the parts in the email. The format is as follows:
Returns a RecArray of all of the parts in the email.
Returns a String containing the entire raw contents of the email.
Returns a String containing the entire raw contents of the email.
Returns a recArray of the current email recipients with the following record structure:
Column 1 : Integer : name=Type Column 2 : String : name=Address Column 3 : String : name=RealName See above for type constantsReturns a recArray of the current email recipients.
Gets the sender of the email.
Returns the sender of the email.
Gets the subject of the email.
Returns the subject of the email.
TRUE if the email is a multi-part email, FALSE otherwise. No parameters.
Returns TRUE if the email is a multi-part email, FALSE otherwise.
Adds text to the body of the email. This function is only for simple non-multipart messages.
the content to add to the body
optional, the contentEncoding type to use to encode the content with, see constants above. The default is ENCODING_QUOTEDPRINTABLE.
Returns 0 for success and -1 if an error occurred.
Sets the content type of the email.
Sets the content type of the email, default is "text/plain".
Returns 0 for success and -1 if an error occurred.
Sets the date of the email.
the date of the email.
Returns 0 for success and -1 if an error occurred.
Sets a generic header field in the message.
the name of the field to set
the date for the field
Returns 0 for success and -1 if an error occurred.
Sets the sender of the email.
the sender of the email.
Returns 0 for success and -1 if an error occurred.
Sets the subject of the email.
the subject of the email.
Returns 0 for success and -1 if an error occurred.
| Copyright © 2019 OpenText Corporation. All rights reserved. |