The assignment is to build a tool that will parse and check the emails in a Google and Outlook email ID, and respond to the e-mails based on the context using AI. Use BullMQ as the tasks .
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"36543316","collectionId":"cd60f5c0-a068-4ab2-bedf-eedd3a3c49fc","publishedId":"2sA3dskDUB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-06-26T19:05:32.000Z"},"item":[{"name":"google authentication","id":"2b37e7be-e1d1-40cd-8bb6-45a5ee91a3e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:3000/auth/google","description":"Description:
The provided API endpoint facilitates authentication using Google accounts within the ReachInbox platform. Through this endpoint, users can securely authenticate and authorize access to their Google account information, enabling seamless integration and interaction with ReachInbox services.
Authentication Mechanism:
This endpoint employs OAuth 2.0, a widely adopted standard for authorization, to enable users to grant permission to ReachInbox to access their Google account data without sharing their credentials. Upon successful authentication, users will be issued a token that grants access to their Google account resources as per the defined scope.
Usage:
Developers integrating ReachInbox services into their applications can utilize this endpoint to enable users to authenticate with their Google accounts. Upon successful authentication, the application can retrieve the access token and utilize it to make authorized requests to access the user's Google account resources.
Security:
This endpoint prioritizes security by leveraging OAuth 2.0, ensuring that user credentials are never exposed to ReachInbox. Furthermore, HTTPS protocol is employed to encrypt data transmitted between the client and server, safeguarding sensitive information from unauthorized access or interception.
Endpoint Requirements:
\nUsers must have a valid Google account.
\nDevelopers must register their application with Google's Developer Console and obtain the necessary OAuth 2.0 credentials, including a client ID and client secret.
\nProper handling of OAuth 2.0 authorization flow is required on the client-side to obtain an access token.
\nThe endpoint expects requests to be made over HTTPS.
\nResponse Format:
Upon successful authentication, the endpoint returns an access token that can be used to make authorized requests to access the user's Google account resources. Error responses are provided with appropriate status codes and error messages to facilitate debugging and error handling.
Example Request:
\nbashCopy codePOST /auth/google HTTP/1.1\nHost: localhost\nContent-Type: application/json\n{\n \"client_id\": \"YOUR_CLIENT_ID\",\n \"client_secret\": \"YOUR_CLIENT_SECRET\",\n \"redirect_uri\": \"YOUR_REDIRECT_URI\",\n \"code\": \"AUTHORIZATION_CODE\"\n}\n\nExample Response:
\ncssCopy codeHTTP/1.1 200 OK\nContent-Type: application/json\n{\n \"access_token\": \"ACCESS_TOKEN\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600\n}\n\nDescription:
The provided API endpoint serves as the callback URL for the authentication process with Google accounts within the ReachInbox platform. After users authenticate their Google accounts through the initial authentication endpoint, Google redirects them to this callback URL, along with an authorization code or an access token, depending on the authentication flow. ReachInbox utilizes this callback URL to handle the authentication response and complete the authentication process.
Usage:
Developers integrating ReachInbox services into their applications need to specify this callback URL in their OAuth 2.0 configuration with Google's Developer Console. Upon successful authentication by the user, Google redirects them to this endpoint, along with the necessary authentication parameters.
Authentication Flow:
\nUser initiates the authentication process by accessing the initial authentication endpoint.
\nUser provides consent and authenticates their Google account credentials.
\nUpon successful authentication, Google redirects the user back to the specified callback URL along with an authorization code or access token, depending on the OAuth 2.0 flow used.
\nEndpoint Requirements:
\nProper handling of incoming authentication parameters, such as authorization code or access token, is required on the server-side to complete the authentication process.
\nHTTPS protocol should be used for secure data transmission.
\nResponse Handling:
Upon receiving the authentication parameters from Google, ReachInbox processes the authentication response and validates the received parameters. If the authentication is successful, ReachInbox can proceed with granting access to the user or retrieving additional user information as necessary for the application.
Example Request:
\nvbnetCopy codeGET /auth/google/callback?code=AUTHORIZATION_CODE&state=STATE_STRING HTTP/1.1\nHost: localhost\n\nExample Response:
Upon successful authentication, ReachInbox may generate an appropriate response based on the application's requirements. This could include rendering a success page, redirecting the user to a specific URL within the application, or initiating further actions within the application.
This API endpoint retrieves user information for the specified email address. The request should be sent via an HTTP GET method to the provided URL. Upon successful execution, the server responds with a status code of 200 and a JSON object containing the user's email address, total number of messages, total number of threads, and history ID.
\nResponse Format:
Upon successful execution, the server responds with a status code of 200 (OK) and a JSON object containing the requested user information. The response JSON object includes the following fields:
emailAddress (string): The user's email address.
\nmessagesTotal (number): Total number of messages associated with the user.
\nthreadsTotal (number): Total number of threads associated with the user.
\nhistoryId (string): The history ID associated with the user.
\nExample Request:
\nbashCopy codeGET /api/mail/userInfo/bhavishreddy001@gmail.com HTTP/1.1\nHost: localhost\n\nExample Response:
\ncssCopy codeHTTP/1.1 200 OK\nContent-Type: application/json\n{\n \"emailAddress\": \"bhavishreddy001@gmail.com\",\n \"messagesTotal\": 90,\n \"threadsTotal\": 20,\n \"historyId\": \"fghijkl123456\"\n}\n\nError Handling:
In case of errors during the execution of the request, appropriate HTTP status codes and error messages are returned to indicate the nature of the issue encountered. Common error scenarios include invalid email addresses, authentication failures, or server errors.
Security:
Proper authentication and authorization mechanisms should be in place to ensure that only authorized users can access this endpoint. Additionally, HTTPS protocol is employed to encrypt data transmitted between the client and server, ensuring the security of sensitive information exchanged during the request-response cycle.
Description:
This API endpoint retrieves all draft emails associated with a specific email address within the ReachInbox platform. Users can access this endpoint using the HTTP GET method to retrieve a list of draft emails along with a result size estimate.
Usage:
Developers integrating ReachInbox services into their applications can utilize this endpoint to fetch all draft emails for a particular email address. The retrieved draft emails can be displayed to users or used for further processing within the application.
Endpoint Requirements:
\nThe email address of the user for whom the draft emails are being requested must be provided in the URL path.
\nProper authentication and authorization mechanisms should be implemented to ensure that only authorized users can access this endpoint.
\nResponse Format:
Upon successful execution, the server responds with a status code of 200 (OK) and a JSON object containing an array of draft emails. Each draft email in the array includes the following fields:
id (string): The ID of the draft email.
\nmessageId (string): The ID of the message associated with the draft email.
\nthreadId (string): The ID of the thread associated with the draft email.
\nAdditionally, the response includes a result size estimate indicating the total number of draft emails returned in the response.
\nExample Request:
\nbashCopy codeGET /api/mail/allDrafts/bhavishreddy001@gmail.com HTTP/1.1\nHost: localhost\n\nExample Response:
\ncssCopy codeHTTP/1.1 200 OK\nContent-Type: application/json\n{\n \"drafts\": [\n {\n \"id\": \"draft_id_1\",\n \"messageId\": \"message_id_1\",\n \"threadId\": \"thread_id_1\"\n },\n {\n \"id\": \"draft_id_2\",\n \"messageId\": \"message_id_2\",\n \"threadId\": \"thread_id_2\"\n },\n {\n \"id\": \"draft_id_3\",\n \"messageId\": \"message_id_3\",\n \"threadId\": \"thread_id_3\"\n },\n {\n \"id\": \"draft_id_4\",\n \"messageId\": \"message_id_4\",\n \"threadId\": \"thread_id_4\"\n },\n //Many Draft Emails\n ],\n \"resultSizeEstimate\": 0\n}\n\nError Handling:
In case of errors during the execution of the request, appropriate HTTP status codes and error messages are returned to indicate the nature of the issue encountered. Common error scenarios include invalid email addresses, authentication failures, or server errors.
Security:
Proper authentication and authorization mechanisms should be in place to ensure that only authorized users can access this endpoint. Additionally, HTTPS protocol is employed to encrypt data transmitted between the client and server, ensuring the security of sensitive information exchanged during the request-response cycle.
Description:
This API endpoint facilitates an HTTP GET request to retrieve a list of emails associated with the specified email address within the ReachInbox platform. Users can access this endpoint by providing the target email address in the URL path. The response includes a list of messages with their corresponding IDs and thread IDs, along with a nextPageToken for pagination and a resultSizeEstimate indicating the total number of emails in the response.
Usage:
Developers integrating ReachInbox services into their applications can utilize this endpoint to fetch a list of emails for a particular email address. The retrieved emails can be displayed to users or used for further processing within the application.
Endpoint Requirements:
\nThe email address of the user for whom the emails are being requested must be provided in the URL path.
\nProper authentication and authorization mechanisms should be implemented to ensure that only authorized users can access this endpoint.
\nResponse Format:
Upon successful execution, the server responds with a status code of 200 (OK) and a JSON object containing the following fields:
messages (array): An array of messages, where each message includes the following fields:
\nid (string): The ID of the message.
\nthreadId (string): The ID of the thread associated with the message.
\nnextPageToken (string): A token that can be used to retrieve the next page of results for pagination purposes. If there are no more results, this field may be empty.
\nresultSizeEstimate (number): An estimate of the total number of emails in the response.
\nExample Request:
\ncssCopy codeGET /api/mail/list/bhavishreddy001@gmail.com HTTP/1.1\nHost: localhost\n\nExample Response:
\ncssCopy codeHTTP/1.1 200 OK\nContent-Type: application/json\n{\n \"messages\": [\n {\n \"id\": \"message_id_1\",\n \"threadId\": \"thread_id_1\"\n },\n {\n \"id\": \"message_id_2\",\n \"threadId\": \"thread_id_2\"\n },\n // More messages...\n ],\n \"nextPageToken\": \"next_page_token_value\",\n \"resultSizeEstimate\": 90\n}\n\nError Handling:
In case of errors during the execution of the request, appropriate HTTP status codes and error messages are returned to indicate the nature of the issue encountered. Common error scenarios include invalid email addresses, authentication failures, or server errors.
Security:
Proper authentication and authorization mechanisms should be in place to ensure that only authorized users can access this endpoint. Additionally, HTTPS protocol is employed to encrypt data transmitted between the client and server, ensuring the security of sensitive information exchanged during the request-response cycle.
Description:
This API endpoint facilitates an HTTP GET request to retrieve a specific email message associated with the provided email address and message ID within the ReachInbox platform. Users can access this endpoint by providing the target email address and message ID in the URL path. Upon successful execution, the response contains detailed information about the email message, including its ID, thread ID, label IDs, snippet, payload details, size estimate, history ID, and internal date.
Usage:
Developers integrating ReachInbox services into their applications can utilize this endpoint to fetch a specific email message for a particular email address. The retrieved message details can be displayed to users or used for further processing within the application.
Endpoint Requirements:
\nThe email address and message ID of the target email message must be provided in the URL path.
\nProper authentication and authorization mechanisms should be implemented to ensure that only authorized users can access this endpoint.
\nResponse Format:
Upon successful execution, the server responds with a status code of 200 (OK) and a JSON object containing detailed information about the requested email message. The response includes the following fields:
id (string): The ID of the email message.
\nthreadId (string): The ID of the thread associated with the email message.
\nlabelIds (array of strings): An array containing the label IDs associated with the email message.
\nsnippet (string): A short snippet of the email message content.
\npayload (object): Details about the email message payload, including headers and body.
\nsizeEstimate (number): An estimate of the size of the email message.
\nhistoryId (string): The history ID associated with the email message.
\ninternalDate (string): The internal date of the email message.
\nExample Request:
\nbashCopy codeGET /api/mail/read/bhavishreddy001@gmail.com/message/message_id_123 HTTP/1.1\nHost: localhost\n\nExample Response:
\ncssCopy codeHTTP/1.1 200 OK\nContent-Type: application/json\n{\n \"id\": \"message_id_123\",\n \"threadId\": \"thread_id_456\",\n \"labelIds\": [\"INBOX\", \"UNREAD\"],\n \"snippet\": \"This is a sample email snippet.\",\n \"payload\": {\n // Payload details...\n },\n \"sizeEstimate\": 1024,\n \"historyId\": \"history_id_789\",\n \"internalDate\": \"2024-03-30T10:00:00Z\"\n}\n\nError Handling:
In case of errors during the execution of the request, appropriate HTTP status codes and error messages are returned to indicate the nature of the issue encountered. Common error scenarios include invalid email addresses, message IDs, authentication failures, or server errors.
Security:
Proper authentication and authorization mechanisms should be in place to ensure that only authorized users can access this endpoint. Additionally, HTTPS protocol is employed to encrypt data transmitted between the client and server, ensuring the security of sensitive information exchanged during the request-response cycle.
This endpoint retrieves the details of a specific mail label based on the provided label ID and email address.
\nGET http://localhost:3000/api/mail/getLabel/:email/:labelId
email (string): The email address for which the label details are to be retrieved.
labelId (string): The ID of the label to fetch.
id (string): The ID of the mail label.
name (string): The name of the mail label.
messageListVisibility (string): The visibility of the label in the message list.
labelListVisibility (string): The visibility of the label in the label list.
type (string): The type of the label.
messagesTotal (number): The total number of messages in the label.
messagesUnread (number): The number of unread messages in the label.
threadsTotal (number): The total number of threads in the label.
threadsUnread (number): The number of unread threads in the label.
color.textColor (string): The text color of the label.
color.backgroundColor (string): The background color of the label.
{\n \"id\": \"\",\n \"name\": \"\",\n \"messageListVisibility\": \"\",\n \"labelListVisibility\": \"\",\n \"type\": \"\",\n \"messagesTotal\": 0,\n \"messagesUnread\": 0,\n \"threadsTotal\": 0,\n \"threadsUnread\": 0,\n \"color\": {\n \"textColor\": \"\",\n \"backgroundColor\": \"\"\n }\n}\n\nStartFragment
\nPOST /api/mail/creatLabel/{userEmail}/
This endpoint creates a new label in Gmail for the specified user.
\n{userEmail} (string, required): The email address of the user for whom the label will be created.The request body should contain the details of the label to be created, including its visibility settings, name, and color.
\n200 OK: The label has been successfully created.
\n400 Bad Request: If the request is malformed or missing required parameters.
\n401 Unauthorized: If the request lacks valid authentication credentials.
\n500 Internal Server Error: If there is an unexpected error during processing.
\nEndFragment
\n","urlObject":{"protocol":"http","port":"4400","path":["api","mail","creatLabel","bhavishreddy001@gmail.com",""],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"7eca50d6-8841-4bd2-9709-734c7714d8f6"},{"name":"send mail without queue","id":"c9d1ce18-69b1-4348-af21-767d93980562","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"from\":\"bhavishreddy001@gmail.com\",\r\n \"to\":\"bhavishreddy001@gmail.com\",\r\n \"label\":\"Interested\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/api/mail/sendMail","description":"Description:
This API endpoint enables users to send an email by making a POST request to the specified URL. The request body should include the following parameters:
from (string): The sender's email address.
\nto (string): The recipient's email address.
\nlabel (string): A label for the email.
\nUsage:
Developers or applications can utilize this endpoint to send emails programmatically. By providing the necessary parameters in the request body, users can specify the sender, recipient, and label for the email message.
Request Body:
\nfrom (string): The sender's email address.
\nto (string): The recipient's email address.
\nlabel (string): A label for the email.
\nResponse:
Upon successful execution of the request, the API returns a status code of 200 along with a JSON response containing information about the email delivery. The response includes the following structure:
message (string): A message indicating the result of the email delivery process.
\nresult (object): An object containing detailed information about the email delivery, including:
\naccepted (array of strings): List of email addresses of recipients that accepted the email.
\nrejected (array of strings): List of email addresses of recipients that rejected the email.
\nehlo (array of strings): EHLO response.
\nenvelopeTime (number): Time taken for the envelope.
\nmessageTime (number): Time taken for the message.
\nmessageSize (number): Size of the message.
\nresponse (string): Response message.
\nenvelope (object): Envelope details, including the sender's and recipient's email addresses.
\nmessageId (string): Unique ID assigned to the email message.
\nExample Request:
\njsonCopy codePOST /api/mail/sendMail HTTP/1.1\nHost: localhost\nContent-Type: application/json\n{\n \"from\": \"sender@example.com\",\n \"to\": \"recipient@example.com\",\n \"label\": \"Important\"\n}\n\nExample Response:
\njsonCopy codeHTTP/1.1 200 OK\nContent-Type: application/json\n{\n \"message\": \"Email sent successfully.\",\n \"result\": {\n \"accepted\": [\"recipient@example.com\"],\n \"rejected\": [],\n \"ehlo\": [\"EHLO response\"],\n \"envelopeTime\": 100,\n \"messageTime\": 200,\n \"messageSize\": 1024,\n \"response\": \"Response message\",\n \"envelope\": {\n \"from\": \"sender@example.com\",\n \"to\": [\"recipient@example.com\"]\n },\n \"messageId\": \"unique_message_id\"\n }\n}\n\nError Handling:
In case of errors during the execution of the request, appropriate HTTP status codes and error messages are returned to indicate the nature of the issue encountered. Common error scenarios include invalid email addresses, missing parameters, authentication failures, or server errors.
Security:
Proper authentication and authorization mechanisms should be implemented to ensure that only authorized users or applications can access this endpoint. Additionally, any sensitive information related to the email sending process should be handled securely to prevent unauthorized access or data breaches.
Description:
This API endpoint is designed to send a specific email message identified by the provided message ID. When a request is made to this endpoint, it creates a queue using BullMQ, a Redis-based job queue for Node.js, to handle the sending of the email asynchronously.
Usage:
Developers or applications can utilize this endpoint to trigger the sending of a specific email message stored in the system. This asynchronous approach allows for efficient handling of email sending tasks, preventing delays in the main application flow.
Endpoint Requirements:
\nThe message ID of the email to be sent must be provided in the URL path.
\nProper authentication and authorization mechanisms should be implemented to ensure that only authorized users or applications can access this endpoint.
\nQueue Processing:
When a request is made to this endpoint, a job is created in the BullMQ queue to send the email message. The queue ensures that the email sending task is processed asynchronously, allowing the main application to remain responsive and efficient.
Response Format:
Upon successful initiation of the email sending task, the server responds with a status code of 200 (OK). The email sending process is then handled by the queue in the background.
Example Request:
\nbashCopy codePOST /api/mail/sendone/message_id_123 HTTP/1.1\nHost: localhost\n\nExample Response:
\narduinoCopy codeHTTP/1.1 200 OK\nContent-Type: text/plain\nEmail sending task queued successfully.\n\nError Handling:
In case of errors during the initiation of the email sending task, appropriate HTTP status codes and error messages are returned to indicate the nature of the issue encountered. Common error scenarios include invalid message IDs, authentication failures, or server errors.
Security:
Proper authentication and authorization mechanisms should be implemented to ensure that only authorized users or applications can access this endpoint. Additionally, any sensitive information related to the email sending process should be handled securely to prevent unauthorized access or data breaches.
StartFragment
\nDescription:
This API endpoint allows users to send the same email message to multiple recipients by making a POST request to the specified URL. The request body should include the following parameters:
from (string): The sender's email address.
\nto (array of strings): An array containing the email addresses of the recipients.
\nUsage:
Developers or applications can utilize this endpoint to send the same email message to multiple recipients simultaneously. By providing the sender's email address and an array of recipient email addresses in the request body, users can efficiently distribute the email message to multiple recipients.
Request Body:
\nfrom (string): The sender's email address.
\nto (array of strings): An array containing the email addresses of the recipients.
\nResponse:
Upon successful execution of the request, the API returns a status code of 200 along with a JSON response containing information about the email delivery. The response includes details such as the number of recipients, EHLO response, envelope details, message ID, and any relevant response messages.
Example Request:
\njsonCopy codePOST /api/mail/sendmultiple/message_id_123 HTTP/1.1\nHost: localhost\nContent-Type: application/json\n{\n \"from\": \"bhavishreddy001@gmail.com\",\n \"to\": [\"bhavishreddy001@gmail.com\", \"bhavishreddy007@gmail.com\"]\n}\n\nExample Response:
\njsonCopy codeHTTP/1.1 200 OK\nContent-Type: application/json\n{\n \"message\": \"Email sent successfully to multiple recipients.\",\n \"result\": {\n \"recipientsCount\": 2,\n \"ehlo\": [\"EHLO response\"],\n \"envelope\": {\n \"from\": \"bhavishreddy001@gmail.com\",\n \"to\": [\"bhavishreddy001@gmail.com\", \"bhavishreddy007@gmail.com\"]\n },\n \"messageId\": \"unique_message_id\",\n \"response\": \"Response message\"\n }\n}\n\nError Handling:
In case of errors during the execution of the request, appropriate HTTP status codes and error messages are returned to indicate the nature of the issue encountered. Common error scenarios include invalid email addresses, missing parameters, authentication failures, or server errors.
Security:
Proper authentication and authorization mechanisms should be implemented to ensure that only authorized users or applications can access this endpoint. Additionally, any sensitive information related to the email sending process should be handled securely to prevent unauthorized access or data breaches.
EndFragment
\n","urlObject":{"protocol":"http","port":"3000","path":["api","mail","senmultiple","{:messageid}"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"78a524b3-59a7-41d6-9835-015c46549b94"},{"name":"Microsoft azure authentication","id":"6592b043-0fff-4d0d-8a05-548c37e99777","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:3000/outlook/signin","description":"Description:
The provided API endpoint facilitates user authentication using Microsoft Azure Active Directory (Azure AD) Single Sign-On (SSO) within the assignment. Users can securely sign in using their Azure AD credentials, enabling seamless integration and access to services.
Authentication Mechanism:
This endpoint utilizes the OAuth 2.0 protocol, specifically the OpenID Connect authentication standard, to enable authentication with Azure AD. ReachInbox acts as an OAuth 2.0 client, leveraging Azure AD as the identity provider to authenticate users.
Usage:
Developers integrating ReachInbox services into their applications can utilize this endpoint to enable users to authenticate using their Azure AD credentials. Upon successful authentication, users are granted access to ReachInbox services.
Endpoint Requirements:
\nUsers must have a valid Azure AD account within the tenant associated with ReachInbox.
\nDevelopers must register their application with Azure AD and obtain the necessary OAuth 2.0 credentials, including a client ID and client secret.
\nProper handling of OAuth 2.0 authorization flow is required on the client-side to obtain an access token.
\nSecurity:
Similar to the Google authentication endpoints, this endpoint prioritizes security by leveraging OAuth 2.0 and OpenID Connect. HTTPS protocol is employed to encrypt data transmitted between the client and server, ensuring the security of sensitive information exchanged during the authentication process.
Response Format:
Upon successful authentication, the endpoint returns an access token or an ID token, depending on the requested OAuth 2.0 flow. Error responses are provided with appropriate status codes and error messages to facilitate debugging and error handling.
Example Request:
\nbashCopy codePOST /signin HTTP/1.1\nHost: localhost\nContent-Type: application/json\n{\n \"client_id\": \"YOUR_CLIENT_ID\",\n \"client_secret\": \"YOUR_CLIENT_SECRET\",\n \"redirect_uri\": \"YOUR_REDIRECT_URI\",\n \"code\": \"AUTHORIZATION_CODE\"\n}\n\nExample Response:
\ncssCopy codeHTTP/1.1 200 OK\nContent-Type: application/json\n{\n \"access_token\": \"ACCESS_TOKEN\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600\n}\n\nError Handling:
Errors are returned with appropriate HTTP status codes and error messages in the response body to indicate the nature of the issue encountered during authentication.
The Outlook Profile API retrieves profile information from the Outlook API. The response is in JSON format and includes details such as user principal name, display name, surname, given name, preferred language, email, mobile phone, job title, office location, and business phones.
\nThe response will be in JSON format with the following structure:
\njsonCopy code{\n \"@odata.context\": \"https://graph.microsoft.com/v1.0/$metadata#users/$entity\",\n \"userPrincipalName\": \"String\",\n \"id\": \"String\",\n \"displayName\": \"String\",\n \"surname\": \"String\",\n \"givenName\": \"String\",\n \"preferredLanguage\": \"String\",\n \"mail\": \"String\",\n \"mobilePhone\": \"String or null\",\n \"jobTitle\": \"String or null\",\n \"officeLocation\": \"String or null\",\n \"businessPhones\": [\"String\"]\n}\n\n@odata.context (String): The context URL.userPrincipalName (String): The user's principal name.id (String): The user's ID.displayName (String): The user's display name.surname (String): The user's surname.givenName (String): The user's given name.preferredLanguage (String): The user's preferred language.mail (String): The user's email address.mobilePhone (String or null): The user's mobile phone number, if available.jobTitle (String or null): The user's job title, if available.officeLocation (String or null): The user's office location, if available.businessPhones (Array of Strings): The user's business phone numbers.The Outlook Email Retrieval API retrieves all emails for a specific Outlook account. The request should include the email address as a path parameter. The response will have a status code of 200 and a content type of application/json. The body of the response will contain an array of email objects, with each object containing various properties such as id, createdDateTime, lastModifiedDateTime, subject, bodyPreview, and sender information.
\n{email_address} (Path Parameter): The email address for which emails need to be retrieved.The response will have a status code of 200 and a content type of application/json. The body of the response will contain an array of email objects with the following structure:
\njsonCopy code[\n {\n \"id\": \"String\",\n \"createdDateTime\": \"String (ISO 8601 format)\",\n \"lastModifiedDateTime\": \"String (ISO 8601 format)\",\n \"subject\": \"String\",\n \"bodyPreview\": \"String\",\n \"sender\": {\n \"name\": \"String\",\n \"emailAddress\": {\n \"address\": \"String\",\n \"name\": \"String\"\n }\n }\n // Additional email properties if needed\n },\n // Additional email objects\n]\n\nid (String): The unique identifier of the email.
createdDateTime (String): The date and time when the email was created (in ISO 8601 format).
lastModifiedDateTime (String): The date and time when the email was last modified (in ISO 8601 format).
subject (String): The subject of the email.
bodyPreview (String): A preview of the email body.
sender (Object): Information about the sender of the email.
name (String): The display name of the sender.
emailAddress (Object): The email address of the sender.
address (String): The email address.
name (String): The display name associated with the email address.
This endpoint retrieves the details of a specific message in the Outlook mailbox.
\nMethod: GET
\nURL: https://localhost:3000/outlook/{:email}/read-Msg/{:messageid}
Status: 200
\nContent Type: application/json
\nThe response contains the details of the specified message, including its ID, timestamps, categories, sender information, recipient information, and message flags.
\n{\n \"@odata.context\": \"\",\n \"@odata.etag\": \"\",\n \"id\": \"\",\n \"createdDateTime\": \"\",\n \"lastModifiedDateTime\": \"\",\n \"changeKey\": \"\",\n \"categories\": [],\n \"receivedDateTime\": \"\",\n \"sentDateTime\": \"\",\n \"hasAttachments\": true,\n \"internetMessageId\": \"\",\n \"subject\": \"\",\n \"bodyPreview\": \"\",\n \"importance\": \"\",\n \"parentFolderId\": \"\",\n \"conversationId\": \"\",\n \"conversationIndex\": \"\",\n \"isDeliveryReceiptRequested\": null,\n \"isReadReceiptRequested\": true,\n \"isRead\": true,\n \"isDraft\": true,\n \"webLink\": \"\",\n \"inferenceClassification\": \"\",\n \"body\": {\n \"contentType\": \"\",\n \"content\": \"\"\n },\n \"sender\": {\n \"emailAddress\": {\n \"name\": \"\",\n \"address\": \"\"\n }\n },\n \"from\": {\n \"emailAddress\": {\n \"name\": \"\",\n \"address\": \"\"\n }\n },\n \"toRecipients\": [\n {\n \"emailAddress\": {\n \"name\": \"\",\n \"address\": \"\"\n }\n }\n ],\n \"ccRecipients\": [],\n \"bccRecipients\": [],\n \"replyTo\": [],\n \"flag\": {\n \"flagStatus\": \"\"\n }\n}\n\nThis endpoint is used to send an email via Outlook. The HTTP POST request should be made to the specified URL with the required payload in the raw request body.
\nfrom (string): The email address of the sender.to (string): The email address of the recipient.label (string): The label or category for the email.Upon a successful execution, the API returns a JSON response with the following fields:
\nmessage (string): A message indicating the status of the operation.result (string): Additional result information.Example:
\n{\n \"message\": \"Success\",\n \"result\": \"Email sent successfully\"\n}\n\nIn case of an error, appropriate status codes and error messages will be returned.
\n","urlObject":{"protocol":"http","port":"3000","path":["outlook","bhavishreddy001@outlook.com","send-Mail",""],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"82cfb64f-a968-487b-bfb0-d2d02ffa687e"},{"name":"send mail via outlook using bullmq","id":"25c327c3-7b1a-4071-8f5c-469527864201","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"from\":\"bhavishreddy001@outlook.com\",\r\n \"to\":\"bhavishreddy001@gmail.com\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/outlook/sendone/bhavishreddy001@outlook.com/AQMkADAwATMwMAItNzM4OS05N2JkLTAwAi0wMAoARgAAA36UTws0KM9Mtq7OVfl1NfwHAEn2pVXtmdZIpCEBtLcfZLkAAAIBDAAAAEn2pVXtmdZIpCEBtLcfZLkAAAIFXQAAAA==","description":"POST /outlook/sendone/{recipientEmail}/{messageId}
This endpoint sends an email response based on the content of the specified message ID. The response content is generated using OpenAI's text generation capabilities.
\n{recipientEmail} (string, required): The email address of the recipient to whom the reply will be sent.
{messageId} (string, required): The unique identifier of the message for which the reply will be generated.
The request body should contain any additional data required by the endpoint, such as authentication tokens or configuration settings.
\n200 OK: The email response has been successfully sent.
\n400 Bad Request: If the request is malformed or missing required parameters.
\n401 Unauthorized: If the request lacks valid authentication credentials.
\n500 Internal Server Error: If there is an unexpected error during processing.
\n