mailSaveMessage
PowerScript function
Description
Creates a new message in the user’s inbox or replaces an existing
message.
Applies to
mailSession object
Syntax
|
1 |
mailsession.mailSaveMessage ( messageid, mailmessage ) |
|
Argument |
Description |
|---|---|
|
mailsession |
A mailSession object identifying the session in which you |
|
messageid |
A string whose value is the message ID of the message |
|
mailmessage |
A mailMessage structure containing the message being |
Return value
mailReturnCode. Returns one of the following values:
mailReturnSuccess!
mailReturnFailure!
mailReturnInsufficientMemory!
mailReturnInvalidMessage!
mailReturnUserAbort!
mailReturnDiskFull!
If any argument’s value is null, mailSaveMessage returns
null.
Usage
Before saving a message, you must address the message even if you
are replacing an existing message. The message can be addressed to someone
else for sending later.
Before calling mail functions, you must declare and create a
mailSession object and call mailLogon to establish a mail session.
Examples
This example creates a new message in the inbox of the current user,
which will be sent later to Jerry Smith. The application has already
created the mailSession object mSes and logged on:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
mailRecipient recip mailMessage msg mailReturnCode mRet recip.Name = "Smith, Jerry" mRet = mSes.mailResolveRecipient(recip) IF mRet <> mailReturnSuccess! THEN MessageBox("Save New Message", & "Invalid address.") RETURN END IF msg.NoteText = mle_note.Text msg.Subject = sle_subject.Text msg.Recipient[1] = recip mRet = mSes.mailSaveMessage("", msg) IF mRet <> mailReturnSuccess! THEN MessageBox("Save New Message", & "Failed somehow.") END IF |
This example replaces the last message in the user Jane Smith’s
inbox. It gets the message ID from the MessageID array in the mailSession
object mSes. It changes the message subject, re-addresses the message to
the user, and saves the message. The application has already created the
mailSession object mSes and logged on:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
mailRecipient recip mailMessage msg mailReturnCode mRet string s_ID mRet = mSes.mailGetMessages() IF mRet <> mailReturnSuccess! THEN MessageBox("No Messages", "Inbox empty.") RETURN END IF s_ID = mSes.MessageID[UpperBound(mSes.MessageID)] mRet = mSes.mailReadMessage(s, msg, & mailEntireMessage!, FALSE ) IF mRet <> mailReturnSuccess! THEN MessageBox("Message", "Can't read message.") RETURN END IF msg.Subject = msg.Subject + " Test" recip.Name = "Smith, Jane" mRet = mSes.mailResolveRecipient( recip ) msg.Recipient[1] = recip mRet = mSes.mailSaveMessage(s_ID, msg) IF mRet <> mailReturnSuccess! THEN MessageBox("Save Old Message", "Failed somehow.") END IF |
See also the mail examples in the samples that are supplied with
PowerBuilder.
See also