mapi_message_setreadflag ()

boolean mapi_message_setreadflag(mapimessage $message, long $flag)

Sets the readflag of a specific message.

This function changes or sets the PR_MESSAGE_FLAGS property and controls the processing of read reports.

$inbox = mapi_msgstore_getreceivefolder($userstore);
$contents = mapi_folder_getcontentstable($inbox);

// Loop through all the messages in the inbox and open them one by one,
// each time, marking the message read
for ($i = 0; $i < mapi_table_getrowcount($contents); $i++) {
	$props = mapi_table_queryrows($contents, array(PR_ENTRYID), $i, 1);
	$message = mapi_msgstore_openentry($userstore, $props[PR_ENTRYID]);
	mapi_message_setreadflag($message);
}

// Note: you should actually do this with mapi_folder_setreadflags()
		

mapi_message_getattachmenttable ()

mapitable mapi_message_getattachmenttable(mapimessage $message)

Retrieve attachment table of a message

Returns a table of the attachments of a message. This table contains information about each attachment, most notably PR_ATTACH_NUM which can be passed to mapi_message_openattach to open the attachment object. The table is automatically updated when a new attachment is added or an attachment is removed (even if the attachment table is still open). Returns a mapitable object on success, FALSE on failure.

$inbox = mapi_msgstore_getreceivefolder($userstore);
$contents = mapi_folder_getcontentstable($inbox);

// Loop through all the messages in the inbox and open them one by one,
// each time retrieving their attachment table
for ($i = 0; $i < mapi_table_getrowcount($contents); $i++) {
	$props = mapi_table_queryrows($contents, array(PR_ENTRYID), $i, 1);
	$message = mapi_msgstore_openentry($store, $props[PR_ENTRYID]);
	$attachtable = mapi_message_getattachmenttable($message);
	// the attachement table can be processed with the mapi_table_* functions aswell
}
		

mapi_message_getrecipienttable ()

mapitable mapi_message_getrecipienttable(mapimessage $message

Retrieve recipient table of a message

Each message has a number of recipients (including 0). This function returns a table of recipients for the message. Each row in the table represents one recipient, usually with an e-mail adress in the PR_EMAIL_ADDRESS and 'SMTP' in the PR_ADDRTYPE. Returns a mapitable object on success, FALSE on failure.

$recipienttable = mapi_message_getrecipienttable ($message);
print "Number of recipients: " . mapi_table_getrowcount($recipienttable);
		

mapi_message_modifyrecipients ()

boolean mapi_message_modifyrecipients(mapimessage $message, long $flag, array $recipients)

Add or remove recipients to a message

With this function the recipients of a message can be added, modified or deleted. With the flag the needed action is selected.

The value of the flag can be:

The recipient array should be formed like the following example:

$recipient[] = array {    
	  PR_DISPLAY_NAME=>"John Doe",
	  PR_EMAIL_ADDRESS=>"jdoe@example.com",
	  PR_ADDRTYPE => "SMTP",
	  PR_RECIPIENT_TYPE=> MAPI_BCC
}
	  

$message = mapi_folder_createmessage($folder);

mapi_message_modifyrecipients($message, MODRECIP_ADD,
	array( array(
			PR_DISPLAY_NAME=>"Pete",
			PR_EMAIL_ADDRESS=>"pete@example.com",
			PR_ADDRTYPE => "SMTP",
			PR_RECIPIENT_TYPE=> MAPI_TO
		)
);
		

mapi_message_openattach ()

mapiattach mapi_message_openattach(mapimessage $message, long $attachnum

Open an attachment from a message

This function returns a mapiattach object by opening an existing attachment in a message. You must specify which attachment to open with the $attachnum parameter. This parameter can be retrieved by looking at the attachment table retrieved with mapi_message_getattachmenttable(). Returns a mapiattach object on success, FALSE on failure.

// Open attachment number 0
$attach = mapi_message_openattach ($message, 0);

// Dump properties of the attachment (filename, etc)
print_r(mapi_attach_getprops($attach));
		

mapi_message_createattach ()

mapiattach mapi_message_createattach(mapimessage $message)

Open an attachment from a message

This function returns a mapiattach object by creating a new attachment in a message. Returns a mapiattach object on success, FALSE on failure.

// Open attachment number 0
$attach = mapi_message_createattach ($message);

// Set properties of the attachment
$props = Array(PR_DISPLAY_NAME => "testname.txt",
			PR_FILENAME => "testname.txt",
			PR_ATTACH_METHOD => ATTACH_BY_VALUE,
			PR_ATTACH_DATA_BIN => "Hello world!");

mapi_setprops($attach, $props);
mapi_savechanges($attach);

// Dump properties of the attachment (filename, etc)
print_r(mapi_attach_getprops($attach));
		

mapi_message_deleteattach ()

boolean mapi_message_deleteattach(mapimessage $message, long $attachnum)

Open an attachment from a message

This function deletes an existing attachment in a message. You must specify which attachment to delete with the $attachnum parameter. This parameter can be retrieved by looking at the attachment table retrieved with mapi_message_getattachmenttable(). Returns a mapiattach object on success, FALSE on failure.

// Delete attachment number 0
if (mapi_message_deleteattach($message, 0) == true) {
	print("successfully removed attachment");
} else {
	print("unable to remove attachment");
}
		

mapi_message_submitmessage ()

boolean mapi_message_submitmessage(mapimessage $message)

Submits a message for sending

The message is marked ready for sending when this function is called. MAPI passes messages to the underlying messaging system in the order in which they are marked for sending. Because of this functionality, a message might stay in a message store for some time before the underlying messaging system can take responsibility for it.

// Set the subject
mapi_setprops($message, Array(PR_SUBJECT) => "New subject"));
mapi_savechanges($message);

mapi_message_submitmessage($message);