mailslurp_client 17.1.0 → 17.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/mailslurp_client/api/api_audit_log_controller_api.rb +237 -0
- data/lib/mailslurp_client/api/attachment_controller_api.rb +66 -0
- data/lib/mailslurp_client/api/bounce_controller_api.rb +126 -0
- data/lib/mailslurp_client/api/campaign_probe_controller_api.rb +802 -0
- data/lib/mailslurp_client/api/deliverability_test_controller_api.rb +1496 -0
- data/lib/mailslurp_client/api/device_previews_controller_api.rb +1012 -0
- data/lib/mailslurp_client/api/domain_controller_api.rb +63 -0
- data/lib/mailslurp_client/api/domain_monitor_controller_api.rb +1112 -0
- data/lib/mailslurp_client/api/email_audit_controller_api.rb +334 -0
- data/lib/mailslurp_client/api/email_controller_api.rb +394 -138
- data/lib/mailslurp_client/api/inbox_controller_api.rb +144 -4
- data/lib/mailslurp_client/api/missed_sms_controller_api.rb +221 -0
- data/lib/mailslurp_client/api/phone_controller_api.rb +1314 -83
- data/lib/mailslurp_client/api/sms_controller_api.rb +191 -0
- data/lib/mailslurp_client/api/tools_controller_api.rb +806 -0
- data/lib/mailslurp_client/models/abstract_webhook_payload.rb +15 -15
- data/lib/mailslurp_client/models/acquire_phone_pool_lease_options.rb +233 -0
- data/lib/mailslurp_client/models/add_phone_pool_numbers_options.rb +213 -0
- data/lib/mailslurp_client/models/ai_transform_mapping_projection.rb +39 -39
- data/lib/mailslurp_client/models/ai_transform_projection.rb +28 -28
- data/lib/mailslurp_client/models/alias_projection.rb +48 -48
- data/lib/mailslurp_client/models/alias_thread_projection.rb +44 -44
- data/lib/mailslurp_client/models/analyze_dmarc_report_options.rb +248 -0
- data/lib/mailslurp_client/models/analyze_dmarc_report_results.rb +386 -0
- data/lib/mailslurp_client/models/analyze_email_headers_options.rb +240 -0
- data/lib/mailslurp_client/models/analyze_email_headers_results.rb +275 -0
- data/lib/mailslurp_client/models/attachment_projection.rb +50 -50
- data/lib/mailslurp_client/models/audit_log_event_dto.rb +343 -0
- data/lib/mailslurp_client/models/audit_log_page_dto.rb +222 -0
- data/lib/mailslurp_client/models/audit_log_search_options.rb +323 -0
- data/lib/mailslurp_client/models/available_phone_number_dto.rb +325 -0
- data/lib/mailslurp_client/models/available_phone_numbers_result.rb +236 -0
- data/lib/mailslurp_client/models/bounce_projection.rb +14 -14
- data/lib/mailslurp_client/models/bounce_recipient_projection.rb +10 -10
- data/lib/mailslurp_client/models/campaign_probe_dto.rb +411 -0
- data/lib/mailslurp_client/models/campaign_probe_insights_dto.rb +408 -0
- data/lib/mailslurp_client/models/campaign_probe_run_comparison_dto.rb +397 -0
- data/lib/mailslurp_client/models/campaign_probe_run_dto.rb +644 -0
- data/lib/mailslurp_client/models/campaign_probe_run_due_result.rb +315 -0
- data/lib/mailslurp_client/models/campaign_probe_run_now_result.rb +225 -0
- data/lib/mailslurp_client/models/campaign_probe_series_dto.rb +303 -0
- data/lib/mailslurp_client/models/campaign_probe_series_point_dto.rb +295 -0
- data/lib/mailslurp_client/models/cancel_device_preview_run_options.rb +206 -0
- data/lib/mailslurp_client/models/cancel_device_preview_run_result.rb +248 -0
- data/lib/mailslurp_client/models/check_campaign_probe_options.rb +371 -0
- data/lib/mailslurp_client/models/check_campaign_probe_results.rb +482 -0
- data/lib/mailslurp_client/models/check_dns_propagation_options.rb +297 -0
- data/lib/mailslurp_client/models/check_dns_propagation_results.rb +361 -0
- data/lib/mailslurp_client/models/check_domain_monitor_options.rb +243 -0
- data/lib/mailslurp_client/models/check_domain_monitor_results.rb +398 -0
- data/lib/mailslurp_client/models/check_email_audit_options.rb +405 -0
- data/lib/mailslurp_client/models/check_email_auth_stack_options.rb +248 -0
- data/lib/mailslurp_client/models/check_email_auth_stack_results.rb +462 -0
- data/lib/mailslurp_client/models/check_email_blacklist_options.rb +241 -0
- data/lib/mailslurp_client/models/check_email_blacklist_results.rb +366 -0
- data/lib/mailslurp_client/models/code_candidate.rb +303 -0
- data/lib/mailslurp_client/models/connector_event_projection.rb +33 -33
- data/lib/mailslurp_client/models/connector_projection.rb +42 -42
- data/lib/mailslurp_client/models/contact_projection.rb +24 -24
- data/lib/mailslurp_client/models/create_campaign_probe_options.rb +290 -0
- data/lib/mailslurp_client/models/create_campaign_probe_run_options.rb +264 -0
- data/lib/mailslurp_client/models/create_deliverability_simulation_job_options.rb +345 -0
- data/lib/mailslurp_client/models/create_deliverability_test_options.rb +372 -0
- data/lib/mailslurp_client/models/create_device_preview_feedback_options.rb +405 -0
- data/lib/mailslurp_client/models/create_device_preview_options.rb +241 -0
- data/lib/mailslurp_client/models/create_device_preview_run_result.rb +225 -0
- data/lib/mailslurp_client/models/create_domain_monitor_alert_sink_options.rb +308 -0
- data/lib/mailslurp_client/models/create_domain_monitor_options.rb +299 -0
- data/lib/mailslurp_client/models/create_email_audit_options.rb +394 -0
- data/lib/mailslurp_client/models/create_phone_number_options.rb +25 -4
- data/lib/mailslurp_client/models/create_phone_pool_options.rb +220 -0
- data/lib/mailslurp_client/models/create_phone_provisioning_job_item_options.rb +256 -0
- data/lib/mailslurp_client/models/create_phone_provisioning_job_options.rb +284 -0
- data/lib/mailslurp_client/models/delete_device_preview_run_result.rb +253 -0
- data/lib/mailslurp_client/models/delete_result.rb +245 -0
- data/lib/mailslurp_client/models/deliverability_analytics_run_dto.rb +426 -0
- data/lib/mailslurp_client/models/deliverability_analytics_series_dto.rb +342 -0
- data/lib/mailslurp_client/models/deliverability_analytics_series_point_dto.rb +240 -0
- data/lib/mailslurp_client/models/deliverability_analytics_summary_dto.rb +380 -0
- data/lib/mailslurp_client/models/deliverability_entity_result_dto.rb +360 -0
- data/lib/mailslurp_client/models/deliverability_entity_result_page_dto.rb +318 -0
- data/lib/mailslurp_client/models/deliverability_expectation.rb +276 -0
- data/lib/mailslurp_client/models/deliverability_expectation_result_dto.rb +294 -0
- data/lib/mailslurp_client/models/deliverability_failure_entity_hotspot_dto.rb +360 -0
- data/lib/mailslurp_client/models/deliverability_failure_hotspots_dto.rb +302 -0
- data/lib/mailslurp_client/models/deliverability_failure_phone_dimension_hotspot_dto.rb +306 -0
- data/lib/mailslurp_client/models/deliverability_poll_status_result_dto.rb +250 -0
- data/lib/mailslurp_client/models/deliverability_selector_options.rb +307 -0
- data/lib/mailslurp_client/models/deliverability_simulation_email_options.rb +231 -0
- data/lib/mailslurp_client/models/deliverability_simulation_job_config_dto.rb +300 -0
- data/lib/mailslurp_client/models/deliverability_simulation_job_dto.rb +494 -0
- data/lib/mailslurp_client/models/deliverability_simulation_job_error_summary_dto.rb +224 -0
- data/lib/mailslurp_client/models/deliverability_simulation_job_event_dto.rb +344 -0
- data/lib/mailslurp_client/models/deliverability_simulation_job_event_page_dto.rb +284 -0
- data/lib/mailslurp_client/models/deliverability_simulation_job_top_error_dto.rb +226 -0
- data/lib/mailslurp_client/models/deliverability_simulation_sms_options.rb +209 -0
- data/lib/mailslurp_client/models/deliverability_test_dto.rb +558 -0
- data/lib/mailslurp_client/models/deliverability_test_page_dto.rb +270 -0
- data/lib/mailslurp_client/models/device_preview_feedback_dto.rb +456 -0
- data/lib/mailslurp_client/models/device_preview_feedback_list_dto.rb +255 -0
- data/lib/mailslurp_client/models/device_preview_provider_progress_dto.rb +387 -0
- data/lib/mailslurp_client/models/device_preview_run_dto.rb +382 -0
- data/lib/mailslurp_client/models/device_preview_run_results_dto.rb +243 -0
- data/lib/mailslurp_client/models/device_preview_screenshot_dto.rb +389 -0
- data/lib/mailslurp_client/models/device_preview_target_dto.rb +368 -0
- data/lib/mailslurp_client/models/dmarc_report_metadata.rb +308 -0
- data/lib/mailslurp_client/models/dmarc_report_source_summary.rb +274 -0
- data/lib/mailslurp_client/models/dns_propagation_resolver_result.rb +252 -0
- data/lib/mailslurp_client/models/domain_monitor_alert_sink_dto.rb +369 -0
- data/lib/mailslurp_client/models/domain_monitor_dto.rb +383 -0
- data/lib/mailslurp_client/models/domain_monitor_insights_dto.rb +422 -0
- data/lib/mailslurp_client/models/domain_monitor_run_comparison_dto.rb +369 -0
- data/lib/mailslurp_client/models/domain_monitor_run_dto.rb +492 -0
- data/lib/mailslurp_client/models/domain_monitor_run_due_result.rb +287 -0
- data/lib/mailslurp_client/models/domain_monitor_run_now_result.rb +225 -0
- data/lib/mailslurp_client/models/domain_monitor_series_dto.rb +303 -0
- data/lib/mailslurp_client/models/domain_monitor_series_point_dto.rb +309 -0
- data/lib/mailslurp_client/models/domain_monitor_summary_dto.rb +248 -0
- data/lib/mailslurp_client/models/domain_region_group.rb +261 -0
- data/lib/mailslurp_client/models/domain_region_groups_dto.rb +214 -0
- data/lib/mailslurp_client/models/domain_region_information.rb +338 -0
- data/lib/mailslurp_client/models/email_audit_analysis_result.rb +620 -0
- data/lib/mailslurp_client/models/email_audit_comparison_dto.rb +411 -0
- data/lib/mailslurp_client/models/email_audit_dto.rb +308 -0
- data/lib/mailslurp_client/models/email_audit_spelling_issue.rb +276 -0
- data/lib/mailslurp_client/models/email_audit_url_issue.rb +236 -0
- data/lib/mailslurp_client/models/email_blacklist_ip_result.rb +242 -0
- data/lib/mailslurp_client/models/email_blacklist_listing_result.rb +258 -0
- data/lib/mailslurp_client/models/email_header_analysis_summary.rb +242 -0
- data/lib/mailslurp_client/models/email_header_received_hop.rb +242 -0
- data/lib/mailslurp_client/models/email_projection.rb +66 -66
- data/lib/mailslurp_client/models/email_signature.rb +254 -0
- data/lib/mailslurp_client/models/email_signature_parse_result.rb +223 -0
- data/lib/mailslurp_client/models/email_thread_projection.rb +78 -78
- data/lib/mailslurp_client/models/entity_automation_item_projection.rb +27 -27
- data/lib/mailslurp_client/models/entity_event_item_projection.rb +45 -45
- data/lib/mailslurp_client/models/entity_favourite_item_projection.rb +29 -29
- data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +27 -27
- data/lib/mailslurp_client/models/extract_attachment_text_options.rb +268 -0
- data/lib/mailslurp_client/models/extract_attachment_text_result.rb +297 -0
- data/lib/mailslurp_client/models/extract_codes_options.rb +304 -0
- data/lib/mailslurp_client/models/extract_codes_result.rb +303 -0
- data/lib/mailslurp_client/models/generate_spf_record_options.rb +357 -0
- data/lib/mailslurp_client/models/generate_spf_record_results.rb +318 -0
- data/lib/mailslurp_client/models/get_or_create_phone_pool_options.rb +220 -0
- data/lib/mailslurp_client/models/group_projection.rb +15 -15
- data/lib/mailslurp_client/models/guest_portal_user_projection.rb +50 -50
- data/lib/mailslurp_client/models/imap_email_projection.rb +18 -18
- data/lib/mailslurp_client/models/inbox_dto.rb +2 -2
- data/lib/mailslurp_client/models/inbox_forwarder_event_projection.rb +21 -21
- data/lib/mailslurp_client/models/inbox_preview.rb +2 -2
- data/lib/mailslurp_client/models/inbox_replier_event_projection.rb +33 -33
- data/lib/mailslurp_client/models/list_unsubscribe_recipient_projection.rb +19 -19
- data/lib/mailslurp_client/models/lookup_dkim_domain_options.rb +275 -0
- data/lib/mailslurp_client/models/lookup_dkim_domain_results.rb +304 -0
- data/lib/mailslurp_client/models/lookup_ptr_options.rb +241 -0
- data/lib/mailslurp_client/models/lookup_ptr_results.rb +305 -0
- data/lib/mailslurp_client/models/lookup_spf_domain_options.rb +240 -0
- data/lib/mailslurp_client/models/lookup_spf_domain_results.rb +305 -0
- data/lib/mailslurp_client/models/missed_email_projection.rb +28 -28
- data/lib/mailslurp_client/models/missed_sms_dto.rb +320 -0
- data/lib/mailslurp_client/models/missed_sms_projection.rb +282 -0
- data/lib/mailslurp_client/models/opt_in_identity_projection.rb +24 -24
- data/lib/mailslurp_client/models/organization_inbox_projection.rb +2 -2
- data/lib/mailslurp_client/models/page_ai_transform_mapping_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_ai_transform_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_ai_transform_result_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_alias.rb +19 -19
- data/lib/mailslurp_client/models/page_alias_thread_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_attachment_entity.rb +19 -19
- data/lib/mailslurp_client/models/page_bounced_email.rb +19 -19
- data/lib/mailslurp_client/models/page_bounced_recipients.rb +19 -19
- data/lib/mailslurp_client/models/page_complaint.rb +19 -19
- data/lib/mailslurp_client/models/page_connector.rb +19 -19
- data/lib/mailslurp_client/models/page_connector_events.rb +19 -19
- data/lib/mailslurp_client/models/page_contact_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_delivery_status.rb +19 -19
- data/lib/mailslurp_client/models/page_device_preview_run_projection.rb +309 -0
- data/lib/mailslurp_client/models/page_email_preview.rb +19 -19
- data/lib/mailslurp_client/models/page_email_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_email_thread_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_email_validation_request.rb +19 -19
- data/lib/mailslurp_client/models/page_entity_automation_items.rb +19 -19
- data/lib/mailslurp_client/models/page_entity_event_items.rb +19 -19
- data/lib/mailslurp_client/models/page_entity_favourite_items.rb +19 -19
- data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_group_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_guest_portal_users.rb +19 -19
- data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +19 -19
- data/lib/mailslurp_client/models/page_inbox_forwarder_events.rb +19 -19
- data/lib/mailslurp_client/models/page_inbox_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_inbox_replier_dto.rb +19 -19
- data/lib/mailslurp_client/models/page_inbox_replier_events.rb +19 -19
- data/lib/mailslurp_client/models/page_inbox_tags.rb +19 -19
- data/lib/mailslurp_client/models/page_list_unsubscribe_recipients.rb +19 -19
- data/lib/mailslurp_client/models/page_missed_email_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_missed_sms_projection.rb +309 -0
- data/lib/mailslurp_client/models/page_opt_in_identity_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_phone_message_thread_item_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_phone_message_thread_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_phone_number_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_phone_number_release_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_plus_address_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_reputation_items.rb +19 -19
- data/lib/mailslurp_client/models/page_ruleset_dto.rb +19 -19
- data/lib/mailslurp_client/models/page_scheduled_jobs.rb +19 -19
- data/lib/mailslurp_client/models/page_sent_email_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_sent_email_with_queue_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_sent_sms_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_sms_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_template_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_webhook_endpoint_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_webhook_projection.rb +19 -19
- data/lib/mailslurp_client/models/page_webhook_result.rb +19 -19
- data/lib/mailslurp_client/models/pageable_object.rb +22 -22
- data/lib/mailslurp_client/models/phone_message_thread_item_projection.rb +18 -18
- data/lib/mailslurp_client/models/phone_number_dto.rb +49 -4
- data/lib/mailslurp_client/models/phone_number_line_type_intelligence_dto.rb +242 -0
- data/lib/mailslurp_client/models/phone_number_line_type_lookup_dto.rb +286 -0
- data/lib/mailslurp_client/models/phone_number_projection.rb +81 -36
- data/lib/mailslurp_client/models/phone_number_release_projection.rb +39 -39
- data/lib/mailslurp_client/models/phone_pool_detail_dto.rb +334 -0
- data/lib/mailslurp_client/models/phone_pool_dto.rb +318 -0
- data/lib/mailslurp_client/models/phone_pool_lease_dto.rb +351 -0
- data/lib/mailslurp_client/models/phone_pool_member_dto.rb +333 -0
- data/lib/mailslurp_client/models/phone_provider_capabilities_result.rb +284 -0
- data/lib/mailslurp_client/models/phone_provisioning_job_dto.rb +434 -0
- data/lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb +336 -0
- data/lib/mailslurp_client/models/phone_sms_prepaid_credit_dto.rb +340 -0
- data/lib/mailslurp_client/models/phone_sms_prepaid_credits_dto.rb +241 -0
- data/lib/mailslurp_client/models/plus_address_projection.rb +32 -32
- data/lib/mailslurp_client/models/recipient_projection.rb +13 -13
- data/lib/mailslurp_client/models/reputation_item_projection.rb +41 -41
- data/lib/mailslurp_client/models/search_available_phone_numbers_options.rb +377 -0
- data/lib/mailslurp_client/models/search_inboxes_options.rb +1 -1
- data/lib/mailslurp_client/models/sender_projection.rb +13 -13
- data/lib/mailslurp_client/models/sent_email_projection.rb +50 -50
- data/lib/mailslurp_client/models/sent_sms_projection.rb +18 -18
- data/lib/mailslurp_client/models/sms_projection.rb +18 -18
- data/lib/mailslurp_client/models/smtp_auth_diagnostic_result.rb +235 -0
- data/lib/mailslurp_client/models/smtp_diagnostic_step.rb +236 -0
- data/lib/mailslurp_client/models/smtp_tls_diagnostic_result.rb +245 -0
- data/lib/mailslurp_client/models/sort_object.rb +10 -10
- data/lib/mailslurp_client/models/spf_mechanism_result.rb +229 -0
- data/lib/mailslurp_client/models/template_projection.rb +41 -41
- data/lib/mailslurp_client/models/tenant_reputation_finding_dto.rb +322 -0
- data/lib/mailslurp_client/models/tenant_reputation_findings_dto.rb +241 -0
- data/lib/mailslurp_client/models/tenant_reputation_status_row_dto.rb +372 -0
- data/lib/mailslurp_client/models/tenant_reputation_status_summary_dto.rb +241 -0
- data/lib/mailslurp_client/models/test_smtp_server_options.rb +337 -0
- data/lib/mailslurp_client/models/test_smtp_server_results.rb +297 -0
- data/lib/mailslurp_client/models/tracking_pixel_projection.rb +27 -27
- data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +27 -27
- data/lib/mailslurp_client/models/update_campaign_probe_options.rb +290 -0
- data/lib/mailslurp_client/models/update_deliverability_test_options.rb +327 -0
- data/lib/mailslurp_client/models/update_device_preview_feedback_options.rb +314 -0
- data/lib/mailslurp_client/models/update_domain_monitor_options.rb +266 -0
- data/lib/mailslurp_client/models/update_phone_pool_options.rb +215 -0
- data/lib/mailslurp_client/models/validation_dto.rb +1 -5
- data/lib/mailslurp_client/models/webhook_projection.rb +39 -39
- data/lib/mailslurp_client/version.rb +1 -1
- data/lib/mailslurp_client.rb +156 -0
- metadata +158 -2
|
@@ -20,7 +20,7 @@ module MailSlurpClient
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Set IMAP flags associated with a message. Only supports '\\Seen' flag.
|
|
23
|
-
#
|
|
23
|
+
# Applies RFC3501 IMAP flag operations on a message. Current implementation supports read/unread semantics via the `\\\\Seen` flag only.
|
|
24
24
|
# @param email_id [String]
|
|
25
25
|
# @param imap_flag_operation_options [ImapFlagOperationOptions]
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
@@ -31,7 +31,7 @@ module MailSlurpClient
|
|
|
31
31
|
end
|
|
32
32
|
|
|
33
33
|
# Set IMAP flags associated with a message. Only supports '\\Seen' flag.
|
|
34
|
-
#
|
|
34
|
+
# Applies RFC3501 IMAP flag operations on a message. Current implementation supports read/unread semantics via the `\\\\Seen` flag only.
|
|
35
35
|
# @param email_id [String]
|
|
36
36
|
# @param imap_flag_operation_options [ImapFlagOperationOptions]
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
@@ -89,8 +89,8 @@ module MailSlurpClient
|
|
|
89
89
|
return data, status_code, headers
|
|
90
90
|
end
|
|
91
91
|
|
|
92
|
-
# Check
|
|
93
|
-
#
|
|
92
|
+
# Check whether an email send would be accepted
|
|
93
|
+
# Validates sender/inbox context and recipient eligibility before attempting a send. Useful for preflight checks in UI or test workflows.
|
|
94
94
|
# @param inbox_id [String] ID of the inbox you want to send the email from
|
|
95
95
|
# @param send_email_options [SendEmailOptions]
|
|
96
96
|
# @param [Hash] opts the optional parameters
|
|
@@ -100,8 +100,8 @@ module MailSlurpClient
|
|
|
100
100
|
data
|
|
101
101
|
end
|
|
102
102
|
|
|
103
|
-
# Check
|
|
104
|
-
#
|
|
103
|
+
# Check whether an email send would be accepted
|
|
104
|
+
# Validates sender/inbox context and recipient eligibility before attempting a send. Useful for preflight checks in UI or test workflows.
|
|
105
105
|
# @param inbox_id [String] ID of the inbox you want to send the email from
|
|
106
106
|
# @param send_email_options [SendEmailOptions]
|
|
107
107
|
# @param [Hash] opts the optional parameters
|
|
@@ -160,8 +160,70 @@ module MailSlurpClient
|
|
|
160
160
|
return data, status_code, headers
|
|
161
161
|
end
|
|
162
162
|
|
|
163
|
-
#
|
|
164
|
-
#
|
|
163
|
+
# Run aggregate email audit for a stored email
|
|
164
|
+
# Runs the same message-level audit bundle used by the email audit dashboard in one request. Combines content checks, HTML validation, compatibility analysis, and reputation verdict rollup when available.
|
|
165
|
+
# @param email_id [String]
|
|
166
|
+
# @param [Hash] opts the optional parameters
|
|
167
|
+
# @return [EmailAuditAnalysisResult]
|
|
168
|
+
def check_email_audit1(email_id, opts = {})
|
|
169
|
+
data, _status_code, _headers = check_email_audit1_with_http_info(email_id, opts)
|
|
170
|
+
data
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
# Run aggregate email audit for a stored email
|
|
174
|
+
# Runs the same message-level audit bundle used by the email audit dashboard in one request. Combines content checks, HTML validation, compatibility analysis, and reputation verdict rollup when available.
|
|
175
|
+
# @param email_id [String]
|
|
176
|
+
# @param [Hash] opts the optional parameters
|
|
177
|
+
# @return [Array<(EmailAuditAnalysisResult, Integer, Hash)>] EmailAuditAnalysisResult data, response status code and response headers
|
|
178
|
+
def check_email_audit1_with_http_info(email_id, opts = {})
|
|
179
|
+
if @api_client.config.debugging
|
|
180
|
+
@api_client.config.logger.debug 'Calling API: EmailControllerApi.check_email_audit1 ...'
|
|
181
|
+
end
|
|
182
|
+
# verify the required parameter 'email_id' is set
|
|
183
|
+
if @api_client.config.client_side_validation && email_id.nil?
|
|
184
|
+
fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.check_email_audit1"
|
|
185
|
+
end
|
|
186
|
+
# resource path
|
|
187
|
+
local_var_path = '/emails/{emailId}/check-email-audit'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
|
|
188
|
+
|
|
189
|
+
# query parameters
|
|
190
|
+
query_params = opts[:query_params] || {}
|
|
191
|
+
|
|
192
|
+
# header parameters
|
|
193
|
+
header_params = opts[:header_params] || {}
|
|
194
|
+
# HTTP header 'Accept' (if needed)
|
|
195
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
|
196
|
+
|
|
197
|
+
# form parameters
|
|
198
|
+
form_params = opts[:form_params] || {}
|
|
199
|
+
|
|
200
|
+
# http body (model)
|
|
201
|
+
post_body = opts[:body]
|
|
202
|
+
|
|
203
|
+
# return_type
|
|
204
|
+
return_type = opts[:return_type] || 'EmailAuditAnalysisResult'
|
|
205
|
+
|
|
206
|
+
# auth_names
|
|
207
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
|
208
|
+
|
|
209
|
+
new_options = opts.merge(
|
|
210
|
+
:header_params => header_params,
|
|
211
|
+
:query_params => query_params,
|
|
212
|
+
:form_params => form_params,
|
|
213
|
+
:body => post_body,
|
|
214
|
+
:auth_names => auth_names,
|
|
215
|
+
:return_type => return_type
|
|
216
|
+
)
|
|
217
|
+
|
|
218
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
219
|
+
if @api_client.config.debugging
|
|
220
|
+
@api_client.config.logger.debug "API called: EmailControllerApi#check_email_audit1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
221
|
+
end
|
|
222
|
+
return data, status_code, headers
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
# Check email body for broken links, images, and spelling issues
|
|
226
|
+
# Runs content quality checks against hydrated email body content. This endpoint performs outbound HTTP checks for linked resources, so avoid use with sensitive or stateful URLs.
|
|
165
227
|
# @param email_id [String]
|
|
166
228
|
# @param [Hash] opts the optional parameters
|
|
167
229
|
# @return [CheckEmailBodyResults]
|
|
@@ -170,8 +232,8 @@ module MailSlurpClient
|
|
|
170
232
|
data
|
|
171
233
|
end
|
|
172
234
|
|
|
173
|
-
#
|
|
174
|
-
#
|
|
235
|
+
# Check email body for broken links, images, and spelling issues
|
|
236
|
+
# Runs content quality checks against hydrated email body content. This endpoint performs outbound HTTP checks for linked resources, so avoid use with sensitive or stateful URLs.
|
|
175
237
|
# @param email_id [String]
|
|
176
238
|
# @param [Hash] opts the optional parameters
|
|
177
239
|
# @return [Array<(CheckEmailBodyResults, Integer, Hash)>] CheckEmailBodyResults data, response status code and response headers
|
|
@@ -222,8 +284,8 @@ module MailSlurpClient
|
|
|
222
284
|
return data, status_code, headers
|
|
223
285
|
end
|
|
224
286
|
|
|
225
|
-
#
|
|
226
|
-
#
|
|
287
|
+
# Check client support for features used in a stored email body
|
|
288
|
+
# Detects HTML/CSS features in the target email body and reports compatibility across major email clients and devices.
|
|
227
289
|
# @param email_id [String]
|
|
228
290
|
# @param [Hash] opts the optional parameters
|
|
229
291
|
# @return [CheckEmailBodyFeatureSupportResults]
|
|
@@ -232,8 +294,8 @@ module MailSlurpClient
|
|
|
232
294
|
data
|
|
233
295
|
end
|
|
234
296
|
|
|
235
|
-
#
|
|
236
|
-
#
|
|
297
|
+
# Check client support for features used in a stored email body
|
|
298
|
+
# Detects HTML/CSS features in the target email body and reports compatibility across major email clients and devices.
|
|
237
299
|
# @param email_id [String]
|
|
238
300
|
# @param [Hash] opts the optional parameters
|
|
239
301
|
# @return [Array<(CheckEmailBodyFeatureSupportResults, Integer, Hash)>] CheckEmailBodyFeatureSupportResults data, response status code and response headers
|
|
@@ -284,8 +346,8 @@ module MailSlurpClient
|
|
|
284
346
|
return data, status_code, headers
|
|
285
347
|
end
|
|
286
348
|
|
|
287
|
-
#
|
|
288
|
-
#
|
|
349
|
+
# Check email-client support for a provided HTML body
|
|
350
|
+
# Evaluates HTML/CSS features in the supplied body and reports support coverage across major email clients and platforms.
|
|
289
351
|
# @param check_email_client_support_options [CheckEmailClientSupportOptions]
|
|
290
352
|
# @param [Hash] opts the optional parameters
|
|
291
353
|
# @return [CheckEmailClientSupportResults]
|
|
@@ -294,8 +356,8 @@ module MailSlurpClient
|
|
|
294
356
|
data
|
|
295
357
|
end
|
|
296
358
|
|
|
297
|
-
#
|
|
298
|
-
#
|
|
359
|
+
# Check email-client support for a provided HTML body
|
|
360
|
+
# Evaluates HTML/CSS features in the supplied body and reports support coverage across major email clients and platforms.
|
|
299
361
|
# @param check_email_client_support_options [CheckEmailClientSupportOptions]
|
|
300
362
|
# @param [Hash] opts the optional parameters
|
|
301
363
|
# @return [Array<(CheckEmailClientSupportResults, Integer, Hash)>] CheckEmailClientSupportResults data, response status code and response headers
|
|
@@ -348,8 +410,70 @@ module MailSlurpClient
|
|
|
348
410
|
return data, status_code, headers
|
|
349
411
|
end
|
|
350
412
|
|
|
413
|
+
# Persist aggregate email audit for a stored email
|
|
414
|
+
# Runs the aggregate audit bundle for the target email and stores the resulting audit record for later review and history tracking.
|
|
415
|
+
# @param email_id [String]
|
|
416
|
+
# @param [Hash] opts the optional parameters
|
|
417
|
+
# @return [EmailAuditDto]
|
|
418
|
+
def create_email_audit_for_email(email_id, opts = {})
|
|
419
|
+
data, _status_code, _headers = create_email_audit_for_email_with_http_info(email_id, opts)
|
|
420
|
+
data
|
|
421
|
+
end
|
|
422
|
+
|
|
423
|
+
# Persist aggregate email audit for a stored email
|
|
424
|
+
# Runs the aggregate audit bundle for the target email and stores the resulting audit record for later review and history tracking.
|
|
425
|
+
# @param email_id [String]
|
|
426
|
+
# @param [Hash] opts the optional parameters
|
|
427
|
+
# @return [Array<(EmailAuditDto, Integer, Hash)>] EmailAuditDto data, response status code and response headers
|
|
428
|
+
def create_email_audit_for_email_with_http_info(email_id, opts = {})
|
|
429
|
+
if @api_client.config.debugging
|
|
430
|
+
@api_client.config.logger.debug 'Calling API: EmailControllerApi.create_email_audit_for_email ...'
|
|
431
|
+
end
|
|
432
|
+
# verify the required parameter 'email_id' is set
|
|
433
|
+
if @api_client.config.client_side_validation && email_id.nil?
|
|
434
|
+
fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.create_email_audit_for_email"
|
|
435
|
+
end
|
|
436
|
+
# resource path
|
|
437
|
+
local_var_path = '/emails/{emailId}/audit'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
|
|
438
|
+
|
|
439
|
+
# query parameters
|
|
440
|
+
query_params = opts[:query_params] || {}
|
|
441
|
+
|
|
442
|
+
# header parameters
|
|
443
|
+
header_params = opts[:header_params] || {}
|
|
444
|
+
# HTTP header 'Accept' (if needed)
|
|
445
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
|
446
|
+
|
|
447
|
+
# form parameters
|
|
448
|
+
form_params = opts[:form_params] || {}
|
|
449
|
+
|
|
450
|
+
# http body (model)
|
|
451
|
+
post_body = opts[:body]
|
|
452
|
+
|
|
453
|
+
# return_type
|
|
454
|
+
return_type = opts[:return_type] || 'EmailAuditDto'
|
|
455
|
+
|
|
456
|
+
# auth_names
|
|
457
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
|
458
|
+
|
|
459
|
+
new_options = opts.merge(
|
|
460
|
+
:header_params => header_params,
|
|
461
|
+
:query_params => query_params,
|
|
462
|
+
:form_params => form_params,
|
|
463
|
+
:body => post_body,
|
|
464
|
+
:auth_names => auth_names,
|
|
465
|
+
:return_type => return_type
|
|
466
|
+
)
|
|
467
|
+
|
|
468
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
469
|
+
if @api_client.config.debugging
|
|
470
|
+
@api_client.config.logger.debug "API called: EmailControllerApi#create_email_audit_for_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
471
|
+
end
|
|
472
|
+
return data, status_code, headers
|
|
473
|
+
end
|
|
474
|
+
|
|
351
475
|
# Delete all emails in all inboxes.
|
|
352
|
-
# Deletes all emails
|
|
476
|
+
# Deletes all emails for the authenticated account context. This operation is destructive and cannot be undone.
|
|
353
477
|
# @param [Hash] opts the optional parameters
|
|
354
478
|
# @return [nil]
|
|
355
479
|
def delete_all_emails(opts = {})
|
|
@@ -358,7 +482,7 @@ module MailSlurpClient
|
|
|
358
482
|
end
|
|
359
483
|
|
|
360
484
|
# Delete all emails in all inboxes.
|
|
361
|
-
# Deletes all emails
|
|
485
|
+
# Deletes all emails for the authenticated account context. This operation is destructive and cannot be undone.
|
|
362
486
|
# @param [Hash] opts the optional parameters
|
|
363
487
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
364
488
|
def delete_all_emails_with_http_info(opts = {})
|
|
@@ -403,7 +527,7 @@ module MailSlurpClient
|
|
|
403
527
|
end
|
|
404
528
|
|
|
405
529
|
# Delete an email
|
|
406
|
-
# Deletes
|
|
530
|
+
# Deletes a single email from account scope. Operation is destructive and not reversible.
|
|
407
531
|
# @param email_id [String] ID of email to delete
|
|
408
532
|
# @param [Hash] opts the optional parameters
|
|
409
533
|
# @return [nil]
|
|
@@ -413,7 +537,7 @@ module MailSlurpClient
|
|
|
413
537
|
end
|
|
414
538
|
|
|
415
539
|
# Delete an email
|
|
416
|
-
# Deletes
|
|
540
|
+
# Deletes a single email from account scope. Operation is destructive and not reversible.
|
|
417
541
|
# @param email_id [String] ID of email to delete
|
|
418
542
|
# @param [Hash] opts the optional parameters
|
|
419
543
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
@@ -463,7 +587,7 @@ module MailSlurpClient
|
|
|
463
587
|
end
|
|
464
588
|
|
|
465
589
|
# Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string.
|
|
466
|
-
# Returns
|
|
590
|
+
# Returns attachment bytes by attachment ID. Use attachment IDs from email payloads or attachment listing endpoints.
|
|
467
591
|
# @param email_id [String] ID of email
|
|
468
592
|
# @param attachment_id [String] ID of attachment
|
|
469
593
|
# @param [Hash] opts the optional parameters
|
|
@@ -475,7 +599,7 @@ module MailSlurpClient
|
|
|
475
599
|
end
|
|
476
600
|
|
|
477
601
|
# Get email attachment bytes. Returned as `octet-stream` with content type header. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints and convert the base 64 encoded content to a file or string.
|
|
478
|
-
# Returns
|
|
602
|
+
# Returns attachment bytes by attachment ID. Use attachment IDs from email payloads or attachment listing endpoints.
|
|
479
603
|
# @param email_id [String] ID of email
|
|
480
604
|
# @param attachment_id [String] ID of attachment
|
|
481
605
|
# @param [Hash] opts the optional parameters
|
|
@@ -534,7 +658,7 @@ module MailSlurpClient
|
|
|
534
658
|
end
|
|
535
659
|
|
|
536
660
|
# Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
|
|
537
|
-
# Returns
|
|
661
|
+
# Returns attachment payload as base64 in JSON. Useful for clients that cannot reliably consume binary streaming responses.
|
|
538
662
|
# @param email_id [String] ID of email
|
|
539
663
|
# @param attachment_id [String] ID of attachment
|
|
540
664
|
# @param [Hash] opts the optional parameters
|
|
@@ -545,7 +669,7 @@ module MailSlurpClient
|
|
|
545
669
|
end
|
|
546
670
|
|
|
547
671
|
# Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
|
|
548
|
-
# Returns
|
|
672
|
+
# Returns attachment payload as base64 in JSON. Useful for clients that cannot reliably consume binary streaming responses.
|
|
549
673
|
# @param email_id [String] ID of email
|
|
550
674
|
# @param attachment_id [String] ID of attachment
|
|
551
675
|
# @param [Hash] opts the optional parameters
|
|
@@ -602,7 +726,7 @@ module MailSlurpClient
|
|
|
602
726
|
end
|
|
603
727
|
|
|
604
728
|
# Get email body as string. Returned as `plain/text` with content type header.
|
|
605
|
-
# Returns
|
|
729
|
+
# Returns hydrated email body text as a string with content type aligned to the underlying body format.
|
|
606
730
|
# @param email_id [String] ID of email
|
|
607
731
|
# @param [Hash] opts the optional parameters
|
|
608
732
|
# @return [String]
|
|
@@ -612,7 +736,7 @@ module MailSlurpClient
|
|
|
612
736
|
end
|
|
613
737
|
|
|
614
738
|
# Get email body as string. Returned as `plain/text` with content type header.
|
|
615
|
-
# Returns
|
|
739
|
+
# Returns hydrated email body text as a string with content type aligned to the underlying body format.
|
|
616
740
|
# @param email_id [String] ID of email
|
|
617
741
|
# @param [Hash] opts the optional parameters
|
|
618
742
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
@@ -664,7 +788,7 @@ module MailSlurpClient
|
|
|
664
788
|
end
|
|
665
789
|
|
|
666
790
|
# Get email body in bytes. Returned as `octet-stream` with content type header.
|
|
667
|
-
#
|
|
791
|
+
# Streams hydrated email body bytes with content type derived from the message body format.
|
|
668
792
|
# @param email_id [String] ID of email
|
|
669
793
|
# @param [Hash] opts the optional parameters
|
|
670
794
|
# @return [String]
|
|
@@ -674,7 +798,7 @@ module MailSlurpClient
|
|
|
674
798
|
end
|
|
675
799
|
|
|
676
800
|
# Get email body in bytes. Returned as `octet-stream` with content type header.
|
|
677
|
-
#
|
|
801
|
+
# Streams hydrated email body bytes with content type derived from the message body format.
|
|
678
802
|
# @param email_id [String] ID of email
|
|
679
803
|
# @param [Hash] opts the optional parameters
|
|
680
804
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
@@ -726,7 +850,7 @@ module MailSlurpClient
|
|
|
726
850
|
end
|
|
727
851
|
|
|
728
852
|
# Forward email to recipients
|
|
729
|
-
#
|
|
853
|
+
# Forwards an existing email to new recipients. Uses the owning inbox context unless overridden by allowed sender options.
|
|
730
854
|
# @param email_id [String] ID of email
|
|
731
855
|
# @param forward_email_options [ForwardEmailOptions]
|
|
732
856
|
# @param [Hash] opts the optional parameters
|
|
@@ -737,7 +861,7 @@ module MailSlurpClient
|
|
|
737
861
|
end
|
|
738
862
|
|
|
739
863
|
# Forward email to recipients
|
|
740
|
-
#
|
|
864
|
+
# Forwards an existing email to new recipients. Uses the owning inbox context unless overridden by allowed sender options.
|
|
741
865
|
# @param email_id [String] ID of email
|
|
742
866
|
# @param forward_email_options [ForwardEmailOptions]
|
|
743
867
|
# @param [Hash] opts the optional parameters
|
|
@@ -796,7 +920,7 @@ module MailSlurpClient
|
|
|
796
920
|
end
|
|
797
921
|
|
|
798
922
|
# Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods.
|
|
799
|
-
# Returns
|
|
923
|
+
# Returns metadata for a specific attachment ID (name, content type, and size fields).
|
|
800
924
|
# @param email_id [String] ID of email
|
|
801
925
|
# @param attachment_id [String] ID of attachment
|
|
802
926
|
# @param [Hash] opts the optional parameters
|
|
@@ -807,7 +931,7 @@ module MailSlurpClient
|
|
|
807
931
|
end
|
|
808
932
|
|
|
809
933
|
# Get email attachment metadata. This is the `contentType` and `contentLength` of an attachment. To get the individual attachments use the `downloadAttachment` methods.
|
|
810
|
-
# Returns
|
|
934
|
+
# Returns metadata for a specific attachment ID (name, content type, and size fields).
|
|
811
935
|
# @param email_id [String] ID of email
|
|
812
936
|
# @param attachment_id [String] ID of attachment
|
|
813
937
|
# @param [Hash] opts the optional parameters
|
|
@@ -863,8 +987,8 @@ module MailSlurpClient
|
|
|
863
987
|
return data, status_code, headers
|
|
864
988
|
end
|
|
865
989
|
|
|
866
|
-
# Get email
|
|
867
|
-
# Returns
|
|
990
|
+
# Get hydrated email (headers and body)
|
|
991
|
+
# Returns parsed email content including headers and body fields. Accessing hydrated content may mark the email as read depending on read-state rules.
|
|
868
992
|
# @param email_id [String]
|
|
869
993
|
# @param [Hash] opts the optional parameters
|
|
870
994
|
# @return [Email]
|
|
@@ -873,8 +997,8 @@ module MailSlurpClient
|
|
|
873
997
|
data
|
|
874
998
|
end
|
|
875
999
|
|
|
876
|
-
# Get email
|
|
877
|
-
# Returns
|
|
1000
|
+
# Get hydrated email (headers and body)
|
|
1001
|
+
# Returns parsed email content including headers and body fields. Accessing hydrated content may mark the email as read depending on read-state rules.
|
|
878
1002
|
# @param email_id [String]
|
|
879
1003
|
# @param [Hash] opts the optional parameters
|
|
880
1004
|
# @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
|
|
@@ -925,8 +1049,8 @@ module MailSlurpClient
|
|
|
925
1049
|
return data, status_code, headers
|
|
926
1050
|
end
|
|
927
1051
|
|
|
928
|
-
#
|
|
929
|
-
# Returns
|
|
1052
|
+
# List attachment metadata for an email
|
|
1053
|
+
# Returns metadata for all attachment IDs associated with the email (name, content type, size, and IDs).
|
|
930
1054
|
# @param email_id [String] ID of email
|
|
931
1055
|
# @param [Hash] opts the optional parameters
|
|
932
1056
|
# @return [Array<AttachmentMetaData>]
|
|
@@ -935,8 +1059,8 @@ module MailSlurpClient
|
|
|
935
1059
|
data
|
|
936
1060
|
end
|
|
937
1061
|
|
|
938
|
-
#
|
|
939
|
-
# Returns
|
|
1062
|
+
# List attachment metadata for an email
|
|
1063
|
+
# Returns metadata for all attachment IDs associated with the email (name, content type, size, and IDs).
|
|
940
1064
|
# @param email_id [String] ID of email
|
|
941
1065
|
# @param [Hash] opts the optional parameters
|
|
942
1066
|
# @return [Array<(Array<AttachmentMetaData>, Integer, Hash)>] Array<AttachmentMetaData> data, response status code and response headers
|
|
@@ -987,8 +1111,74 @@ module MailSlurpClient
|
|
|
987
1111
|
return data, status_code, headers
|
|
988
1112
|
end
|
|
989
1113
|
|
|
990
|
-
#
|
|
991
|
-
#
|
|
1114
|
+
# Extract verification codes from an email
|
|
1115
|
+
# Extracts one-time passcodes and similar tokens from email content. Supports deterministic extraction now with method/fallback flags (`AUTO`, `PATTERN`, `LLM`, `OCR`, `OCR_THEN_LLM`) for QA and future advanced pipelines.
|
|
1116
|
+
# @param email_id [String] ID of email to extract codes from
|
|
1117
|
+
# @param [Hash] opts the optional parameters
|
|
1118
|
+
# @option opts [ExtractCodesOptions] :extract_codes_options
|
|
1119
|
+
# @return [ExtractCodesResult]
|
|
1120
|
+
def get_email_codes(email_id, opts = {})
|
|
1121
|
+
data, _status_code, _headers = get_email_codes_with_http_info(email_id, opts)
|
|
1122
|
+
data
|
|
1123
|
+
end
|
|
1124
|
+
|
|
1125
|
+
# Extract verification codes from an email
|
|
1126
|
+
# Extracts one-time passcodes and similar tokens from email content. Supports deterministic extraction now with method/fallback flags (`AUTO`, `PATTERN`, `LLM`, `OCR`, `OCR_THEN_LLM`) for QA and future advanced pipelines.
|
|
1127
|
+
# @param email_id [String] ID of email to extract codes from
|
|
1128
|
+
# @param [Hash] opts the optional parameters
|
|
1129
|
+
# @option opts [ExtractCodesOptions] :extract_codes_options
|
|
1130
|
+
# @return [Array<(ExtractCodesResult, Integer, Hash)>] ExtractCodesResult data, response status code and response headers
|
|
1131
|
+
def get_email_codes_with_http_info(email_id, opts = {})
|
|
1132
|
+
if @api_client.config.debugging
|
|
1133
|
+
@api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_codes ...'
|
|
1134
|
+
end
|
|
1135
|
+
# verify the required parameter 'email_id' is set
|
|
1136
|
+
if @api_client.config.client_side_validation && email_id.nil?
|
|
1137
|
+
fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_codes"
|
|
1138
|
+
end
|
|
1139
|
+
# resource path
|
|
1140
|
+
local_var_path = '/emails/{emailId}/codes'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
|
|
1141
|
+
|
|
1142
|
+
# query parameters
|
|
1143
|
+
query_params = opts[:query_params] || {}
|
|
1144
|
+
|
|
1145
|
+
# header parameters
|
|
1146
|
+
header_params = opts[:header_params] || {}
|
|
1147
|
+
# HTTP header 'Accept' (if needed)
|
|
1148
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
|
1149
|
+
# HTTP header 'Content-Type'
|
|
1150
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1151
|
+
|
|
1152
|
+
# form parameters
|
|
1153
|
+
form_params = opts[:form_params] || {}
|
|
1154
|
+
|
|
1155
|
+
# http body (model)
|
|
1156
|
+
post_body = opts[:body] || @api_client.object_to_http_body(opts[:'extract_codes_options'])
|
|
1157
|
+
|
|
1158
|
+
# return_type
|
|
1159
|
+
return_type = opts[:return_type] || 'ExtractCodesResult'
|
|
1160
|
+
|
|
1161
|
+
# auth_names
|
|
1162
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
|
1163
|
+
|
|
1164
|
+
new_options = opts.merge(
|
|
1165
|
+
:header_params => header_params,
|
|
1166
|
+
:query_params => query_params,
|
|
1167
|
+
:form_params => form_params,
|
|
1168
|
+
:body => post_body,
|
|
1169
|
+
:auth_names => auth_names,
|
|
1170
|
+
:return_type => return_type
|
|
1171
|
+
)
|
|
1172
|
+
|
|
1173
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1174
|
+
if @api_client.config.debugging
|
|
1175
|
+
@api_client.config.logger.debug "API called: EmailControllerApi#get_email_codes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1176
|
+
end
|
|
1177
|
+
return data, status_code, headers
|
|
1178
|
+
end
|
|
1179
|
+
|
|
1180
|
+
# Run regex against hydrated email body and return matches
|
|
1181
|
+
# Executes a Java regex pattern over hydrated email body text and returns the full match plus capture groups. Pattern syntax follows Java `Pattern` rules.
|
|
992
1182
|
# @param email_id [String] ID of email to match against
|
|
993
1183
|
# @param content_match_options [ContentMatchOptions]
|
|
994
1184
|
# @param [Hash] opts the optional parameters
|
|
@@ -998,8 +1188,8 @@ module MailSlurpClient
|
|
|
998
1188
|
data
|
|
999
1189
|
end
|
|
1000
1190
|
|
|
1001
|
-
#
|
|
1002
|
-
#
|
|
1191
|
+
# Run regex against hydrated email body and return matches
|
|
1192
|
+
# Executes a Java regex pattern over hydrated email body text and returns the full match plus capture groups. Pattern syntax follows Java `Pattern` rules.
|
|
1003
1193
|
# @param email_id [String] ID of email to match against
|
|
1004
1194
|
# @param content_match_options [ContentMatchOptions]
|
|
1005
1195
|
# @param [Hash] opts the optional parameters
|
|
@@ -1058,7 +1248,7 @@ module MailSlurpClient
|
|
|
1058
1248
|
end
|
|
1059
1249
|
|
|
1060
1250
|
# Get email content part by content type
|
|
1061
|
-
#
|
|
1251
|
+
# Extracts one MIME body part by `contentType` and optional `index`, returned in a structured DTO with metadata.
|
|
1062
1252
|
# @param email_id [String] ID of email to match against
|
|
1063
1253
|
# @param content_type [String] Content type
|
|
1064
1254
|
# @param [Hash] opts the optional parameters
|
|
@@ -1071,7 +1261,7 @@ module MailSlurpClient
|
|
|
1071
1261
|
end
|
|
1072
1262
|
|
|
1073
1263
|
# Get email content part by content type
|
|
1074
|
-
#
|
|
1264
|
+
# Extracts one MIME body part by `contentType` and optional `index`, returned in a structured DTO with metadata.
|
|
1075
1265
|
# @param email_id [String] ID of email to match against
|
|
1076
1266
|
# @param content_type [String] Content type
|
|
1077
1267
|
# @param [Hash] opts the optional parameters
|
|
@@ -1132,8 +1322,8 @@ module MailSlurpClient
|
|
|
1132
1322
|
return data, status_code, headers
|
|
1133
1323
|
end
|
|
1134
1324
|
|
|
1135
|
-
# Get
|
|
1136
|
-
#
|
|
1325
|
+
# Get multipart content part as raw response
|
|
1326
|
+
# Extracts one MIME body part by `contentType` and optional `index`, and returns raw content with matching response content type when valid.
|
|
1137
1327
|
# @param email_id [String] ID of email to match against
|
|
1138
1328
|
# @param content_type [String] Content type
|
|
1139
1329
|
# @param [Hash] opts the optional parameters
|
|
@@ -1145,8 +1335,8 @@ module MailSlurpClient
|
|
|
1145
1335
|
data
|
|
1146
1336
|
end
|
|
1147
1337
|
|
|
1148
|
-
# Get
|
|
1149
|
-
#
|
|
1338
|
+
# Get multipart content part as raw response
|
|
1339
|
+
# Extracts one MIME body part by `contentType` and optional `index`, and returns raw content with matching response content type when valid.
|
|
1150
1340
|
# @param email_id [String] ID of email to match against
|
|
1151
1341
|
# @param content_type [String] Content type
|
|
1152
1342
|
# @param [Hash] opts the optional parameters
|
|
@@ -1208,6 +1398,7 @@ module MailSlurpClient
|
|
|
1208
1398
|
end
|
|
1209
1399
|
|
|
1210
1400
|
# Get email count
|
|
1401
|
+
# Returns total email count for the authenticated user, or count scoped to a specific inbox when `inboxId` is provided.
|
|
1211
1402
|
# @param [Hash] opts the optional parameters
|
|
1212
1403
|
# @option opts [String] :inbox_id
|
|
1213
1404
|
# @return [CountDto]
|
|
@@ -1217,6 +1408,7 @@ module MailSlurpClient
|
|
|
1217
1408
|
end
|
|
1218
1409
|
|
|
1219
1410
|
# Get email count
|
|
1411
|
+
# Returns total email count for the authenticated user, or count scoped to a specific inbox when `inboxId` is provided.
|
|
1220
1412
|
# @param [Hash] opts the optional parameters
|
|
1221
1413
|
# @option opts [String] :inbox_id
|
|
1222
1414
|
# @return [Array<(CountDto, Integer, Hash)>] CountDto data, response status code and response headers
|
|
@@ -1264,8 +1456,8 @@ module MailSlurpClient
|
|
|
1264
1456
|
return data, status_code, headers
|
|
1265
1457
|
end
|
|
1266
1458
|
|
|
1267
|
-
# Get email
|
|
1268
|
-
#
|
|
1459
|
+
# Get hydrated email HTML for browser rendering
|
|
1460
|
+
# Returns hydrated HTML body directly with `text/html` content type. Supports temporary access/browser usage and optional CID replacement for inline asset rendering.
|
|
1269
1461
|
# @param email_id [String]
|
|
1270
1462
|
# @param [Hash] opts the optional parameters
|
|
1271
1463
|
# @option opts [Boolean] :replace_cid_images (default to false)
|
|
@@ -1275,8 +1467,8 @@ module MailSlurpClient
|
|
|
1275
1467
|
data
|
|
1276
1468
|
end
|
|
1277
1469
|
|
|
1278
|
-
# Get email
|
|
1279
|
-
#
|
|
1470
|
+
# Get hydrated email HTML for browser rendering
|
|
1471
|
+
# Returns hydrated HTML body directly with `text/html` content type. Supports temporary access/browser usage and optional CID replacement for inline asset rendering.
|
|
1280
1472
|
# @param email_id [String]
|
|
1281
1473
|
# @param [Hash] opts the optional parameters
|
|
1282
1474
|
# @option opts [Boolean] :replace_cid_images
|
|
@@ -1329,8 +1521,8 @@ module MailSlurpClient
|
|
|
1329
1521
|
return data, status_code, headers
|
|
1330
1522
|
end
|
|
1331
1523
|
|
|
1332
|
-
# Get email
|
|
1333
|
-
#
|
|
1524
|
+
# Get hydrated email HTML wrapped in JSON
|
|
1525
|
+
# Returns hydrated HTML body and subject in a JSON DTO. Useful for API clients that need structured response payloads instead of raw HTML responses.
|
|
1334
1526
|
# @param email_id [String]
|
|
1335
1527
|
# @param [Hash] opts the optional parameters
|
|
1336
1528
|
# @option opts [Boolean] :replace_cid_images (default to false)
|
|
@@ -1340,8 +1532,8 @@ module MailSlurpClient
|
|
|
1340
1532
|
data
|
|
1341
1533
|
end
|
|
1342
1534
|
|
|
1343
|
-
# Get email
|
|
1344
|
-
#
|
|
1535
|
+
# Get hydrated email HTML wrapped in JSON
|
|
1536
|
+
# Returns hydrated HTML body and subject in a JSON DTO. Useful for API clients that need structured response payloads instead of raw HTML responses.
|
|
1345
1537
|
# @param email_id [String]
|
|
1346
1538
|
# @param [Hash] opts the optional parameters
|
|
1347
1539
|
# @option opts [Boolean] :replace_cid_images
|
|
@@ -1394,8 +1586,8 @@ module MailSlurpClient
|
|
|
1394
1586
|
return data, status_code, headers
|
|
1395
1587
|
end
|
|
1396
1588
|
|
|
1397
|
-
#
|
|
1398
|
-
#
|
|
1589
|
+
# Query hydrated HTML body and return matching text lines
|
|
1590
|
+
# Applies a JSoup/CSS selector to hydrated HTML email body and returns matching text lines.
|
|
1399
1591
|
# @param email_id [String] ID of email to perform HTML query on
|
|
1400
1592
|
# @param html_selector [String] HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information.
|
|
1401
1593
|
# @param [Hash] opts the optional parameters
|
|
@@ -1405,8 +1597,8 @@ module MailSlurpClient
|
|
|
1405
1597
|
data
|
|
1406
1598
|
end
|
|
1407
1599
|
|
|
1408
|
-
#
|
|
1409
|
-
#
|
|
1600
|
+
# Query hydrated HTML body and return matching text lines
|
|
1601
|
+
# Applies a JSoup/CSS selector to hydrated HTML email body and returns matching text lines.
|
|
1410
1602
|
# @param email_id [String] ID of email to perform HTML query on
|
|
1411
1603
|
# @param html_selector [String] HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information.
|
|
1412
1604
|
# @param [Hash] opts the optional parameters
|
|
@@ -1463,8 +1655,8 @@ module MailSlurpClient
|
|
|
1463
1655
|
return data, status_code, headers
|
|
1464
1656
|
end
|
|
1465
1657
|
|
|
1466
|
-
#
|
|
1467
|
-
# HTML
|
|
1658
|
+
# Extract links from an email HTML body
|
|
1659
|
+
# Parses HTML content and extracts link URLs (`href`). For non-HTML emails this endpoint returns a validation error.
|
|
1468
1660
|
# @param email_id [String] ID of email to fetch text for
|
|
1469
1661
|
# @param [Hash] opts the optional parameters
|
|
1470
1662
|
# @option opts [String] :selector Optional HTML query selector for links
|
|
@@ -1474,8 +1666,8 @@ module MailSlurpClient
|
|
|
1474
1666
|
data
|
|
1475
1667
|
end
|
|
1476
1668
|
|
|
1477
|
-
#
|
|
1478
|
-
# HTML
|
|
1669
|
+
# Extract links from an email HTML body
|
|
1670
|
+
# Parses HTML content and extracts link URLs (`href`). For non-HTML emails this endpoint returns a validation error.
|
|
1479
1671
|
# @param email_id [String] ID of email to fetch text for
|
|
1480
1672
|
# @param [Hash] opts the optional parameters
|
|
1481
1673
|
# @option opts [String] :selector Optional HTML query selector for links
|
|
@@ -1529,7 +1721,7 @@ module MailSlurpClient
|
|
|
1529
1721
|
end
|
|
1530
1722
|
|
|
1531
1723
|
# Get email URLs for viewing in browser or downloading
|
|
1532
|
-
#
|
|
1724
|
+
# Returns precomputed URLs for preview and raw message access for the specified email.
|
|
1533
1725
|
# @param email_id [String]
|
|
1534
1726
|
# @param [Hash] opts the optional parameters
|
|
1535
1727
|
# @return [EmailPreviewUrls]
|
|
@@ -1539,7 +1731,7 @@ module MailSlurpClient
|
|
|
1539
1731
|
end
|
|
1540
1732
|
|
|
1541
1733
|
# Get email URLs for viewing in browser or downloading
|
|
1542
|
-
#
|
|
1734
|
+
# Returns precomputed URLs for preview and raw message access for the specified email.
|
|
1543
1735
|
# @param email_id [String]
|
|
1544
1736
|
# @param [Hash] opts the optional parameters
|
|
1545
1737
|
# @return [Array<(EmailPreviewUrls, Integer, Hash)>] EmailPreviewUrls data, response status code and response headers
|
|
@@ -1591,7 +1783,7 @@ module MailSlurpClient
|
|
|
1591
1783
|
end
|
|
1592
1784
|
|
|
1593
1785
|
# Take a screenshot of an email in a browser and return base64 encoded string
|
|
1594
|
-
#
|
|
1786
|
+
# Renders the email in a browser engine and returns PNG data as base64. Useful for APIs and dashboards that cannot easily stream binary responses.
|
|
1595
1787
|
# @param email_id [String]
|
|
1596
1788
|
# @param get_email_screenshot_options [GetEmailScreenshotOptions]
|
|
1597
1789
|
# @param [Hash] opts the optional parameters
|
|
@@ -1602,7 +1794,7 @@ module MailSlurpClient
|
|
|
1602
1794
|
end
|
|
1603
1795
|
|
|
1604
1796
|
# Take a screenshot of an email in a browser and return base64 encoded string
|
|
1605
|
-
#
|
|
1797
|
+
# Renders the email in a browser engine and returns PNG data as base64. Useful for APIs and dashboards that cannot easily stream binary responses.
|
|
1606
1798
|
# @param email_id [String]
|
|
1607
1799
|
# @param get_email_screenshot_options [GetEmailScreenshotOptions]
|
|
1608
1800
|
# @param [Hash] opts the optional parameters
|
|
@@ -1661,7 +1853,7 @@ module MailSlurpClient
|
|
|
1661
1853
|
end
|
|
1662
1854
|
|
|
1663
1855
|
# Take a screenshot of an email in a browser
|
|
1664
|
-
#
|
|
1856
|
+
# Renders the email in a browser engine and returns PNG bytes. Intended for visual QA and rendering regression checks.
|
|
1665
1857
|
# @param email_id [String]
|
|
1666
1858
|
# @param get_email_screenshot_options [GetEmailScreenshotOptions]
|
|
1667
1859
|
# @param [Hash] opts the optional parameters
|
|
@@ -1672,7 +1864,7 @@ module MailSlurpClient
|
|
|
1672
1864
|
end
|
|
1673
1865
|
|
|
1674
1866
|
# Take a screenshot of an email in a browser
|
|
1675
|
-
#
|
|
1867
|
+
# Renders the email in a browser engine and returns PNG bytes. Intended for visual QA and rendering regression checks.
|
|
1676
1868
|
# @param email_id [String]
|
|
1677
1869
|
# @param get_email_screenshot_options [GetEmailScreenshotOptions]
|
|
1678
1870
|
# @param [Hash] opts the optional parameters
|
|
@@ -1728,22 +1920,84 @@ module MailSlurpClient
|
|
|
1728
1920
|
return data, status_code, headers
|
|
1729
1921
|
end
|
|
1730
1922
|
|
|
1731
|
-
#
|
|
1732
|
-
#
|
|
1923
|
+
# Extract signature from an inbound email
|
|
1924
|
+
# Attempts to parse a sender signature block from an email body. Uses raw MIME content parts when possible and falls back to hydrated body parsing. This is heuristic and may not be accurate for all email clients or formats.
|
|
1925
|
+
# @param email_id [String] ID of email to extract signature from
|
|
1926
|
+
# @param [Hash] opts the optional parameters
|
|
1927
|
+
# @return [EmailSignatureParseResult]
|
|
1928
|
+
def get_email_signature(email_id, opts = {})
|
|
1929
|
+
data, _status_code, _headers = get_email_signature_with_http_info(email_id, opts)
|
|
1930
|
+
data
|
|
1931
|
+
end
|
|
1932
|
+
|
|
1933
|
+
# Extract signature from an inbound email
|
|
1934
|
+
# Attempts to parse a sender signature block from an email body. Uses raw MIME content parts when possible and falls back to hydrated body parsing. This is heuristic and may not be accurate for all email clients or formats.
|
|
1935
|
+
# @param email_id [String] ID of email to extract signature from
|
|
1936
|
+
# @param [Hash] opts the optional parameters
|
|
1937
|
+
# @return [Array<(EmailSignatureParseResult, Integer, Hash)>] EmailSignatureParseResult data, response status code and response headers
|
|
1938
|
+
def get_email_signature_with_http_info(email_id, opts = {})
|
|
1939
|
+
if @api_client.config.debugging
|
|
1940
|
+
@api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_signature ...'
|
|
1941
|
+
end
|
|
1942
|
+
# verify the required parameter 'email_id' is set
|
|
1943
|
+
if @api_client.config.client_side_validation && email_id.nil?
|
|
1944
|
+
fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_signature"
|
|
1945
|
+
end
|
|
1946
|
+
# resource path
|
|
1947
|
+
local_var_path = '/emails/{emailId}/signature'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
|
|
1948
|
+
|
|
1949
|
+
# query parameters
|
|
1950
|
+
query_params = opts[:query_params] || {}
|
|
1951
|
+
|
|
1952
|
+
# header parameters
|
|
1953
|
+
header_params = opts[:header_params] || {}
|
|
1954
|
+
# HTTP header 'Accept' (if needed)
|
|
1955
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
|
1956
|
+
|
|
1957
|
+
# form parameters
|
|
1958
|
+
form_params = opts[:form_params] || {}
|
|
1959
|
+
|
|
1960
|
+
# http body (model)
|
|
1961
|
+
post_body = opts[:body]
|
|
1962
|
+
|
|
1963
|
+
# return_type
|
|
1964
|
+
return_type = opts[:return_type] || 'EmailSignatureParseResult'
|
|
1965
|
+
|
|
1966
|
+
# auth_names
|
|
1967
|
+
auth_names = opts[:auth_names] || ['API_KEY']
|
|
1968
|
+
|
|
1969
|
+
new_options = opts.merge(
|
|
1970
|
+
:header_params => header_params,
|
|
1971
|
+
:query_params => query_params,
|
|
1972
|
+
:form_params => form_params,
|
|
1973
|
+
:body => post_body,
|
|
1974
|
+
:auth_names => auth_names,
|
|
1975
|
+
:return_type => return_type
|
|
1976
|
+
)
|
|
1977
|
+
|
|
1978
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1979
|
+
if @api_client.config.debugging
|
|
1980
|
+
@api_client.config.logger.debug "API called: EmailControllerApi#get_email_signature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1981
|
+
end
|
|
1982
|
+
return data, status_code, headers
|
|
1983
|
+
end
|
|
1984
|
+
|
|
1985
|
+
# Get email summary (headers/metadata only)
|
|
1986
|
+
# Returns lightweight metadata and headers for an email. Use `getEmail` for hydrated body content or `getRawEmail` for original SMTP content.
|
|
1733
1987
|
# @param email_id [String]
|
|
1734
1988
|
# @param [Hash] opts the optional parameters
|
|
1735
|
-
# @option opts [Boolean] :decode
|
|
1989
|
+
# @option opts [Boolean] :decode Deprecated and ignored. Retained for backwards compatibility.
|
|
1736
1990
|
# @return [EmailPreview]
|
|
1737
1991
|
def get_email_summary(email_id, opts = {})
|
|
1738
1992
|
data, _status_code, _headers = get_email_summary_with_http_info(email_id, opts)
|
|
1739
1993
|
data
|
|
1740
1994
|
end
|
|
1741
1995
|
|
|
1742
|
-
# Get email
|
|
1743
|
-
# Returns
|
|
1996
|
+
# Get email summary (headers/metadata only)
|
|
1997
|
+
# Returns lightweight metadata and headers for an email. Use `getEmail` for hydrated body content or `getRawEmail` for original SMTP content.
|
|
1744
1998
|
# @param email_id [String]
|
|
1745
1999
|
# @param [Hash] opts the optional parameters
|
|
1746
|
-
# @option opts [Boolean] :decode
|
|
2000
|
+
# @option opts [Boolean] :decode Deprecated and ignored. Retained for backwards compatibility.
|
|
1747
2001
|
# @return [Array<(EmailPreview, Integer, Hash)>] EmailPreview data, response status code and response headers
|
|
1748
2002
|
def get_email_summary_with_http_info(email_id, opts = {})
|
|
1749
2003
|
if @api_client.config.debugging
|
|
@@ -1793,8 +2047,8 @@ module MailSlurpClient
|
|
|
1793
2047
|
return data, status_code, headers
|
|
1794
2048
|
end
|
|
1795
2049
|
|
|
1796
|
-
#
|
|
1797
|
-
#
|
|
2050
|
+
# Extract normalized text lines from email body
|
|
2051
|
+
# Converts email body content to line-based plain text with optional HTML entity decoding and custom line separator.
|
|
1798
2052
|
# @param email_id [String] ID of email to fetch text for
|
|
1799
2053
|
# @param [Hash] opts the optional parameters
|
|
1800
2054
|
# @option opts [Boolean] :decode_html_entities Decode HTML entities
|
|
@@ -1805,8 +2059,8 @@ module MailSlurpClient
|
|
|
1805
2059
|
data
|
|
1806
2060
|
end
|
|
1807
2061
|
|
|
1808
|
-
#
|
|
1809
|
-
#
|
|
2062
|
+
# Extract normalized text lines from email body
|
|
2063
|
+
# Converts email body content to line-based plain text with optional HTML entity decoding and custom line separator.
|
|
1810
2064
|
# @param email_id [String] ID of email to fetch text for
|
|
1811
2065
|
# @param [Hash] opts the optional parameters
|
|
1812
2066
|
# @option opts [Boolean] :decode_html_entities Decode HTML entities
|
|
@@ -1861,8 +2115,8 @@ module MailSlurpClient
|
|
|
1861
2115
|
return data, status_code, headers
|
|
1862
2116
|
end
|
|
1863
2117
|
|
|
1864
|
-
#
|
|
1865
|
-
#
|
|
2118
|
+
# Get email thread metadata by thread ID
|
|
2119
|
+
# Returns thread metadata built from RFC 5322 `Message-ID`, `In-Reply-To`, and `References` headers. Use `getEmailThreadItems` to fetch the thread messages.
|
|
1866
2120
|
# @param thread_id [String]
|
|
1867
2121
|
# @param [Hash] opts the optional parameters
|
|
1868
2122
|
# @return [EmailThreadDto]
|
|
@@ -1871,8 +2125,8 @@ module MailSlurpClient
|
|
|
1871
2125
|
data
|
|
1872
2126
|
end
|
|
1873
2127
|
|
|
1874
|
-
#
|
|
1875
|
-
#
|
|
2128
|
+
# Get email thread metadata by thread ID
|
|
2129
|
+
# Returns thread metadata built from RFC 5322 `Message-ID`, `In-Reply-To`, and `References` headers. Use `getEmailThreadItems` to fetch the thread messages.
|
|
1876
2130
|
# @param thread_id [String]
|
|
1877
2131
|
# @param [Hash] opts the optional parameters
|
|
1878
2132
|
# @return [Array<(EmailThreadDto, Integer, Hash)>] EmailThreadDto data, response status code and response headers
|
|
@@ -1923,8 +2177,8 @@ module MailSlurpClient
|
|
|
1923
2177
|
return data, status_code, headers
|
|
1924
2178
|
end
|
|
1925
2179
|
|
|
1926
|
-
#
|
|
1927
|
-
#
|
|
2180
|
+
# Get messages in a specific email thread
|
|
2181
|
+
# Returns all messages in a thread ordered by `createdAt` using the requested sort direction.
|
|
1928
2182
|
# @param thread_id [String]
|
|
1929
2183
|
# @param [Hash] opts the optional parameters
|
|
1930
2184
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
|
@@ -1934,8 +2188,8 @@ module MailSlurpClient
|
|
|
1934
2188
|
data
|
|
1935
2189
|
end
|
|
1936
2190
|
|
|
1937
|
-
#
|
|
1938
|
-
#
|
|
2191
|
+
# Get messages in a specific email thread
|
|
2192
|
+
# Returns all messages in a thread ordered by `createdAt` using the requested sort direction.
|
|
1939
2193
|
# @param thread_id [String]
|
|
1940
2194
|
# @param [Hash] opts the optional parameters
|
|
1941
2195
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
|
@@ -1992,10 +2246,10 @@ module MailSlurpClient
|
|
|
1992
2246
|
return data, status_code, headers
|
|
1993
2247
|
end
|
|
1994
2248
|
|
|
1995
|
-
#
|
|
1996
|
-
#
|
|
2249
|
+
# List email threads in paginated form
|
|
2250
|
+
# Lists conversation threads inferred from `Message-ID`, `In-Reply-To`, and `References`. Supports filtering by inbox, search text, and time range.
|
|
1997
2251
|
# @param [Hash] opts the optional parameters
|
|
1998
|
-
# @option opts [String] :html_selector Optional inbox filter
|
|
2252
|
+
# @option opts [String] :html_selector Optional inbox filter. Query parameter name is `htmlSelector` for legacy compatibility.
|
|
1999
2253
|
# @option opts [Integer] :page Optional page index in email thread pagination (default to 0)
|
|
2000
2254
|
# @option opts [Integer] :size Optional page size in email thread pagination. Maximum size is 100. Use page index and sort to page through larger results (default to 20)
|
|
2001
2255
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
|
@@ -2008,10 +2262,10 @@ module MailSlurpClient
|
|
|
2008
2262
|
data
|
|
2009
2263
|
end
|
|
2010
2264
|
|
|
2011
|
-
#
|
|
2012
|
-
#
|
|
2265
|
+
# List email threads in paginated form
|
|
2266
|
+
# Lists conversation threads inferred from `Message-ID`, `In-Reply-To`, and `References`. Supports filtering by inbox, search text, and time range.
|
|
2013
2267
|
# @param [Hash] opts the optional parameters
|
|
2014
|
-
# @option opts [String] :html_selector Optional inbox filter
|
|
2268
|
+
# @option opts [String] :html_selector Optional inbox filter. Query parameter name is `htmlSelector` for legacy compatibility.
|
|
2015
2269
|
# @option opts [Integer] :page Optional page index in email thread pagination
|
|
2016
2270
|
# @option opts [Integer] :size Optional page size in email thread pagination. Maximum size is 100. Use page index and sort to page through larger results
|
|
2017
2271
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
|
@@ -2078,14 +2332,14 @@ module MailSlurpClient
|
|
|
2078
2332
|
end
|
|
2079
2333
|
|
|
2080
2334
|
# Get all emails in all inboxes in paginated form. Email API list all.
|
|
2081
|
-
#
|
|
2335
|
+
# Offset-style pagination endpoint for listing emails across inboxes. Supports inbox filters, unread-only, search, date boundaries, favourites, connector sync, plus-address filtering, and explicit include IDs.
|
|
2082
2336
|
# @param [Hash] opts the optional parameters
|
|
2083
2337
|
# @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
|
|
2084
2338
|
# @option opts [Integer] :page Optional page index in email list pagination (default to 0)
|
|
2085
2339
|
# @option opts [Integer] :size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (default to 20)
|
|
2086
2340
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
|
2087
2341
|
# @option opts [Boolean] :unread_only Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (default to false)
|
|
2088
|
-
# @option opts [String] :search_filter Optional search filter.
|
|
2342
|
+
# @option opts [String] :search_filter Optional search filter. Full email addresses match sender and receiving inbox email or receiving plus-address full address exactly. Address-like fragments containing @ (for example +alias@) also match sender, receiving inbox email, and receiving plus-address full address by contains. General text search matches sender, subject, and ID.
|
|
2089
2343
|
# @option opts [DateTime] :since Optional filter emails received after given date time
|
|
2090
2344
|
# @option opts [DateTime] :before Optional filter emails received before given date time
|
|
2091
2345
|
# @option opts [Boolean] :favourited Optional filter emails that are favourited
|
|
@@ -2099,14 +2353,14 @@ module MailSlurpClient
|
|
|
2099
2353
|
end
|
|
2100
2354
|
|
|
2101
2355
|
# Get all emails in all inboxes in paginated form. Email API list all.
|
|
2102
|
-
#
|
|
2356
|
+
# Offset-style pagination endpoint for listing emails across inboxes. Supports inbox filters, unread-only, search, date boundaries, favourites, connector sync, plus-address filtering, and explicit include IDs.
|
|
2103
2357
|
# @param [Hash] opts the optional parameters
|
|
2104
2358
|
# @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
|
|
2105
2359
|
# @option opts [Integer] :page Optional page index in email list pagination
|
|
2106
2360
|
# @option opts [Integer] :size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
|
|
2107
2361
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
|
2108
2362
|
# @option opts [Boolean] :unread_only Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
|
|
2109
|
-
# @option opts [String] :search_filter Optional search filter.
|
|
2363
|
+
# @option opts [String] :search_filter Optional search filter. Full email addresses match sender and receiving inbox email or receiving plus-address full address exactly. Address-like fragments containing @ (for example +alias@) also match sender, receiving inbox email, and receiving plus-address full address by contains. General text search matches sender, subject, and ID.
|
|
2110
2364
|
# @option opts [DateTime] :since Optional filter emails received after given date time
|
|
2111
2365
|
# @option opts [DateTime] :before Optional filter emails received before given date time
|
|
2112
2366
|
# @option opts [Boolean] :favourited Optional filter emails that are favourited
|
|
@@ -2178,14 +2432,14 @@ module MailSlurpClient
|
|
|
2178
2432
|
end
|
|
2179
2433
|
|
|
2180
2434
|
# Get all emails in all inboxes in paginated form. Email API list all.
|
|
2181
|
-
#
|
|
2435
|
+
# Primary paginated email listing endpoint. Returns emails across inboxes with support for inbox filters, unread-only, search, date boundaries, favourites, connector sync, and plus-address filtering.
|
|
2182
2436
|
# @param [Hash] opts the optional parameters
|
|
2183
2437
|
# @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
|
|
2184
2438
|
# @option opts [Integer] :page Optional page index in email list pagination (default to 0)
|
|
2185
2439
|
# @option opts [Integer] :size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (default to 20)
|
|
2186
2440
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
|
|
2187
2441
|
# @option opts [Boolean] :unread_only Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (default to false)
|
|
2188
|
-
# @option opts [String] :search_filter Optional search filter.
|
|
2442
|
+
# @option opts [String] :search_filter Optional search filter. Full email addresses match sender and receiving inbox email or receiving plus-address full address exactly. Address-like fragments containing @ (for example +alias@) also match sender, receiving inbox email, and receiving plus-address full address by contains. General text search matches sender, subject, and ID.
|
|
2189
2443
|
# @option opts [DateTime] :since Optional filter emails received after given date time. If unset will use time 24hours prior to now.
|
|
2190
2444
|
# @option opts [DateTime] :before Optional filter emails received before given date time
|
|
2191
2445
|
# @option opts [Boolean] :sync_connectors Sync connectors
|
|
@@ -2198,14 +2452,14 @@ module MailSlurpClient
|
|
|
2198
2452
|
end
|
|
2199
2453
|
|
|
2200
2454
|
# Get all emails in all inboxes in paginated form. Email API list all.
|
|
2201
|
-
#
|
|
2455
|
+
# Primary paginated email listing endpoint. Returns emails across inboxes with support for inbox filters, unread-only, search, date boundaries, favourites, connector sync, and plus-address filtering.
|
|
2202
2456
|
# @param [Hash] opts the optional parameters
|
|
2203
2457
|
# @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
|
|
2204
2458
|
# @option opts [Integer] :page Optional page index in email list pagination
|
|
2205
2459
|
# @option opts [Integer] :size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
|
|
2206
2460
|
# @option opts [String] :sort Optional createdAt sort direction ASC or DESC
|
|
2207
2461
|
# @option opts [Boolean] :unread_only Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
|
|
2208
|
-
# @option opts [String] :search_filter Optional search filter.
|
|
2462
|
+
# @option opts [String] :search_filter Optional search filter. Full email addresses match sender and receiving inbox email or receiving plus-address full address exactly. Address-like fragments containing @ (for example +alias@) also match sender, receiving inbox email, and receiving plus-address full address by contains. General text search matches sender, subject, and ID.
|
|
2209
2463
|
# @option opts [DateTime] :since Optional filter emails received after given date time. If unset will use time 24hours prior to now.
|
|
2210
2464
|
# @option opts [DateTime] :before Optional filter emails received before given date time
|
|
2211
2465
|
# @option opts [Boolean] :sync_connectors Sync connectors
|
|
@@ -2274,7 +2528,8 @@ module MailSlurpClient
|
|
|
2274
2528
|
return data, status_code, headers
|
|
2275
2529
|
end
|
|
2276
2530
|
|
|
2277
|
-
# Get
|
|
2531
|
+
# Get Gravatar URL for an email address
|
|
2532
|
+
# Builds a Gravatar image URL from the provided email address and optional size. This endpoint does not fetch image bytes; it only returns the computed URL.
|
|
2278
2533
|
# @param email_address [String]
|
|
2279
2534
|
# @param [Hash] opts the optional parameters
|
|
2280
2535
|
# @option opts [String] :size
|
|
@@ -2284,7 +2539,8 @@ module MailSlurpClient
|
|
|
2284
2539
|
data
|
|
2285
2540
|
end
|
|
2286
2541
|
|
|
2287
|
-
# Get
|
|
2542
|
+
# Get Gravatar URL for an email address
|
|
2543
|
+
# Builds a Gravatar image URL from the provided email address and optional size. This endpoint does not fetch image bytes; it only returns the computed URL.
|
|
2288
2544
|
# @param email_address [String]
|
|
2289
2545
|
# @param [Hash] opts the optional parameters
|
|
2290
2546
|
# @option opts [String] :size
|
|
@@ -2339,7 +2595,7 @@ module MailSlurpClient
|
|
|
2339
2595
|
end
|
|
2340
2596
|
|
|
2341
2597
|
# Get latest email in all inboxes. Most recently received.
|
|
2342
|
-
#
|
|
2598
|
+
# Returns the most recently received email across all inboxes or an optional subset of inbox IDs.
|
|
2343
2599
|
# @param [Hash] opts the optional parameters
|
|
2344
2600
|
# @option opts [Array<String>] :inbox_ids Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes
|
|
2345
2601
|
# @return [Email]
|
|
@@ -2349,7 +2605,7 @@ module MailSlurpClient
|
|
|
2349
2605
|
end
|
|
2350
2606
|
|
|
2351
2607
|
# Get latest email in all inboxes. Most recently received.
|
|
2352
|
-
#
|
|
2608
|
+
# Returns the most recently received email across all inboxes or an optional subset of inbox IDs.
|
|
2353
2609
|
# @param [Hash] opts the optional parameters
|
|
2354
2610
|
# @option opts [Array<String>] :inbox_ids Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes
|
|
2355
2611
|
# @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
|
|
@@ -2398,7 +2654,7 @@ module MailSlurpClient
|
|
|
2398
2654
|
end
|
|
2399
2655
|
|
|
2400
2656
|
# Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
|
|
2401
|
-
#
|
|
2657
|
+
# Returns the newest email for the specified inbox ID. For polling/wait semantics use wait endpoints.
|
|
2402
2658
|
# @param inbox_id [String] ID of the inbox you want to get the latest email from
|
|
2403
2659
|
# @param [Hash] opts the optional parameters
|
|
2404
2660
|
# @return [Email]
|
|
@@ -2408,7 +2664,7 @@ module MailSlurpClient
|
|
|
2408
2664
|
end
|
|
2409
2665
|
|
|
2410
2666
|
# Get latest email in an inbox. Use `WaitForController` to get emails that may not have arrived yet.
|
|
2411
|
-
#
|
|
2667
|
+
# Returns the newest email for the specified inbox ID. For polling/wait semantics use wait endpoints.
|
|
2412
2668
|
# @param inbox_id [String] ID of the inbox you want to get the latest email from
|
|
2413
2669
|
# @param [Hash] opts the optional parameters
|
|
2414
2670
|
# @return [Array<(Email, Integer, Hash)>] Email data, response status code and response headers
|
|
@@ -2460,8 +2716,8 @@ module MailSlurpClient
|
|
|
2460
2716
|
return data, status_code, headers
|
|
2461
2717
|
end
|
|
2462
2718
|
|
|
2463
|
-
#
|
|
2464
|
-
#
|
|
2719
|
+
# List organization-visible emails
|
|
2720
|
+
# Returns paginated emails visible through organization/team access. Supports inbox filtering, unread-only filtering, search, favourites, plus-address filtering, and optional connector sync.
|
|
2465
2721
|
# @param [Hash] opts the optional parameters
|
|
2466
2722
|
# @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
|
|
2467
2723
|
# @option opts [Integer] :page Optional page index in email list pagination (default to 0)
|
|
@@ -2480,8 +2736,8 @@ module MailSlurpClient
|
|
|
2480
2736
|
data
|
|
2481
2737
|
end
|
|
2482
2738
|
|
|
2483
|
-
#
|
|
2484
|
-
#
|
|
2739
|
+
# List organization-visible emails
|
|
2740
|
+
# Returns paginated emails visible through organization/team access. Supports inbox filtering, unread-only filtering, search, favourites, plus-address filtering, and optional connector sync.
|
|
2485
2741
|
# @param [Hash] opts the optional parameters
|
|
2486
2742
|
# @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
|
|
2487
2743
|
# @option opts [Integer] :page Optional page index in email list pagination
|
|
@@ -2558,7 +2814,7 @@ module MailSlurpClient
|
|
|
2558
2814
|
end
|
|
2559
2815
|
|
|
2560
2816
|
# Get raw email string. Returns unparsed raw SMTP message with headers and body.
|
|
2561
|
-
# Returns
|
|
2817
|
+
# Returns the original unparsed SMTP/MIME message as `text/plain`. Use JSON variant if your client expects JSON transport.
|
|
2562
2818
|
# @param email_id [String] ID of email
|
|
2563
2819
|
# @param [Hash] opts the optional parameters
|
|
2564
2820
|
# @return [nil]
|
|
@@ -2568,7 +2824,7 @@ module MailSlurpClient
|
|
|
2568
2824
|
end
|
|
2569
2825
|
|
|
2570
2826
|
# Get raw email string. Returns unparsed raw SMTP message with headers and body.
|
|
2571
|
-
# Returns
|
|
2827
|
+
# Returns the original unparsed SMTP/MIME message as `text/plain`. Use JSON variant if your client expects JSON transport.
|
|
2572
2828
|
# @param email_id [String] ID of email
|
|
2573
2829
|
# @param [Hash] opts the optional parameters
|
|
2574
2830
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
@@ -2618,7 +2874,7 @@ module MailSlurpClient
|
|
|
2618
2874
|
end
|
|
2619
2875
|
|
|
2620
2876
|
# Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.
|
|
2621
|
-
# Returns
|
|
2877
|
+
# Returns the original unparsed SMTP/MIME message wrapped in a JSON DTO for API clients that avoid plain-text stream responses.
|
|
2622
2878
|
# @param email_id [String] ID of email
|
|
2623
2879
|
# @param [Hash] opts the optional parameters
|
|
2624
2880
|
# @return [RawEmailJson]
|
|
@@ -2628,7 +2884,7 @@ module MailSlurpClient
|
|
|
2628
2884
|
end
|
|
2629
2885
|
|
|
2630
2886
|
# Get raw email in JSON. Unparsed SMTP message in JSON wrapper format.
|
|
2631
|
-
# Returns
|
|
2887
|
+
# Returns the original unparsed SMTP/MIME message wrapped in a JSON DTO for API clients that avoid plain-text stream responses.
|
|
2632
2888
|
# @param email_id [String] ID of email
|
|
2633
2889
|
# @param [Hash] opts the optional parameters
|
|
2634
2890
|
# @return [Array<(RawEmailJson, Integer, Hash)>] RawEmailJson data, response status code and response headers
|
|
@@ -2680,9 +2936,9 @@ module MailSlurpClient
|
|
|
2680
2936
|
end
|
|
2681
2937
|
|
|
2682
2938
|
# Get unread email count
|
|
2683
|
-
#
|
|
2939
|
+
# Returns unread email count. An email is considered read after dashboard/API retrieval depending on your read workflow.
|
|
2684
2940
|
# @param [Hash] opts the optional parameters
|
|
2685
|
-
# @option opts [String] :inbox_id
|
|
2941
|
+
# @option opts [String] :inbox_id Inbox ID filter for unread count scope
|
|
2686
2942
|
# @return [UnreadCount]
|
|
2687
2943
|
def get_unread_email_count(opts = {})
|
|
2688
2944
|
data, _status_code, _headers = get_unread_email_count_with_http_info(opts)
|
|
@@ -2690,9 +2946,9 @@ module MailSlurpClient
|
|
|
2690
2946
|
end
|
|
2691
2947
|
|
|
2692
2948
|
# Get unread email count
|
|
2693
|
-
#
|
|
2949
|
+
# Returns unread email count. An email is considered read after dashboard/API retrieval depending on your read workflow.
|
|
2694
2950
|
# @param [Hash] opts the optional parameters
|
|
2695
|
-
# @option opts [String] :inbox_id
|
|
2951
|
+
# @option opts [String] :inbox_id Inbox ID filter for unread count scope
|
|
2696
2952
|
# @return [Array<(UnreadCount, Integer, Hash)>] UnreadCount data, response status code and response headers
|
|
2697
2953
|
def get_unread_email_count_with_http_info(opts = {})
|
|
2698
2954
|
if @api_client.config.debugging
|
|
@@ -2739,7 +2995,7 @@ module MailSlurpClient
|
|
|
2739
2995
|
end
|
|
2740
2996
|
|
|
2741
2997
|
# Mark all emails as read or unread
|
|
2742
|
-
#
|
|
2998
|
+
# Sets read state for all emails, optionally scoped to one inbox. Use `read=false` to reset unread state in bulk.
|
|
2743
2999
|
# @param [Hash] opts the optional parameters
|
|
2744
3000
|
# @option opts [Boolean] :read What value to assign to email read property. Default true. (default to true)
|
|
2745
3001
|
# @option opts [String] :inbox_id Optional inbox ID filter
|
|
@@ -2750,7 +3006,7 @@ module MailSlurpClient
|
|
|
2750
3006
|
end
|
|
2751
3007
|
|
|
2752
3008
|
# Mark all emails as read or unread
|
|
2753
|
-
#
|
|
3009
|
+
# Sets read state for all emails, optionally scoped to one inbox. Use `read=false` to reset unread state in bulk.
|
|
2754
3010
|
# @param [Hash] opts the optional parameters
|
|
2755
3011
|
# @option opts [Boolean] :read What value to assign to email read property. Default true.
|
|
2756
3012
|
# @option opts [String] :inbox_id Optional inbox ID filter
|
|
@@ -2799,7 +3055,7 @@ module MailSlurpClient
|
|
|
2799
3055
|
end
|
|
2800
3056
|
|
|
2801
3057
|
# Mark an email as read or unread
|
|
2802
|
-
#
|
|
3058
|
+
# Sets read state for one email. Useful when implementing custom mailbox workflows that treat viewed messages as unread.
|
|
2803
3059
|
# @param email_id [String]
|
|
2804
3060
|
# @param [Hash] opts the optional parameters
|
|
2805
3061
|
# @option opts [Boolean] :read What value to assign to email read property. Default true. (default to true)
|
|
@@ -2810,7 +3066,7 @@ module MailSlurpClient
|
|
|
2810
3066
|
end
|
|
2811
3067
|
|
|
2812
3068
|
# Mark an email as read or unread
|
|
2813
|
-
#
|
|
3069
|
+
# Sets read state for one email. Useful when implementing custom mailbox workflows that treat viewed messages as unread.
|
|
2814
3070
|
# @param email_id [String]
|
|
2815
3071
|
# @param [Hash] opts the optional parameters
|
|
2816
3072
|
# @option opts [Boolean] :read What value to assign to email read property. Default true.
|
|
@@ -2864,7 +3120,7 @@ module MailSlurpClient
|
|
|
2864
3120
|
end
|
|
2865
3121
|
|
|
2866
3122
|
# Reply to an email
|
|
2867
|
-
#
|
|
3123
|
+
# Sends a reply using the original conversation context (subject/thread headers). Reply target resolution honors sender/reply-to semantics.
|
|
2868
3124
|
# @param email_id [String] ID of the email that should be replied to
|
|
2869
3125
|
# @param reply_to_email_options [ReplyToEmailOptions]
|
|
2870
3126
|
# @param [Hash] opts the optional parameters
|
|
@@ -2875,7 +3131,7 @@ module MailSlurpClient
|
|
|
2875
3131
|
end
|
|
2876
3132
|
|
|
2877
3133
|
# Reply to an email
|
|
2878
|
-
#
|
|
3134
|
+
# Sends a reply using the original conversation context (subject/thread headers). Reply target resolution honors sender/reply-to semantics.
|
|
2879
3135
|
# @param email_id [String] ID of the email that should be replied to
|
|
2880
3136
|
# @param reply_to_email_options [ReplyToEmailOptions]
|
|
2881
3137
|
# @param [Hash] opts the optional parameters
|
|
@@ -2934,7 +3190,7 @@ module MailSlurpClient
|
|
|
2934
3190
|
end
|
|
2935
3191
|
|
|
2936
3192
|
# Get all emails by search criteria. Return in paginated form.
|
|
2937
|
-
#
|
|
3193
|
+
# Searches emails by sender/recipient/address/subject/id fields and returns paginated matches. Does not perform full-text body search.
|
|
2938
3194
|
# @param search_emails_options [SearchEmailsOptions]
|
|
2939
3195
|
# @param [Hash] opts the optional parameters
|
|
2940
3196
|
# @option opts [Boolean] :sync_connectors Sync connectors
|
|
@@ -2947,7 +3203,7 @@ module MailSlurpClient
|
|
|
2947
3203
|
end
|
|
2948
3204
|
|
|
2949
3205
|
# Get all emails by search criteria. Return in paginated form.
|
|
2950
|
-
#
|
|
3206
|
+
# Searches emails by sender/recipient/address/subject/id fields and returns paginated matches. Does not perform full-text body search.
|
|
2951
3207
|
# @param search_emails_options [SearchEmailsOptions]
|
|
2952
3208
|
# @param [Hash] opts the optional parameters
|
|
2953
3209
|
# @option opts [Boolean] :sync_connectors Sync connectors
|
|
@@ -3007,7 +3263,7 @@ module MailSlurpClient
|
|
|
3007
3263
|
end
|
|
3008
3264
|
|
|
3009
3265
|
# Send email
|
|
3010
|
-
#
|
|
3266
|
+
# Sends an email from an existing inbox, or creates a temporary inbox when `inboxId` is not provided. Supports `useDomainPool` and `virtualSend` inbox creation behavior for convenience sends.
|
|
3011
3267
|
# @param send_email_options [SendEmailOptions]
|
|
3012
3268
|
# @param [Hash] opts the optional parameters
|
|
3013
3269
|
# @option opts [String] :inbox_id ID of the inbox you want to send the email from
|
|
@@ -3020,7 +3276,7 @@ module MailSlurpClient
|
|
|
3020
3276
|
end
|
|
3021
3277
|
|
|
3022
3278
|
# Send email
|
|
3023
|
-
#
|
|
3279
|
+
# Sends an email from an existing inbox, or creates a temporary inbox when `inboxId` is not provided. Supports `useDomainPool` and `virtualSend` inbox creation behavior for convenience sends.
|
|
3024
3280
|
# @param send_email_options [SendEmailOptions]
|
|
3025
3281
|
# @param [Hash] opts the optional parameters
|
|
3026
3282
|
# @option opts [String] :inbox_id ID of the inbox you want to send the email from
|
|
@@ -3078,7 +3334,7 @@ module MailSlurpClient
|
|
|
3078
3334
|
end
|
|
3079
3335
|
|
|
3080
3336
|
# Set email favourited state
|
|
3081
|
-
#
|
|
3337
|
+
# Sets favourite state for an email for dashboard/search workflows.
|
|
3082
3338
|
# @param email_id [String] ID of email to set favourite state
|
|
3083
3339
|
# @param favourited [Boolean]
|
|
3084
3340
|
# @param [Hash] opts the optional parameters
|
|
@@ -3089,7 +3345,7 @@ module MailSlurpClient
|
|
|
3089
3345
|
end
|
|
3090
3346
|
|
|
3091
3347
|
# Set email favourited state
|
|
3092
|
-
#
|
|
3348
|
+
# Sets favourite state for an email for dashboard/search workflows.
|
|
3093
3349
|
# @param email_id [String] ID of email to set favourite state
|
|
3094
3350
|
# @param favourited [Boolean]
|
|
3095
3351
|
# @param [Hash] opts the optional parameters
|
|
@@ -3145,7 +3401,7 @@ module MailSlurpClient
|
|
|
3145
3401
|
end
|
|
3146
3402
|
|
|
3147
3403
|
# Validate email HTML contents
|
|
3148
|
-
#
|
|
3404
|
+
# Runs HTML validation on the email body when HTML is present. Non-HTML emails are treated as valid for this check.
|
|
3149
3405
|
# @param email_id [String] ID of email
|
|
3150
3406
|
# @param [Hash] opts the optional parameters
|
|
3151
3407
|
# @return [ValidationDto]
|
|
@@ -3155,7 +3411,7 @@ module MailSlurpClient
|
|
|
3155
3411
|
end
|
|
3156
3412
|
|
|
3157
3413
|
# Validate email HTML contents
|
|
3158
|
-
#
|
|
3414
|
+
# Runs HTML validation on the email body when HTML is present. Non-HTML emails are treated as valid for this check.
|
|
3159
3415
|
# @param email_id [String] ID of email
|
|
3160
3416
|
# @param [Hash] opts the optional parameters
|
|
3161
3417
|
# @return [Array<(ValidationDto, Integer, Hash)>] ValidationDto data, response status code and response headers
|