MCFOutboundEmail Class Properties
In this section we discuss the MCFOutboundEmail class properties. The properties are described in alphabetical order.
Description
Use this property to specify the port number of the backup SMTP server. This is an optional property when creating an email. If you don't specify a value, the default value is 25.
This property is read/write.
Description
Use this property to specify the server name of the backup SMTP server. The system tries to connect to the backup server if the primary SMTPserver is not available.
This property is read/write.
Description
Use this property to specify the alias for the certificate for Secure Sockets Layer (SSL) client authentication on the backup SMTP server.
This property is read/write.
Related Links
Description
Use this property to specify the SSL port number for the backup SMTP server. This is an optional property. If you don't specify a value for this property, the default value is 465.
This property is read/write.
Related Links
Description
Use this property to specify the user name used to sign onto the backup SMTP server. This user name is used for authentication when sending mail using the backup mail server.
This property is read/write.
Description
Use this property to specify the user password used for signing onto the backup SMTP server. The BackupSMTPUserName and password are used for the authentication when sending mail using the backup mail server.
This property is read/write.
Description
Use this property to indicate whether the connection to the backup SMTP server will be attempted using SSL or not.
This property takes a Boolean value: true if an SSL connection is to be attempted, false if a non-SSL connection is to be attempted.
This property is read/write.
Related Links
Description
Use this property to specify a comma- or semicolon-separated list of addresses that are sent a copy of this email. These blind carbon copy recipients won’t appear on the list of recipients.
This property is read/write.
Description
Use this property to specify the email address the system should direct all bounced mail to.
This property is read/write.
Description
Use this property to specify a comma- or semicolon-separated list of addresses that are sent a copy (carbon copy) of this message.
This property is read/write.
Description
Use this property to specify the character set for the text or the attachment.
You can also specify this property using the SetAttachmentContent method, or the ContentType property.
This property is read/write.
Description
Use this property to set the language of this email. More than one language can be set in a comma-separated list. Use the standard abbreviated language names, such as en, fr, de, da, and so on.
You can also include the country codes when you specify the language, such as en-us.
This property is read/write.
Description
Use this property to specify the content type of this body part.
You can also specify the content type with the SetAttachmentConent method.
You can also use this property to specify the character set. For example, “text/plain; charset=US-ASCII”.
This property is read/write.
Description
Use this property to specify the character set to be applied to all the parts of the email.
This property is read/write.
Description
Use this property to specify a description of the file attachment associated with this email. If there is no file attachment, this property is ignored.
This property is read/write.
Description
Use this property to specify how the body part is presented in the received mail.
Some email clients ignore the setting of this property and present body parts either inline or as file attachments.
Values for this property are:
|
Value |
Description |
|---|---|
|
Attachment |
The body part is shown as a file attachment. |
|
Inline |
The body part is shown in the body itself. |
This property is read/write.
Description
If an error occurs, use the ErrorDescription property to get the description of the error.
This property is effectively read-only.
Note: While this property is actually read/write, from PeopleCode, it is meant to be used in a read-only manner. If this property has a user-specified value, that value will be overwritten automatically when there is an error condition.
Description
If an error occurs, use the ErrorDetails property to get the details of the error.
This property is effectively read-only.
Note: While this property is actually read/write, from PeopleCode, it is meant to be used in a read-only manner. If this property has a user-specified value, that value will be overwritten automatically when there is an error condition.
Description
Use this property to the number of substitution parameters as an integer.
This property is read-only.
Description
If you are adding an attachment to the email, you can specify the name of the file using this property.
PeopleSoft recommends that you keep the file extension specified with this property the same as the original extension found in the file path, otherwise the client applications may not be able to display it properly.
This property is read/write.
Description
Specify the path for the file that contains the contents of this email.
Whether this is a relative or absolute path depends on the FilePathType property.
You can also specify a URL to the file using this property, if the FilePathType property is specified as %FilePath_Absolute.
If you specify a value for this property, the ‘Text’ content is ignored (when used with the ContentType property.)
This property is read/write.
Description
Use this property to specify whether the path specified with the FilePath property is a relative or absolute path. The values for this property are:
|
Value |
Description |
|---|---|
|
%FilePath_Relative |
The file path specified with the FilePath property is a relative path. |
|
%FilePath_Absolute |
The file path specified with the FilePath property is either an absolute path to a file, or a URL to a file. |
If you specify a relative path, the file must be available in the FILES folder of application server folder.
If you specify an absolute path, the file could be on the local machine, in any network folder, or a URL.
If you specify a value for this property, the Text property is ignored.
This property is read/write.
Description
Use this property to specify the email address of the person sending the email.
You can specify more than one address as from in a comma-separated list.
This property is read/write.
Description
Use this property to specify the value of the importance header field.
The importance can be set to the following:
low
normal
high
If the Priority property is not set, the system automatically sets it to the corresponding values like 5, 3 and 1.
This property is read/write.
Description
Use this property to get a partial list of email addresses to which the email could not be sent. The email addresses are in a string, separated by commas.
This property is read-only.
Description
Use this property to specify if authentication is required or not. If the SMTP server does not support authentication or authentication is not enabled, this property is ignored.
This property takes a Boolean value: true if authentication is required, false otherwise.
This property is read/write.
Description
Use this property to specify if the email can be sent to only some of the specified recipients or if it must be sent to all. This property takes a Boolean value: true if a partial list of addresses is acceptable, false otherwise. If the email must go out to all those listed, or to none at all, specify false.
This property is read/write.
Considerations Using IsOkToSendPartial
If the syntax of the email address is wrong, no mail is sent, regardless of the value of this property. The error is reported.
If the syntax of the email addresses is correct but the email server is unable to send mail to some addresses, the value of this property is used to either send or not send to the partial list of email addresses.
If the syntax of all the email addresses are correct and the email server is able to dispatch mail to all the addresses, no error is reported immediately. Later, if some addresses are found invalid by the recipient email server or gateway, the mail is sent back. In this case the source email server has no way to find the invalidity of the email address in advance.
Description
Use this property to specify if the receiver must send acknowledgement that the email was received when it's received. This property takes a Boolean value: true if the return receipt is required, false otherwise.
This property is read/write.
Description
This property returns the message number of the error message associated with this email. The message number is associated with messages in the PeopleTools Message Catalog.
This property is effectively read-only.
Note: While this property is actually read/write, from PeopleCode, it is meant to be used in a read-only manner. If this property has a user-specified value, that value will be overwritten automatically when there is an error condition.
Related Links
Description
This property returns the message set number of the error message associated with the email.
This property is effectively read-only.
Note: While this property is actually read/write, from PeopleCode, it is meant to be used in a read-only manner. If this property has a user-specified value, that value will be overwritten automatically when there is an error condition.
Related Links
Description
The email can contain simple text, one attachment, or a MultiPart object.
If you have assigned a MultiPart object using this property, the text and attachment related properties are ignored.
This property is read/write.
Example
Local PT_MCF_MAIL:MCFMultipart &mp = create PT_MCF_MAIL:MCFMultipart();
&mp.SubType = "alternative; differences=Content-type";
&mp.AddBodyPart(&text);
&mp.AddBodyPart(&html);
&email.MultiPart = ∓
Description
Use this property to specify the priority of this email.
The values are:
Highest Priority
High Priority
Normal
Low Priority
Lowest Priority
The default value is 3, that is, normal priority.
This value set with this property is used to set to a header X-Priority field, as this is the most common but non-standard field to show priority. In addition, the corresponding values are set in two header fields: X-MSMail-Priority and Priority. The headers X-Priority or X-MSMail-Priority are set to the corresponding value only if the user does not specify a value.
This property is read/write.
Description
Use this property to specify the email addresses of all the main recipients to whom the email is being sent. All the addresses are specified in a comma- or semicolon-separated string.
This property is read/write.
Description
Use this property to specify a value for the REFERENCES header field of the message.
This property is read/write.
Description
Use this property to specify a value for the IN-REPLY-TO header field of the message.
This property is read/write.
Description
Use this property to specify the email address where the reply should be sent. You do not need to specify a value for this property if the value is the same as the From property.
This property is read/write.
Description
This property returns the result of the Send method. The values are:
|
Numeric Value |
Constant Value |
Description |
|---|---|---|
|
0 |
%ObEmail_ FailedBeforeSending |
Email failed before being sent. |
|
1 |
%ObEmail_Delivered |
Email was delivered. |
|
2 |
%ObEmail_NotDelivered |
Email delivery not attempted. |
|
3 |
%ObEmail_PartiallyDelivered |
Email has only been partially delivered. Only some of the addresses in the list of addresses were delivered to. |
|
-1 |
%ObEmail_ SentButResultUnknown |
Email was sent but whether it was successful or not is not known. |
This property is read-only.
Description
Use this property to specify the address of the author of the message. You do not need to specify a value for this property if the value for the From property is the same.
This property is read/write.
Description
Use this property to specify the value of the sensitivity header field.
The values are:
personal
private
company-confidential
This property is read/write.
Description
Use this property to specify the port number of SMTP server. This is an optional property. If you don't specify a value for this property, the default value is 25.
This property is read/write.
Description
Use this property to specify the SMTP server to be used when sending this email.
This property is read/write.
Description
Use this property to specify the alias for the certificate for SSL client authentication on the SMTP server.
This property is read/write.
Related Links
SMTPSSLPort, SMTPUseSSL, Using an SSL Connection to Send Email
Description
Use this property to specify the SSL port number for the SMTP server. This is an optional property. If you don't specify a value for this property, the default value is 465.
This property is read/write.
Description
Use this property to specify the user name to be used for logging into the SMTP server.
You should only use this property if the SMTP server allows authentication. If the SMTP server does not allow authentication, setting this property has no effect.
This property is read/write.
Description
Use this property to specify the password for the SMTP user. This property is used with the SMTPUserName property.
This property is read/write.
Description
Use this property to indicate whether the connection to the SMTP server will be attempted using SSL or not. If you don't specify a value for this property, the default value is N.
This property takes a Boolean value: true if an SSL connection is to be attempted, false if a non-SSL connection is to be attempted.
This property is read/write.
Description
Use this property to specify when the system should notify the sender. The values are separated by commas in a string. The values are:
|
Value |
Description |
|---|---|
|
SUCCESS |
Send notification if the email is delivered successfully. |
|
FAILURE |
Send notification if the email is not delivered successfully. |
|
DELAY |
Send notification if delivery of the email is delayed. |
This property is read/write.
Description
Use this property to specify what should be returned as the status notification. You can return either the header or the full message. This option is meaningful only if StatusNotifyOptions property is set.
The values are:
|
Value |
Description |
|---|---|
|
HDRS |
Return only the headers of the email. |
|
FULL |
Return the full email message. |
This property is read/write.
Description
Use this property to specify the subject of the email. A subject can only contain 254 characters.
This property is read/write.
Description
Use this property to specify the text for the email.
This property is read/write.
Description
Use this property to specify the number of milliseconds to wait for the result of send email process. If the result comes back within this time, the returned value is a positive number. Otherwise, %ObEmail_SentButResultUnknown (or -1) is returned.
This property is read/write.
Description
Use this property to determine whether the default configuration as specified in application server configuration file was used or not.
This property returns a Boolean value: true if the default configuration was used, false if the value specified with the MCFOutboundEmail or the SMTPSession object was used.
This property is read-only.
Description
Use this property to determine if the default SMTP server was used, or the backup server.
This property returns a Boolean value: true if the default SMTP server was used, false if the backup server was used.
This property is read-only.
Description
This property returns the list of addresses that were valid and that the email was sent to. The email addresses are in a string, separated by commas.
This property is read-only.
Description
Use this property to get a list of the email addresses that are valid, yet the system was unable to send to, due to system problems. The email addresses are separated by commas.
This property is read-only.