Concepts
Concepts used in Microsoft Outlook BDK Book.
Outlook email
An Outlook Email represents an email message in Microsoft Graph.
id
The unique identifier for the email.
optional[text]
folder_id
The unique identifier for the folder containing the email.
optional[text]
subject
The subject of the email.
optional[text]
body
The body of the email.
optional[text]
recipients
The recipients of the email.
optional[list of text]
state
The state of the email (e.g., sent, received, draft, deleted, archived, unread).
optional[text]
sent_date_time
The date and time the email was sent.
optional[datetime]
received_date_time
The date and time the email was received.
optional[datetime]
sender
The sender of the email.
optional[text]
cc_recipients
The cc recipients of the email.
optional[list of text]
bcc_recipients
The bcc recipients of the email.
optional[list of text]
user_id
The id of the authenticated user making the requests. If it is None, the user is the using the "me" endpoints meaning delegated access.
optional[text]
has_attachments
Whether the email has attachments or not.
optional[boolean]
Outlook attachment
An Outlook Attachment represents a file or item attached to a calendar event in Microsoft Graph. It includes the attachment name and content type.
attachment_id
The unique identifier for the attachment.
optional[text]
odata_type
The OData type of the attachment.
optional[text]
user_id
The user ID of the attachment.
optional[text]
name
The name of the attachment.
optional[text]
event_id
The ID of the event to which the attachment is attached.
optional[text]
email_id
The ID of the email to which the attachment is attached.
optional[text]
Outlook email folder
OutlookEmailFolder represents a folder within an Outlook mailbox, providing a way to organize and manage emails. It serves as a utility to group emails based on specific criteria, facilitating efficient email management and retrieval.
id
The unique identifier for the folder.
optional[text]
name
The name of the folder.
optional[text]
user_id
The id of the authenticated user making the requests.
optional[text]
Office user
An Office User represents a user in the Microsoft Graph. It includes key user details such as display name,email address, and job title.
id
The unique identifier for the user.
text
display_name
The name displayed in the address book for the user.
optional[text]
email_address
The user's email address (usually their user principal name).
optional[text]
job_title
The user's job title.
optional[text]
Outlook event
An Outlook Calendar Event is a scheduled occurrence within an Outlook calendar that is managed through theMicrosoft Graph API. The event object includes essential details such as the subject, start and end times, attendees, and location, and supports advanced features like reminders, recurrence patterns, and time zone adjustments.
id
The unique identifier for the event. Read-only.
text
subject
The text of the event's subject line.
optional[text]
body_preview
The preview of the message associated with the event. It is in text format.
optional[text]
start
The start date, time, and time zone of the event. By default, the start time is in UTC.
optional[datetime]
end
The date, time, and time zone that the event ends. By default, the end time is in UTC.
optional[datetime]
The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.
optional[list of outlook event location]
Outlook event location
An Outlook Event Location represents a specific location associated with a calendar event or meeting inMicrosoft Graph. It includes properties like the display name, address, coordinates, and location type, enabling precise identification and use of locations within calendar-related functionalities.
display_name
The name associated with the location.
optional[text]
email_address
Optional email address of the location.
optional[text]
type
The type of location. The possible values are: default, conferenceRoom, homeAddress, businessAddress,geoCoordinates, streetAddress, hotel, restaurant, localBusiness, postalAddress. Read-only.
optional[text]
uri
Optional URI representing the location.
optional[text]
Outlook email address
Represents an email address associated with a contact or calendar item inMicrosoft Graph. It includes only the name and email address fields.
name
The display name associated with the email address.
optional[text]
address
The email address.
optional[text]
Outlook event attendee
An Outlook Event Attendee represents an attendee of a calendar event in Microsoft Graph. It includes the name, email address, attendee type, and response status fields.
name
The display name associated with the attendee.
optional[text]
email_address
The email address of the attendee.
optional[text]
type
The type of attendee as a string. Possible values are: required, optional, resource.
optional[text]
status
The response status of the attendee as a string. Possible values are: accepted, declined, tentative, etc.
optional[text]
response_time
The datetime when the response was recorded.
optional[datetime]
Office group
An Office Group represents a group in the Microsoft Graph. It includes key user details such as display name,and email address.
id
The unique identifier for the group.
text
display_name
The name displayed in the address book for the group.
optional[text]
email_address
The group's email address.
optional[text]
Last updated
Was this helpful?