Module mailslurp::apis::email_controller_api [−][src]
Structs
struct for passing parameters to the method delete_email
struct for passing parameters to the method download_attachment_base64
struct for passing parameters to the method download_attachment
struct for passing parameters to the method download_body_bytes
struct for passing parameters to the method download_body
struct for passing parameters to the method forward_email
struct for passing parameters to the method get_attachment_meta_data
struct for passing parameters to the method get_attachments1
struct for passing parameters to the method get_email_content_match
struct for passing parameters to the method get_email_html
struct for passing parameters to the method get_email_html_query
struct for passing parameters to the method get_email_links
struct for passing parameters to the method get_email
struct for passing parameters to the method get_email_text_lines
struct for passing parameters to the method get_emails_paginated
struct for passing parameters to the method get_gravatar_url_for_email_address
struct for passing parameters to the method get_latest_email_in_inbox
struct for passing parameters to the method get_latest_email
struct for passing parameters to the method get_organization_emails_paginated
struct for passing parameters to the method get_raw_email_contents
struct for passing parameters to the method get_raw_email_json
struct for passing parameters to the method reply_to_email
struct for passing parameters to the method send_email_source_optional
struct for passing parameters to the method validate_email
Enums
struct for typed errors of method delete_all_emails
struct for typed errors of method delete_email
struct for typed errors of method download_attachment_base64
struct for typed errors of method download_attachment
struct for typed errors of method download_body_bytes
struct for typed errors of method download_body
struct for typed errors of method forward_email
struct for typed errors of method get_attachment_meta_data
struct for typed errors of method get_attachments1
struct for typed errors of method get_email_content_match
struct for typed errors of method get_email
struct for typed errors of method get_email_html
struct for typed errors of method get_email_html_query
struct for typed errors of method get_email_links
struct for typed errors of method get_email_text_lines
struct for typed errors of method get_emails_paginated
struct for typed errors of method get_gravatar_url_for_email_address
struct for typed errors of method get_latest_email
struct for typed errors of method get_latest_email_in_inbox
struct for typed errors of method get_organization_emails_paginated
struct for typed errors of method get_raw_email_contents
struct for typed errors of method get_raw_email_json
struct for typed errors of method get_unread_email_count
struct for typed errors of method reply_to_email
struct for typed errors of method send_email_source_optional
struct for typed errors of method validate_email
Functions
Deletes all emails in your account. Be careful as emails cannot be recovered
Deletes an email and removes it from the inbox. Deleted emails cannot be recovered.
Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.
Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the downloadAttachment method but allows some clients to get around issues with binary responses.
Returns the specified email body for a given email as a string
Returns the specified email body for a given email as a stream / array of bytes.
Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the from option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints.
Returns the metadata such as name and content-type for a given attachment and email.
Returns an array of attachment metadata such as name and content-type for a given email if present.
Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints
Return the matches for a given Java style regex pattern. Do not include the typical / at start or end of regex in some languages. Given an example your code is: 12345 the pattern to extract match looks like code is: (\\d{6}). This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: ['code is: 123456', '123456'] See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns.
Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: ?apiKey=xxx
Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors
HTML parsing uses JSoup and UNIX line separators. Searches content for href attributes
Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.
By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
Get the newest email in all inboxes or in a passed set of inbox IDs
Get the newest email in all inboxes or in a passed set of inbox IDs
By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint
Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
Get number of emails unread. Unread means has not been viewed in dashboard or returned in an email API response
Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails to, cc, and bcc.
Alias for InboxController.sendEmail method - see original method for full details. Sends an email from a given inbox that you have created. If no inbox is supplied a random inbox will be created for you and used to send the email.
Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.