Information

Created By	Knowledge Migration User

Approval Process Status	Published

Objective

Description

Domino – Methods

Use the following methods to configure the Domino component:

Add Calendar Entry
Add Contact
Add Document
Delete Calendar Entries
Delete Contacts
Delete Documents
Delete Emails
Get Folder List
Modify Calendar Entries
Modify Contacts
Modify Documents
Read Calendar Entries
Read Contacts
Read Documents
Read Mails
Send Email
Setup Meetings
Update Notice

The following table lists the methods and parameters that can be used. Parameters in bold are mandatory.

Method	Parameters	Description
Add Calendar Entry sets up Lotus Notes calendar entries using the Lotus Notes server.	Entry Type	The Lotus Notes entry type for the event whose calendar entry you want to add. Select one of the following from the drop-down list: Appointment Anniversary All Day Event Meeting Reminder
	Event Date	The date of the event in DD/MM/YYYY format.
	Start Time	The time the event begins in HH:MM:SS format. The start time is required for the Appointment, Meeting, and Reminder event types.
	Duration	The duration of the event in number of minutes.
	Chairman	The name of the person who organizes and runs the event. This is only available for Meeting entry types.
	Subject	The subject of the event.
	Location	The event location.
	Description	A description of the event.
	To Participants	The list of all participants indicated in the meeting notice's To field. This is only available for Meeting entry types.
	Cc Participants	The list of all participants indicated in the event notice's CC field. This is only available for Meeting entry types.
	Bcc Participants	The list of all participants indicated in the event notice's BCC field. This is only available for Meeting entry types.
	Message Format	The format used to build the event notice text for the meeting subject when sent as an email. This is only available for Meeting entry types.
	Rooms To Reserve	Any room that must be reserved. This is only available for Meeting entry types.
	Reserve Resources	Any resources that need to be reserved for the meeting. This is only available for Meeting entry types.
	Category	The event category. Select one of the following from the drop-down list: Holiday Clients Projects Vacation Phone Calls
	Returned UNID	The returned UNID for this component, sent by Lotus Notes.
	Error Code	A Domino error code. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Add Contact adds contacts to an address book using the Lotus Notes server.	First Name	Contact's first name.
	Middle Name	Contact's middle name.
	Last Name	Contact's last name.
	Title	Contact's title. Select one of the following from the drop-down list: Dr. Prof. Mr. Miss Ms. Mrs.
	Suffix	Contact's suffix. Select one of the following from the drop-down list: Jr. Sr. I II
	Office Phone	Contact's office phone number.
	Office Fax	Contact's office fax number.
	Cell Phone	Contact's cell phone number.
	Home Phone	Contact's home phone number.
	Pager	Contact's pager number.
	Email Address	Contact's email address.
	Web Page	Contact's Web page address.
	Company Name	Contact's company name.
	Job Title	Contact's job title.
	Office Address	Contact's office address.
	Office City	The city where the contact's office is located.
	Office ZIP	Contact's office Zip or Postal code.
	Office State	The state where the contact's office is located.
	Office Country	The country where the contact's office is located.
	Office Location	Contact's office location.
	Department	Name of the department where the contact works.
	Name of Superior	Name of the contact's immediate supervisor.
	Name of Subordinate	Name of people who report to the contact.
	Home Address	Contact's home address.
	Home City	Contact's home city.
	Home ZIP	Contact's home Zip or Postal code.
	Home State	Contact's home state.
	Home Country	Name of the country where the contact lives.
	Name of Spouse	Name of the contact's spouse.
	Names of Children	Name(s) of the contact's children.
	Birthdate	Contact's date of birth (in DD/MM/YYYY format).
	Comments	Any additional comments about the contact.
	Mail Domain	Contact's mail domain.
	Short Name	Contact's short name.
	Category	Contact's category (categories defined by the user).
	Returned UNID	The returned UNID for this component, sent by Lotus Notes.
	Error Code	A Domino error code. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Add Document adds a document to the document database that is defined in Lotus Notes.	Subject	The subject of the Document Library entry.
	Category	The Document Library entry category.
	Originator	The originator of the Document Library entry.
	Type of Review	The type of review for the Document Library file. Select one of the following from the drop-down list: One reviewer at a time All reviewers simultaneously
	Time Limit Options	Time limit options (for checking a Document Library file back in). Select one of the following from the drop-down list: No time limit for each review Keep sending reminders after time limit expires Move to next reviewer after time limit expires
	Notify Originator After	Options for notifying the document originator when review is complete. Select one for the following from the drop-down list: Final reviewer Each reviewer
	Content	The contents of the Document Library entry.
	Upload Date	The date the Document Library file was uploaded (in DD/MM/YYYY format).
	Upload Time	The time the Document Library file was uploaded (in HH:MM:SS format).
	Mark Private	Indicate whether the Document Library file is private. Select one of the following from the drop-down list: Yes No
	Submit For Review	Indicate whether to submit the Document Library file for review. Select one of the following from the drop-down list: Yes No
	Reviewer	The name of the document's reviewer.
	Attached Document 1 Attached Document 2 Attached Document 3 Attached Document 4 Attached Document 5	The path that indicates where an attachment is located on the computer or network. You can have up to five attachments.
	Returned UNID	The returned UNID list for this component, sent by Lotus Notes.
	Error Code	A Domino error code. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Delete Calendar Entries deletes calendar entries using the Lotus Notes server. (If the KeyUNID parameter is '' and all other key parameters are left blank, then all the calendar entries will be deleted. Leaving all filter fields blank (including the KeyUNID) will not result in deleting/modifying all documents. If one of the filters has a value and the KeyUNID is set with ‘’ the KeyUNID will be ignored and the operation will be performed based on the filter/filters parameter.)	KeyDate	The date of the event (in DD/MM/YYYY format).
	KeyChair	The name of the event's chairperson.
	KeySubject	The subject of the event.
	KeyLocation	The location of the event.
	KeyEntryType	Entry type for the Lotus Notes calendar entry
	KeyUNID	The UNID of the event.
	Returned UNID List	The returned UNID list for this component, sent by Lotus Notes.
	Error Code	A Domino error code. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Delete Contacts deletes contacts through the Lotus Notes server. (If the KeyUNID parameter is '' and all other key parameters are left blank, then all the contacts will be deleted. Leaving all filter fields blank (including the KeyUNID) will not result in deleting/modifying all documents. If one of the filters has a value and the KeyUNID is set with ‘’ the KeyUNID will be ignored and the operation will be performed based on the filter/filters parameter.)	KeyFirstName	The first name of the contact that you want to delete.
	KeyLastName	The last name of the contact that you want to delete.
	KeyEmailAddress	The email address of the contact that you want to delete.
	KeyShortName	The short name of the contact that you want to delete.
	KeyCompanyName	The company name of the contact that you want to delete.
	KeyDepartment	The department name of the contact that you want to delete.
	KeyJobTitle	The job title of the contact that you want to delete.
	KeyCategory	The category of the event. Use the Expression Editor to define an event category.
	KeyUNID	The Lotus Notes UNID of the contact that you want to delete.
	Returned UNID List	Returns the UNID list sent by Lotus Notes.
	Error Code	A Domino error code. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Delete Documents deletes a document using the Lotus Notes server. (If the KeyUNID parameter is '' and all other key parameters are left blank, then all the contacts will be deleted. Leaving all filter fields blank (including the KeyUNID) will not result in deleting/modifying all documents. If one of the filters has a value and the KeyUNID is set with ‘’ the KeyUNID will be ignored and the operation will be performed based on the filter/filters parameter.)	KeySubject	The subject of the document library entry that you want to delete.
	KeyCategory	The category of the document library entry that you want to delete.
	KeyOriginator	The originator of the document library entry that you want to delete.
	KeyCreationDate	The creation date of the document library entry that you want to delete (in DD/MM/YYYY format). This date will be compared with the creation date of the document.
	KeyUNID	The Lotus Notes UNID of the document that you want to delete.
	Returned UNID List	Returns the UNID list sent by Lotus Notes.
	Error Code	A Domino error code. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Delete Emails deletes emails through the Lotus Notes server. (If the KeyUNID parameter is '' and all other key parameters are left blank, then all the contacts will be deleted. Leaving all filter fields blank (including the KeyUNID) will not result in deleting/modifying all documents. If one of the filters has a value and the KeyUNID is set with ‘’ the KeyUNID will be ignored and the operation will be performed based on the filter/filters parameter.)	KeyReceivedDate	The date that the email that you want to delete was received (in DD/MM/YYYY format).
	KeySender	The name of the person who sent the email that you want to delete.
	KeySubject	The subject of the email that you want to delete.
	KeyUNID	The Lotus Notes UNID of the email that you want to delete.
	Returned UNID List	Returns the UNID list sent by Lotus Notes.
	Error Code	A Domino error code. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Get Folder List gets the list of user folders and returns the number of Read/Unread/Total emails for each folder. The Read/Unread count is only available for Lotus version 8 or later, and is not supported when a remote session is used.	Output Type	The user folder entry's output type. Select one of the following from the drop-down list: XML CSV
	CSV Delimiter	Specify one of the following delimiters for the CSV file: Comma Semicolon Period This parameter is only available for the CSV output types.
	Output to File	Enter the file name with full path for saving the result.
	Output	Select a BLOB variable to hold the result output.
	Error Code	Select a variable to hold the generated Magic xpi error code return..
Modify Calendar Entries modifies entries in the Lotus Notes calendar. (If the KeyUNID parameter is '' and all other key parameters are left blank, then all the contacts will be deleted. Leaving all filter fields blank (including the KeyUNID) will not result in deleting/modifying all documents. If one of the filters has a value and the KeyUNID is set with ‘’ the KeyUNID will be ignored and the operation will be performed based on the filter/filters parameter.)	KeyDate	The date of the event whose calendar entry you want to modify (in DD/MM/YYYY format).
	KeyChair	The name of the chairperson of the event whose calendar entry you want to modify
	KeySubject	The subject of the event whose calendar entry you want to modify.
	KeyLocation	The location of the event whose calendar entry you want to modify.
	Key Entry Type	The Lotus Notes entry type for the event whose calendar entry you want to modify. Select one of the following from the drop-down list: Appointment Anniversary All Day Event Meeting Reminder
	KeyUNID	The Lotus Notes UNID of the calendar entry that you want to modify.
	Event Date	The date of the event whose calendar entry you want to modify (in DD/MM/YYYY format).
	Start Time	The start time of the event whose calendar entry you want to modify (in HH:MM:SS format).
	Duration	The duration of the event (in minutes) whose calendar entry you want to modify.
	Chairman	The name of the person chairing the event whose calendar entry you want to modify.
	Subject	The subject of the calendar entry that you want to modify.
	Location	The location of the event whose calendar entry you want to modify.
	Description	A description of the event whose calendar entry you want to modify.
	To Participants	A list of the 'To' participants invited to the event whose calendar entry you want to modify.
	Cc Participants	A list of the 'CC' participants invited to the event whose calendar entry you want to modify.
	Bcc Participants	A list of the 'BCC' participants invited to the event whose calendar entry you want to modify.
	Message Format	This builds the invitation text for the subject of the email.
	Rooms To Reserve	Enter the details of any rooms that should be reserved for the meeting.
	Reserve Resources	Enter the details of any resources that you want to reserve for use in the meeting.
	Category	The category of the event whose calendar entry you want to modify. Select one of the following from the drop-down list: Holiday Clients Projects Vacation Phone Calls
	Returned UNID List	Returns the UNID list sent by Lotus Notes.
	Error Code	A Domino error code. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Modify Contacts modifies contact entries. (If the KeyUNID parameter is '' and all other key parameters are left blank, then all the contacts will be deleted. Leaving all filter fields blank (including the KeyUNID) will not result in deleting/modifying all documents. If one of the filters has a value and the KeyUNID is set with ‘’ the KeyUNID will be ignored and the operation will be performed based on the filter/filters parameter.)	KeyFirstName	The first name of the contact whose entry you want to modify.
	KeyLastName	The last name of the contact whose entry you want to modify.
	KeyEmailAddress	The email address of the contact whose entry you want to modify.
	KeyShortName	The short name of the contact whose entry you want to modify.
	KeyCompanyName	The company name of the contact whose entry you want to modify.
	KeyDepartment	The department name of the contact whose entry you want to modify.
	KeyJobTitle	The job title of the contact whose entry you want to modify.
	KeyCategory	The category of the event. Use the Expression Editor to define an event category.
	KeyUNID	The Lotus Notes UNID of the contact entry that you want to modify.
	First Name	The first name of the contact whose entry you want to modify.
	Middle Name	The middle name of the contact whose entry you want to modify.
	Last Name	The last name of the contact whose entry you want to modify.
	Title	The title of the contact whose entry you want to modify. Select one of the following from the drop-down list: Dr. Prof. Mr. Miss Ms. Mrs.
	Suffix	The suffix of the contact whose entry you want to modify. Select one of the following from the drop-down list: Jr. Sr. I II
	Office Phone	The office phone number of the contact whose entry you want to modify.
	Office Fax	The office fax of the contact whose entry you want to modify.
	Cell Phone	The cell phone number of the contact whose entry you want to modify.
	Home Phone	The home phone number of the contact whose entry you want to modify.
	Pager	The pager number of the contact whose entry you want to modify.
	Email Address	The email address of the contact whose entry you want to modify.
	Web Page	The web page of the contact whose entry you want to modify.
	Company Name	The company name of the contact whose entry you want to modify.
	Job Title	The job title of the contact whose entry you want to modify.
	Office Address	The office address of the contact whose entry you want to modify.
	Office City	The office city of the contact whose entry you want to modify.
	Office ZIP	The office ZIP code of the contact whose entry you want to modify.
	Office State	The office state of the contact whose entry you want to modify.
	Office Country	The country's name where the office of the contact whose entry you want to modify is located.
	Office Location	The office location of the contact whose entry you want to modify.
	Department	The company department of the contact whose entry you want to modify.
	Name Of Superior	The superior of the contact whose entry you want to modify.
	Name Of Subordinate	The subordinate of the contact whose entry you want to modify.
	Home Address	The home address of the contact whose entry you want to modify.
	Home City	The home city of the contact whose entry you want to modify.
	Home ZIP	The home ZIP code of the contact whose entry you want to modify.
	Home State	The home state of the contact whose entry you want to modify.
	Home Country	The country's name where the home of the contact whose entry you want to modify is located.
	Name Of Spouse	The spouse's name of the contact whose entry you want to modify.
	Names Of Children	The names of the children of the contact whose entry you want to modify.
	Birthdate	The birth date of the contact whose entry you want to modify (in DD/MM/YYYY format).
	Comments	Comments about the contact whose entry you want to modify.
	Mail Domain	The mail domain of the contact whose entry you want to modify.
	Short Name	The short name of the contact whose entry you want to modify.
	Category	The category of the contact whose entry you want to modify.
	Returned UNID List	Returns the UNID list sent by Lotus Notes.
	Error Code	A Domino error code. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Modify Documents modifies a document using the Lotus Notes server. (If the KeyUNID parameter is '' and all other key parameters are left blank, then all the contacts will be deleted. Leaving all filter fields blank (including the KeyUNID) will not result in deleting/modifying all documents. If one of the filters has a value and the KeyUNID is set with ‘’ the KeyUNID will be ignored and the operation will be performed based on the filter/filters parameter.)	KeySubject	The subject of the document library entry that you want to modify.
	KeyCategory	The category of the document library entry that you want to modify.
	KeyOriginator	The originator of the document library entry that you want to modify.
	KeyCreationDate	The creation date of the document library entry that you want to modify (in DD/MM/YYYY format). This date will be compared with the creation date of the document.
	KeyUNID	The Lotus Notes UNID of the document that you want to modify.
	Subject	The subject of the document library entry that you want to modify.
	Category	The category of the document library entry that you want to modify.
	Originator	The originator of the document library entry that you want to modify.
	Type Of Review	The 'type of review' setting of the document library entry that you want to modify. Select one of the following from the drop-down list: One reviewer at a time All reviewers simultaneously
	Time Limit Options	The 'time limit options' setting of the document library entry that you want to modify. Select one of the following from the drop-down list: No time limit for each review Keep sending reminders after time limit
	Notify Originator After	The 'notify originator after' setting of the document library entry that you want to modify. Select one of the following from the drop-down list: Final reviewer Each reviewer
	Content	The content of the document library entry that you want to modify.
	Upload Date	The upload date of the document library entry that you want to modify (in DD/MM/YYYY format).
	Upload Time	The upload time of the document library entry that you want to modify (in HH:MM:SS format).
	Mark Private	The 'mark private setting' of the document library entry that you want to modify. Select one of the following from the drop-down list: Yes No
	Submit For Review	The 'submit for review' setting of the document library entry that you want to modify. Select one of the following from the drop-down list: Yes No
	Attached Document 1	The path of the first attached document.
	Attached Document 2	The path of the second attached document.
	Attached Document 3	The path of the third attached document.
	Attached Document 4	The path of the fourth attached document.
	Attached Document 5	The path of the fifth attached document.
	Returned UNID List	Returns the UNID list sent by Lotus Notes.
	Error Code	A Domino error code. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Read Calendar Entries reads calendar entries in Lotus Notes.	Filter	Defines the way that the calendar entries are read. Select one of the following from the drop-down list: Fixed: Calendar entries are read over a fixed date interval, from a specific date to another specific date. You define these dates in the From Creation Date and To Creation Date parameters (below). Dynamic: Calendar entries are read from a predefined date up until the current date. You define this date in the Period parameter (below).
	From Creation Date	Reads calendar entries from a specific date of creation (in DD/MM/YYYY format). This parameter is available only if you selected Fixed in the Filter parameter (above).
	From Creation Time	Reads calendar entries from a specific time of creation (in HH/MM/SS format). This parameter is available only if you selected Fixed in the Filter parameter (above).
	To Creation Date	Reads calendar entries up to a specific date of creation (in DD/MM/YYYY format). This parameter is available only if you selected Fixed in the Filter parameter (above).
	To Creation Time	Reads calendar entries up to a specific time of creation (in HH/MM/SS format). This parameter is available only if you selected Fixed in the Filter parameter (above).
	From Meeting Date	Reads calendar entries from a specific meeting date (in DD/MM/YYYY format). This parameter is available only if you selected Fixed in the Filter parameter (above).
	From Meeting Time	Reads calendar entries from a specific meeting time (in HH/MM/SS format). This parameter is available only if you selected Fixed in the Filter parameter (above).
	To Meeting Date	Reads calendar entries up to a specific meeting date (in DD/MM/YYYY format). This parameter is available only if you selected Fixed in the Filter parameter (above).
	To Meeting Time	Reads calendar entries up to a specific meeting time (in HH/MM/SS format). This parameter is available only if you selected Fixed in the Filter parameter (above).
	List Type	Determines whether notice type entries are read. Select one of the following from the drop-down list: Entries (default) Notices Entries and Notices
	Notice Type	Specifies the type of notice that will be outputted. Select one of the following from the drop-down list: All (default) Invitation Accepted Declined Tentatively Accepted This parameter is available only if the List Type parameter is set to Notices or Entries and Notices.
	Invitees To Filter	Indicates which email addresses to filter in the To field. Wildcard characters are supported.
	Invitees CC Filter	Indicates which email addresses to filter in the CC field. Wildcard characters are supported.
	Invitees BCC Filter	Indicates which email addresses to filter in the BCC field. Wildcard characters are supported.
	Subject Filter	Indicates which subject to filter. Wildcard characters are supported.
	Location Filter	Indicates which location to filter. Wildcard characters are supported.
	Period	The time period in which you want to read calendar entries. This parameter is available only if you selected Dynamic in the Filter parameter (above).
	Period Frequency	The period frequency that you want to read calendar entries. Select one of the following from the drop-down list: Days Weeks Months This parameter is available only if you selected Dynamic in the Filter parameter (above).
	Before After	Specify when you want calendar entries to be read. Select one of the following from the drop-down list: Creation Date Before Today Meeting Date Before Today Meeting Date After Today This parameter is available only if you selected Dynamic in the Filter parameter (above).
	Output Type	The calendar entry's output type. Select one of the following from the drop-down list: XML HTML CSV
	CSV Delimiter	Specify one of the following delimiters for the CSV file: Comma Semicolon Period This parameter is only available for the CSV output types.
	Output To File	Enter the name of the calendar entry's output file.
	Output	Contains the output data in BLOB form.
	Error Code	A Domino error code. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Read Contacts reads contacts in Lotus Notes.	Filter	Defines the way that the calendar entries are read. Select one of the following from the drop-down list: Fixed: Calendar entries are read over a fixed date interval, from a specific date to another specific date. You define these dates in the From Creation Date and To Creation Date parameters (below). Dynamic: Calendar entries are read from a predefined date up until the current date. You define this date in the Period parameter (below).
	From Creation Date	Reads contacts from a specific date of creation (in DD/MM/YYYY format). This parameter is available only if you selected Fixed in the Filter parameter (above).
	From Creation Time	Reads contacts from a specific time of creation (in HH/MM/SS format). This parameter is available only if you selected Fixed in the Filter parameter (above).
	To Creation Date	Reads contacts up to a specific date of creation (in DD/MM/YYYY format). This parameter is available only if you selected Fixed in the Filter parameter (above).
	To Creation Time	Reads contacts up to a specific time of creation (in HH/MM/SS format). This parameter is available only if you selected Fixed in the Filter parameter (above).
	Period	The time period in which you want to read contacts. This parameter is available only if you selected Dynamic in the Filter parameter (above).
	Period Frequency	The period frequency that you want to read contacts. Select one of the following from the drop-down list: Days Weeks Months This parameter is available only if you selected Dynamic in the Filter parameter (above).
	First Name Filter	Indicates which first name to filter. Wildcard characters are supported.
	Last Name Filter	Indicates which last name to filter. Wildcard characters are supported.
	Output Type	The contacts' output type. Select one of the following from the drop-down list: XML HTML CSV
	CSV Delimiter	Specify one of the following delimiters for the CSV file: Comma Semicolon Period This parameter is only available for the CSV output types.
	Output To File	Enter the name of the contacts' output file.
	Output	Contains the contacts' output data in BLOB form.
	Error Code	A Domino error code. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Read Documents reads a document using the Lotus Notes server.	Filter	Select one of these filters from the drop-down list: Fixed: This lets you read documents that were created between the From Creation Date and the To Creation Date parameters (below). Dynamic: This lets you read documents that were created in the time period defined in the Period parameter (below).
	From Creation Date	Reads documents from a specific date of creation (in DD/MM/YYYY format). This parameter is available only if you selected Fixed in the Filter parameter (above).
	To Creation Date	Reads documents up to a specific date of creation (in DD/MM/YYYY format). This parameter is available only if you selected Fixed in the Filter parameter (above).
	Period	The time period in which you want to read documents. This parameter is available only if you selected Dynamic in the Filter parameter (above).
	Period Frequency	The period frequency that you want to read documents. Select one of the following from the drop-down list: Days Weeks Months This parameter is available only if you selected Dynamic in the Filter parameter (above).
	Output Type	The documents' output type. Select one of the following from the drop-down list: XML HTML CSV
	CSV Delimiter	Specify one of the following delimiters for the CSV file: Comma Semicolon Period This parameter is only available for the CSV output types.
	Output To File	Enter the name of the documents' output file.
	Output	Contains the documents' output data in BLOB form.
	Error Code	A Domino error code. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Read Mails reads mails in Lotus Notes. For an important note about this method, click here.	Filter	Select one of these filters from the drop-down list: Fixed: This lets you read documents that were created between the From Creation Date and the To Creation Date parameters (below). Dynamic: This lets you read documents that were created in the time period defined in the Period parameter (below).
	Folder	The folder whose mails you want to read. Select one of the following from the drop-down list: All Inbox Drafts Sent Junk Mail Other
	Other Folder Name	Appears only if Folder is specified as Other. Specify here an alternative folder whose mails you want to read.
	Read/Unread Filter	Supported in Notes v. 8 or later and when using a local or remote session. From the drop-down list, select All (default), Read or Unread to apply a mail retrieval filtering.
	From Creation Date	Reads mail from a specific date of creation (in DD/MM/YYYY format). This parameter is available only if you selected Fixed in the Filter parameter (above).
	From Creation Time	Reads mail from a specific time of creation (in HH:MM:SS format). This parameter is available only if you selected Fixed in the Filter parameter (above).
	To Creation Date	Reads documents up to a specific date of creation (in DD/MM/YYYY format). This parameter is available only if you selected Fixed in the Filter parameter (above).
	To Creation Time	Reads documents up to a specific time of creation (in HH:MM:SS format). This parameter is available only if you selected Fixed in the Filter parameter (above).
	Period	The time period in which you want to read mail. This parameter is available only if you selected Dynamic in the Filter parameter (above).
	Period Frequency	The period frequency that you want to read mail. Select one of the following from the drop-down list: Days Weeks Months Minutes This parameter is available only if you selected Dynamic in the Filter parameter (above).
	Max Emails to Retrieve	Limits the number of results, based on the value specified. When set with no value or a value of 0, all filtered emails are returned.
	Download Attachments	Specifies whether to download attachments. Select either Yes or No.
	Include Body	Specifies whether the email body will be included in the output. Select one of the following from the drop-down list: Yes (default) No
	Output Body as a BLOB	Specifies whether to output BLOB content in an output file. Select one of the following from the drop-down list: Yes (default) No
	Output Type	The mail's output type. Select one of the following from the drop-down list: XML HTML CSV
	CSV Delimiter	Specify one of the following delimiters for the CSV file: Comma Semicolon Period This parameter is only available for the CSV output types.
	Output To File	Enter the name of the mail's output file.
	Output	Contains the mail's output data in BLOB form. This parameter is only available for the XML output types.
	Error Code	A Domino error code. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Send Email sends email using Lotus Notes.	Subject	The subject of the email.
	Content	The contents of the email.
	To Recipients	The list of all recipients indicated in the email's To field.
	CC Recipients	The list of all recipients indicated in the email's CC field.
	BCC Recipients	The list of all recipients indicated in the email's BCC field.
	Attachment Path 1 Attachment Path 2 Attachment Path 3 Attachment Path 4 Attachment Path 5	The path that indicates where an attachment is located on the computer or network. You can have up to five attachments. The path element is the original file name followed by \. This creates a directory for each file. You can add additional attachments to each Attachment Path, separated by commas.
	Returned UNID	The returned UNID for this component, sent by Lotus Notes.
	Error Code	A Domino error code. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Setup Meeting sets up meeting entries and sends email notices to meeting participants.	Meeting Date	The date of the meeting (in DD/MM/YYYY format).
	Start Time	The time the meeting begins (in HH:MM:SS format).
	Duration	The duration of the meeting in number of minutes.
	Chairman	The name of the person who organizes and runs the meeting.
	Subject	The subject of the meeting.
	Location	The meeting location.
	Description	The meeting agenda.
	To Participants	The main attendees of the meeting.
	CC Participants	The Cc (optional) attendees of the meeting.
	BCC Participants	The Bcc (FYI only) attendees of the meeting.
	Message Format	The format used to build the meeting notice text for the meeting subject when sent as an email.
	Rooms To Reserve	Any room that must be reserved.
	Reserve Resources	Items or other material necessary for the meeting.
	Category	The meeting category. Select one of the following from the drop-down list: Holiday Clients Projects Vacation Phone Calls
	Returned UNID	The returned UNID for this component, sent by Lotus Notes.
	Error Code	A Domino error code. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
Update Notice accepts or declines meeting invitations and sends an email to the originator.	Key UNID	The UNID of the event whose meeting invitation you want to update.
	Notice Type	The updated meeting invitation's notice type. Select one of the following from the drop-down list: Accept (default) Decline Tentatively Accepted
	Comments	Comments relevant to the meeting notice.
	Error Code	A Domino error code. Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Note:

Magic xpi retrieves a new email according to a search sequence.

The search includes the following three date attributes: DeliveredDate, PostedDate and _creationDate and will return a collection.

Each document in the collection will be checked with the Date formula of the inbox screen:

@If(DeliveredDate != ""; DeliveredDate; PostedDate != ""; PostedDate; @Created)

Only documents that comply with the above formula will be output as new documents.

How to Use Direct Access Methods

Reference

Attachment

Attachment

Domino - Methods (Magic xpi 4.6)

Information

Domino – Methods