peoplecodeapi

SendMail

Mon 01 January 2018

Syntax 

SendMail(flags, recipients, CCs, BCCs, subject, text, [, attachment_filenames][, attachment_titles] [, Mail_From] [, Mail_Sep] [, Content_Type] [, Reply_To] [, Sender])

Description

Important! The SendMail function has been deprecated. Use the MCFOutboundEmail class instead.

The SendMail function was formerly used to send an email message from a PeopleSoft application page.

Parameters

Field or Control

Definition

flags

An integer value. This parameter is ignored.

recipients

A string consisting of a delimiter-separated list of email addresses containing the names of the message’s primary recipients.

Note: The delimiter is specified by the Mail_Sep parameter.

CCs

A string consisting of a delimiter-separated list of email addresses that are sent copies of the message.

Note: The delimiter is specified by the Mail_Sep parameter.

BCCs

A string consisting of a delimiter-separated list of email addresses that are sent copies of the message. These recipients won’t appear on the message list.

Note: The delimiter is specified by the Mail_Sep parameter.

subject

A string containing the text that appears in the message’s Subject field.

text

The text of the message.

attachment_filenames

A string consisting of a semicolon-separated list of fully qualified file names, containing the complete path to the file and the file name itself.

attachment_titles

Another semicolon-separated list containing titles for each of the files provided in the attachment_filenames parameter. The titles appear near the attachment icons in place of the fully qualified file name.

Mail_From

A string used to populate the 'reply-to' field. If this parameter isn't specified, the sender address from application server configuration file is used.

Mail_Sep

Specify the delimiter to be used to separate one email address from another. The default value is a semicolon (;).

Content_Type

Specify the content type of the email as a string. The default value is plain text.

If you want to specify HTML, you should use the following: 

Content-type: text/html; charset=utf8
Reply_To

Specify the email address that the receiver should use when replying to this email instead of the Mail_From value.

Sender

Specifies who the email is from, as a string. This may be different than the values specified for Mail_From or Reply_To parameters.

Returns

Returns a number:

Return Code

Description

0

No error

-1

No mail interface installed.