MCFGetMail Class Properties
In this section we discuss the MCFGetMail class properties. The properties are described in alphabetical order.
Description
Use this property to specify the root directory where the attachments are stored. If not specified, the value from the node is used.
Valid metastrings that can be included in the value for this property are:
|
Field or Control |
Definition |
|---|---|
| %CURRDATE% |
Current date in YYYYMMDD format |
| %CURRHOUR% |
Current hour in 24–hour format (00-23) |
| %DBNAME% |
Current value of %DbName system variable. |
| %OPRID% |
Current value of %UserId system variable. |
This property is read/write.
Example
To have the attachment root directory change hourly, you could use the following code example:
&MyEmail.AttachmentRoot = "c:\temp\%CURRDATE%\%CURRHOUR%\";Description
Use this property to
specify content types that should be returned in the message or part
text rather than stored in the directory that contains the attachments.
Specify content types in a comma separated list. For example: "text/html,text/xml".
Note: "Text/plain" is
always returned in the text field and does not need to be included.
If not specified, the value from the node is used.
This property is read/write.
Description
This property returns the number of messages that caused errors during processing on the target connector.
You should use this property after you use the ReadHeaders, ReadEmails, ReadEmailsWithUID, or RemoveEmails methods.
This property is read-only.
Description
This property returns the name of the Integration Broker node on which a request ran, such as MCF_GetMail.
This property is set by the SetMCFEmail method. It is used by ReadHeaders, ReadEmails, ReadEmailsWithUID, RemoveEmails, and CreateQuarantineFolder methods.
This property is read/write.
Description
This property returns the name of the mail server that received the email.
This property is set by the SetMCFEmail method. It is used by ReadHeaders, ReadEmails, ReadEmailsWithUID, RemoveEmails, and CreateQuarantineFolder methods.
This property is read/write.
Description
This property returns the password associated with the userID that was used to get the email.
This property is set by the SetMCFEmail method. It is used by ReadHeaders, ReadEmails, ReadEmailsWithUID, RemoveEmails, and CreateQuarantineFolder methods.
This property is read/write.
Description
This property returns the number of email messages that caused errors during processing on the target connector and were successfully moved to the quarantine folder.
This property is valid after calls to ReadHeaders, ReadEmails, ReadEmailsWithUID, and RemoveEmails.
This property is read-only.
Description
Use this property to specify the name of the quarantine folder. If not specified, the value from the node will be used.
The name must adhere to whatever naming restrictions are imposed by the mail server in use. There is no built-in validation of the folder name.
The following types of errors can cause an email to be moved to the quarantine folder:
Connector size overflow.
Unsupported encoding.
Unknown Java exception.
Javamail content error.
No attachment directory.
Mail parse exception.
This property is read/write.
Description
This property returns the status of the last mail server operation.
See Error Messages Returned by MCFGetMail Class Methods.
This property is valid after calls to ReadHeaders, ReadEmails, ReadEmailsWithUID, and RemoveEmails.
This property is read-only.
Description
This property returns the user ID (mail box) on the mail server that received the email.
This property is set by SetMCFEmail. It is used by ReadHeaders, ReadEmails, ReadEmailsWithUID,RemoveEmails, and CreateQuarantineFolder methods.
This property is read/write.