# Maxemail Documentation > Documentation for Maxemail Append .md to any documentation page URL to get its markdown version. ## Guides - [Maxemail User Guide](https://docs.maxemail.xtremepush.com/docs/overview.md) - [Dashboard](https://docs.maxemail.xtremepush.com/docs/dashboard.md) - [Navigation bar](https://docs.maxemail.xtremepush.com/docs/navigation-bar.md) - [Favourites](https://docs.maxemail.xtremepush.com/docs/navigation-favourites.md) - [Search](https://docs.maxemail.xtremepush.com/docs/navigation-search.md) - [Email creation](https://docs.maxemail.xtremepush.com/docs/email-creation.md) - [Setup](https://docs.maxemail.xtremepush.com/docs/email-tab-setup.md) - [Data](https://docs.maxemail.xtremepush.com/docs/email-tab-data.md) - [Content](https://docs.maxemail.xtremepush.com/docs/email-tab-content.md) - [HTML editor](https://docs.maxemail.xtremepush.com/docs/email-content-html-editor.md) - [Text version](https://docs.maxemail.xtremepush.com/docs/email-content-text-version.md) - [Preview](https://docs.maxemail.xtremepush.com/docs/email-tab-preview.md) - [Testing](https://docs.maxemail.xtremepush.com/docs/email-tab-testing.md): Maxemail offers a range of options for testing your email campaigns before sending them. - [Scheduling](https://docs.maxemail.xtremepush.com/docs/email-tab-scheduling.md): Once a campaign is tested and ready to send it can be scheduled on the Scheduling tab - [Email reports](https://docs.maxemail.xtremepush.com/docs/email-reports.md) - [Breakdown](https://docs.maxemail.xtremepush.com/docs/email-report-breakdown.md) - [Device breakdown](https://docs.maxemail.xtremepush.com/docs/email-report-device.md) - [Bounce categories](https://docs.maxemail.xtremepush.com/docs/bounce-categories.md) - [Split tests](https://docs.maxemail.xtremepush.com/docs/split-tests.md) - [Create a split test](https://docs.maxemail.xtremepush.com/docs/split-test-create.md) - [Split test setup](https://docs.maxemail.xtremepush.com/docs/split-test-setup.md) - [Emails in a split test](https://docs.maxemail.xtremepush.com/docs/split-test-emails.md) - [Split test data](https://docs.maxemail.xtremepush.com/docs/split-test-data.md) - [Split test status](https://docs.maxemail.xtremepush.com/docs/split-test-status.md) - [Recurring Emails](https://docs.maxemail.xtremepush.com/docs/recurring-emails.md) - [Triggered Emails](https://docs.maxemail.xtremepush.com/docs/triggered-emails.md) - [Reports and exports](https://docs.maxemail.xtremepush.com/docs/reports-and-exports.md) - [Insight reports](https://docs.maxemail.xtremepush.com/docs/insight-report.md) - [Scheduled Insight report](https://docs.maxemail.xtremepush.com/docs/insight-report-schedule.md) - [Comparison report](https://docs.maxemail.xtremepush.com/docs/comparison-report.md) - [Scheduled Comparison report](https://docs.maxemail.xtremepush.com/docs/comparison-report-schedule.md) - [Segment Comparison report](https://docs.maxemail.xtremepush.com/docs/segment-comparison-report.md) - [Summary report](https://docs.maxemail.xtremepush.com/docs/summary-report.md) - [Scheduled Summary report](https://docs.maxemail.xtremepush.com/docs/summary-report-schedule.md) - [Data exports](https://docs.maxemail.xtremepush.com/docs/data-exports.md) - [Scheduled email reports](https://docs.maxemail.xtremepush.com/docs/scheduled-email-reports.md) - [Recipient Overview](https://docs.maxemail.xtremepush.com/docs/recipient-overview.md) - [Customer space send log](https://docs.maxemail.xtremepush.com/docs/customer-space-send-log.md) - [Social media options](https://docs.maxemail.xtremepush.com/docs/social-media.md) - [Convert social followers to email](https://docs.maxemail.xtremepush.com/docs/social-media-convert-followers.md): Show a Subscriber Bar to readers of the shared online version, to encourage new subscriptions - [Using social share links](https://docs.maxemail.xtremepush.com/docs/social-media-share-links.md) - [Share email to your social sites](https://docs.maxemail.xtremepush.com/docs/social-media-share-email.md) - [SMS](https://docs.maxemail.xtremepush.com/docs/sms.md) - [SMS Configuration](https://docs.maxemail.xtremepush.com/docs/sms-configuration.md) - [SMS registration requirements](https://docs.maxemail.xtremepush.com/docs/sms-registration-requirements.md) - [Import recipient numbers](https://docs.maxemail.xtremepush.com/docs/sms-import-recipient-numbers.md) - [Create & send SMS campaign](https://docs.maxemail.xtremepush.com/docs/sms-create-send-campaign.md) - [SMS Setup tab](https://docs.maxemail.xtremepush.com/docs/sms-tab-setup.md) - [SMS Data](https://docs.maxemail.xtremepush.com/docs/sms-tab-data.md) - [SMS Content](https://docs.maxemail.xtremepush.com/docs/sms-tab-content.md) - [SMS link tracking](https://docs.maxemail.xtremepush.com/docs/sms-content-track-links.md) - [SMS test sends](https://docs.maxemail.xtremepush.com/docs/sms-tab-testing.md) - [SMS Scheduling](https://docs.maxemail.xtremepush.com/docs/sms-tab-scheduling.md) - [SMS Reporting](https://docs.maxemail.xtremepush.com/docs/sms-tab-reporting.md) - [SMS report breakdown](https://docs.maxemail.xtremepush.com/docs/sms-reporting-breakdown.md) - [SMS replies](https://docs.maxemail.xtremepush.com/docs/sms-replies.md) - [Recurring SMS](https://docs.maxemail.xtremepush.com/docs/sms-recurring.md) - [Administration](https://docs.maxemail.xtremepush.com/docs/administration.md) - [Customer Space administration](https://docs.maxemail.xtremepush.com/docs/administration-customer-space.md) - [User administration](https://docs.maxemail.xtremepush.com/docs/administration-user.md) - [User details](https://docs.maxemail.xtremepush.com/docs/administration-user-details.md) - [User access control](https://docs.maxemail.xtremepush.com/docs/administration-user-access-control.md) - [New user setup](https://docs.maxemail.xtremepush.com/docs/user-setup.md): Process for a new user to set up their user account - [Connected accounts](https://docs.maxemail.xtremepush.com/docs/connected-accounts.md) - [Hubspot](https://docs.maxemail.xtremepush.com/docs/connect-hubspot.md) - [Microsoft Dynamics](https://docs.maxemail.xtremepush.com/docs/connect-microsoft-dynamics.md) - [Salesforce CRM](https://docs.maxemail.xtremepush.com/docs/connect-salesforce-crm.md) - [Salesforce recipient actions](https://docs.maxemail.xtremepush.com/docs/connect-salesforce-recipient-actions.md) - [Salesforce email details](https://docs.maxemail.xtremepush.com/docs/connect-salesforce-email-details.md) - [Salesforce recipient log](https://docs.maxemail.xtremepush.com/docs/connect-salesforce-recipient-log.md) - [Zapier connection](https://docs.maxemail.xtremepush.com/docs/connect-zapier.md) - [Profiles & Profile Fields](https://docs.maxemail.xtremepush.com/docs/profiles-and-profile-fields.md) - [Field types](https://docs.maxemail.xtremepush.com/docs/profiles-field-types.md) - [Create Profiles & Fields](https://docs.maxemail.xtremepush.com/docs/create-profiles-fields.md) - [Rename and delete Profiles](https://docs.maxemail.xtremepush.com/docs/rename-and-delete-profiles.md) - [Use Profile Field data in content](https://docs.maxemail.xtremepush.com/docs/profile-data-in-content.md) - [Engagement fields](https://docs.maxemail.xtremepush.com/docs/profile-engagement-fields.md) - [Recipient lists](https://docs.maxemail.xtremepush.com/docs/recipient-lists.md) - [Import a list](https://docs.maxemail.xtremepush.com/docs/list-import.md) - [Import options](https://docs.maxemail.xtremepush.com/docs/list-import-options.md) - [Schedule a list import](https://docs.maxemail.xtremepush.com/docs/list-import-schedule.md) - [View a list](https://docs.maxemail.xtremepush.com/docs/list-view.md) - [Append to a list](https://docs.maxemail.xtremepush.com/docs/list-append.md) - [Change list type](https://docs.maxemail.xtremepush.com/docs/list-type.md) - [Add & remove single recipient](https://docs.maxemail.xtremepush.com/docs/recipient-add-remove.md) - [Search for a recipient](https://docs.maxemail.xtremepush.com/docs/recipient-search.md) - [View & edit recipient data](https://docs.maxemail.xtremepush.com/docs/recipient-view-edit.md) - [Delete a recipient](https://docs.maxemail.xtremepush.com/docs/recipient-delete.md) - [System lists](https://docs.maxemail.xtremepush.com/docs/system-lists.md): Maxemail has a number of built-in lists which cannot be deleted - [Unsubscribe management](https://docs.maxemail.xtremepush.com/docs/unsubscribe-management.md) - [Exporting a list](https://docs.maxemail.xtremepush.com/docs/list-export.md) - [Recipients without lists](https://docs.maxemail.xtremepush.com/docs/recipients-without-lists.md) - [Segmentation](https://docs.maxemail.xtremepush.com/docs/segmentation.md) - [Behavioural criteria](https://docs.maxemail.xtremepush.com/docs/segmentation-behavioural-criteria.md) - [Datatables](https://docs.maxemail.xtremepush.com/docs/datatables.md) - [Creating Datatables](https://docs.maxemail.xtremepush.com/docs/datatable-create.md) - [Populating Datatables](https://docs.maxemail.xtremepush.com/docs/datatable-populate.md) - [Using Datatable fields](https://docs.maxemail.xtremepush.com/docs/datatable-fields.md) - [Dynamic lookup values](https://docs.maxemail.xtremepush.com/docs/datatable-dynamic-lookup-values.md) - [Data retention](https://docs.maxemail.xtremepush.com/docs/data-retention.md) - [Email Builder](https://docs.maxemail.xtremepush.com/docs/email-builder.md): Maxemail's Email Builder allows users to quickly create and edit beautiful content with no need for any HTML coding. - [Components](https://docs.maxemail.xtremepush.com/docs/email-builder-components.md) - [Email structure](https://docs.maxemail.xtremepush.com/docs/email-builder-structure.md): The first thing to consider on any email built using the Email Builder should be the structural components. - [Set column widths](https://docs.maxemail.xtremepush.com/docs/email-builder-column-widths.md) - [Setting base styles](https://docs.maxemail.xtremepush.com/docs/email-builder-base-styles.md) - [Borders & padding](https://docs.maxemail.xtremepush.com/docs/email-builder-borders-padding.md) - [Background images](https://docs.maxemail.xtremepush.com/docs/email-builder-background-images.md) - [Show outlines](https://docs.maxemail.xtremepush.com/docs/email-builder-outlines.md) - [Adding content](https://docs.maxemail.xtremepush.com/docs/email-builder-content.md) - [Adding text](https://docs.maxemail.xtremepush.com/docs/email-builder-text.md) - [Google Fonts](https://docs.maxemail.xtremepush.com/docs/google-fonts.md) - [Setting links](https://docs.maxemail.xtremepush.com/docs/email-builder-links.md) - [Buttons](https://docs.maxemail.xtremepush.com/docs/email-builder-buttons.md) - [Rounded corners](https://docs.maxemail.xtremepush.com/docs/email-builder-rounded-corners.md) - [Personalising content](https://docs.maxemail.xtremepush.com/docs/email-builder-personalising-content.md) - [Responsive design](https://docs.maxemail.xtremepush.com/docs/email-builder-responsive-design.md) - [Component stacking](https://docs.maxemail.xtremepush.com/docs/email-builder-responsive-component-stacking.md) - [Image Library](https://docs.maxemail.xtremepush.com/docs/image-library.md) - [Dynamic content](https://docs.maxemail.xtremepush.com/docs/dynamic-content.md) - [Rulesets](https://docs.maxemail.xtremepush.com/docs/dynamic-content-rulesets.md) - [Snippets](https://docs.maxemail.xtremepush.com/docs/dynamic-content-snippets.md) - [Email templates](https://docs.maxemail.xtremepush.com/docs/email-templates.md) - [Controlled Email Builder templates](https://docs.maxemail.xtremepush.com/docs/email-template-controlled-builder.md) - [Legacy Controlled templates](https://docs.maxemail.xtremepush.com/docs/email-template-controlled.md) - [Content tokens](https://docs.maxemail.xtremepush.com/docs/content-tokens.md) - [Date token](https://docs.maxemail.xtremepush.com/docs/token-date.md) - [Form token](https://docs.maxemail.xtremepush.com/docs/token-form.md) - [Merge token](https://docs.maxemail.xtremepush.com/docs/token-merge.md) - [Recipient token](https://docs.maxemail.xtremepush.com/docs/token-recipient.md) - [Ruleset token](https://docs.maxemail.xtremepush.com/docs/token-ruleset.md) - [Snippet token](https://docs.maxemail.xtremepush.com/docs/token-snippet.md) - [Unsubscribe tokens](https://docs.maxemail.xtremepush.com/docs/token-unsubscribe.md) - [Weblink token](https://docs.maxemail.xtremepush.com/docs/token-weblink.md) - [Token transforms](https://docs.maxemail.xtremepush.com/docs/token-transforms.md) - [Date format codes](https://docs.maxemail.xtremepush.com/docs/token-date-format-codes.md) - [Forms in Maxemail](https://docs.maxemail.xtremepush.com/docs/forms.md) - [Create standard form](https://docs.maxemail.xtremepush.com/docs/form-create.md) - [Form Setup tab](https://docs.maxemail.xtremepush.com/docs/form-tab-setup.md) - [Form details](https://docs.maxemail.xtremepush.com/docs/form-tab-setup-details.md) - [Google reCAPTCHA validation](https://docs.maxemail.xtremepush.com/docs/form-tab-setup-validation.md) - [Additional options](https://docs.maxemail.xtremepush.com/docs/form-tab-setup-additional-options.md) - [Available Profile Fields](https://docs.maxemail.xtremepush.com/docs/form-tab-setup-profile-fields.md) - [Form Builder tab](https://docs.maxemail.xtremepush.com/docs/form-tab-builder.md) - [Form properties](https://docs.maxemail.xtremepush.com/docs/form-tab-builder-form-properties.md) - [Item properties](https://docs.maxemail.xtremepush.com/docs/form-tab-builder-item-properties.md) - [Using a Maxemail form](https://docs.maxemail.xtremepush.com/docs/form-using.md) - [Add a form link to an email](https://docs.maxemail.xtremepush.com/docs/form-using-link-in-email.md) - [Form logging](https://docs.maxemail.xtremepush.com/docs/form-logging.md) - [Multivariate tests](https://docs.maxemail.xtremepush.com/docs/multivariate-tests.md) - [Getting help](https://docs.maxemail.xtremepush.com/docs/contact-us.md) - [Platform updates](https://docs.maxemail.xtremepush.com/docs/platform-updates.md) - [Verify your from address and use a custom domain](https://docs.maxemail.xtremepush.com/docs/verify-from-address-and-use-custom-domain.md): In order to send emails from Maxemail, you must verify theΒ From AddressΒ domain that you're going to use. - [IP allocation and warm-up](https://docs.maxemail.xtremepush.com/docs/ip-allocation-and-warm-up.md) - [How open tracking works](https://docs.maxemail.xtremepush.com/docs/how-open-tracking-works.md) - [Customise the unsubscribe landing page](https://docs.maxemail.xtremepush.com/docs/customise-unsubscribe-page.md): The text and colour of the unsubscribe pages can be adjusted to match client branding. - [Google Analytics and other tools](https://docs.maxemail.xtremepush.com/docs/google-analytics-and-others.md) - [Browser support](https://docs.maxemail.xtremepush.com/docs/browser-support.md) - [Data encryption](https://docs.maxemail.xtremepush.com/docs/data-encryption.md) - [Data subprocessors](https://docs.maxemail.xtremepush.com/docs/data-subprocessors.md): Third-parties used by Xtremepush to serve the Maxemail platform ## API Reference - [Maxemail Developer Guide](https://docs.maxemail.xtremepush.com/reference/developer-guide-overview.md) - [Key terms & concepts](https://docs.maxemail.xtremepush.com/reference/key-terms-concepts.md): Provides developers with a brief introduction to the system - [Maxemail API](https://docs.maxemail.xtremepush.com/reference/api.md) - [API user and authentication](https://docs.maxemail.xtremepush.com/reference/api-authentication.md) - [Endpoint URLs](https://docs.maxemail.xtremepush.com/reference/api-endpoint.md) - [API Communication Specification](https://docs.maxemail.xtremepush.com/reference/api-communication-specification.md): Detail on how Maxemail expects to decode received API requests and how it will format responses - [Guide to common solutions](https://docs.maxemail.xtremepush.com/reference/api-guide-common-solutions.md): Provides developers with solutions to common API tasks - [Download reporting data](https://docs.maxemail.xtremepush.com/reference/api-guide-download-reporting-data.md) - [Recurring campaigns](https://docs.maxemail.xtremepush.com/reference/api-guide-recurring-campaigns.md) - [Triggered emails](https://docs.maxemail.xtremepush.com/reference/api-guide-triggered-emails.md) - [Uploading data lists](https://docs.maxemail.xtremepush.com/reference/api-guide-upload-data-list.md) - [Transactional Emails](https://docs.maxemail.xtremepush.com/reference/transactional-emails.md) - [Transactional SMTP](https://docs.maxemail.xtremepush.com/reference/transactional-smtp.md) - [Transactional API](https://docs.maxemail.xtremepush.com/reference/transactional-api.md) - [Webhooks](https://docs.maxemail.xtremepush.com/reference/webhooks.md) - [ROI Tracking](https://docs.maxemail.xtremepush.com/reference/roi-tracking.md) - [ROI methods](https://docs.maxemail.xtremepush.com/reference/roi-tracking-methods.md): Methods available on the ROI Tracking javascript object `Mxm.Tracker` - [Cross-Domain ROI Tracking](https://docs.maxemail.xtremepush.com/reference/roi-tracking-cross-domain.md) - [Testing ROI Tracking](https://docs.maxemail.xtremepush.com/reference/roi-tracking-testing.md) - [ROI Tracking for Google Tag Manager](https://docs.maxemail.xtremepush.com/reference/roi-tracking-google-tag-manager.md) - [Server-side ROI Tracking](https://docs.maxemail.xtremepush.com/reference/roi-tracking-server-side.md) - [Basket Tracking](https://docs.maxemail.xtremepush.com/reference/basket-tracking.md) - [Basket Tracking methods](https://docs.maxemail.xtremepush.com/reference/basket-tracking-methods.md) - [Form Handler with HTML forms](https://docs.maxemail.xtremepush.com/reference/form-handler-with-html-forms.md) - [Form Handler direct submission](https://docs.maxemail.xtremepush.com/reference/form-handler-direct-submission.md) - [SAML SSO user authentication](https://docs.maxemail.xtremepush.com/reference/saml-sso-user-authentication.md): Configure single-sign-on using SAML - [Reseller setup](https://docs.maxemail.xtremepush.com/reference/reseller-setup.md) - [fetchAll](https://docs.maxemail.xtremepush.com/reference/campaign-fetchall-1.md): Lists all campaigns under specified folder - [find](https://docs.maxemail.xtremepush.com/reference/campaign-find-1.md): Get campaign details - [insert](https://docs.maxemail.xtremepush.com/reference/campaign-insert-1.md): Create a new Split Test - [update](https://docs.maxemail.xtremepush.com/reference/campaign-update-1.md): Update an existing campaign - [delete](https://docs.maxemail.xtremepush.com/reference/campaign-delete-1.md): Deletes an existing campaign - [copy](https://docs.maxemail.xtremepush.com/reference/campaign-copy-1.md): Copy an existing campaign to a new folder/name - [getAssignedLists](https://docs.maxemail.xtremepush.com/reference/campaign-getassignedlists-1.md): Retrieves a list of lists assigned to campaign - [setAssignedLists](https://docs.maxemail.xtremepush.com/reference/campaign-setassignedlists-1.md): Sets the list assignment for the campaign - [getAssignedSegments](https://docs.maxemail.xtremepush.com/reference/campaign-getassignedsegments-1.md): Retrieves a list of segments assigned to campaign - [setAssignedSegments](https://docs.maxemail.xtremepush.com/reference/campaign-setassignedsegments-1.md): Sets the segment assignment for the campaign - [calculateListTotal](https://docs.maxemail.xtremepush.com/reference/campaign-calculatelisttotal-1.md): Start the calculation of the total number of recipients the campaign will be sent to based on the include, exclude and segmentation applied - [getListTotal](https://docs.maxemail.xtremepush.com/reference/campaign-getlisttotal-1.md): Return the total number of recipients the campaign will be sent to based on the include, exclude and segmentation applied - [Data Export Quick](https://docs.maxemail.xtremepush.com/reference/data-export-quick.md) - [sent](https://docs.maxemail.xtremepush.com/reference/data_export_quick-sent-1.md): Generate a report for the recipient event, based on the filter provided - [delivered](https://docs.maxemail.xtremepush.com/reference/data_export_quick-delivered-1.md): Generate a report for the recipient event, based on the filter provided - [bounced](https://docs.maxemail.xtremepush.com/reference/data_export_quick-bounced-1.md): Generate a report for the recipient event, based on the filter provided - [opened](https://docs.maxemail.xtremepush.com/reference/data_export_quick-opened-1.md): Generate a report for the recipient event, based on the filter provided - [totalOpens](https://docs.maxemail.xtremepush.com/reference/data_export_quick-totalopens-1.md): Generate a report for the recipient event, based on the filter provided - [clicked](https://docs.maxemail.xtremepush.com/reference/data_export_quick-clicked-1.md): Generate a report for the recipient event, based on the filter provided - [totalClicks](https://docs.maxemail.xtremepush.com/reference/data_export_quick-totalclicks-1.md): Generate a report for the recipient event, based on the filter provided - [responded](https://docs.maxemail.xtremepush.com/reference/data_export_quick-responded-1.md): Generate a report for the recipient event, based on the filter provided - [unsubscribed](https://docs.maxemail.xtremepush.com/reference/data_export_quick-unsubscribed-1.md): Generate a report for the recipient event, based on the filter provided - [converted](https://docs.maxemail.xtremepush.com/reference/data_export_quick-converted-1.md): Generate a report for the recipient event, based on the filter provided - [totalConversions](https://docs.maxemail.xtremepush.com/reference/data_export_quick-totalconversions-1.md): Generate a report for the recipient event, based on the filter provided - [unsubscribeFeedback](https://docs.maxemail.xtremepush.com/reference/data_export_quick-unsubscribefeedback-1.md): Generate a report for the recipient event, based on the filter provided - [Data Export Quick Triggered](https://docs.maxemail.xtremepush.com/reference/data-export-quick-triggered.md) - [sent](https://docs.maxemail.xtremepush.com/reference/data_export_quick_triggered-sent-1.md): Generate a report for the recipient event, based on the filter provided - [delivered](https://docs.maxemail.xtremepush.com/reference/data_export_quick_triggered-delivered-1.md): Generate a report for the recipient event, based on the filter provided - [bounced](https://docs.maxemail.xtremepush.com/reference/data_export_quick_triggered-bounced-1.md): Generate a report for the recipient event, based on the filter provided - [opened](https://docs.maxemail.xtremepush.com/reference/data_export_quick_triggered-opened-1.md): Generate a report for the recipient event, based on the filter provided - [totalOpens](https://docs.maxemail.xtremepush.com/reference/data_export_quick_triggered-totalopens-1.md): Generate a report for the recipient event, based on the filter provided - [clicked](https://docs.maxemail.xtremepush.com/reference/data_export_quick_triggered-clicked-1.md): Generate a report for the recipient event, based on the filter provided - [totalClicks](https://docs.maxemail.xtremepush.com/reference/data_export_quick_triggered-totalclicks-1.md): Generate a report for the recipient event, based on the filter provided - [responded](https://docs.maxemail.xtremepush.com/reference/data_export_quick_triggered-responded-1.md): Generate a report for the recipient event, based on the filter provided - [unsubscribed](https://docs.maxemail.xtremepush.com/reference/data_export_quick_triggered-unsubscribed-1.md): Generate a report for the recipient event, based on the filter provided - [converted](https://docs.maxemail.xtremepush.com/reference/data_export_quick_triggered-converted-1.md): Generate a report for the recipient event, based on the filter provided - [totalConversions](https://docs.maxemail.xtremepush.com/reference/data_export_quick_triggered-totalconversions-1.md): Generate a report for the recipient event, based on the filter provided - [unsubscribeFeedback](https://docs.maxemail.xtremepush.com/reference/data_export_quick_triggered-unsubscribefeedback-1.md): Generate a report for the recipient event, based on the filter provided - [Data Export Quick SMS](https://docs.maxemail.xtremepush.com/reference/data-export-quick-sms.md) - [sent](https://docs.maxemail.xtremepush.com/reference/data_export_quick_sms-sent-1.md): Generate a report for the recipient event, based on the filter provided - [delivered](https://docs.maxemail.xtremepush.com/reference/data_export_quick_sms-delivered-1.md): Generate a report for the recipient event, based on the filter provided - [undelivered](https://docs.maxemail.xtremepush.com/reference/data_export_quick_sms-undelivered-1.md): Generate a report for the recipient event, based on the filter provided - [clicks](https://docs.maxemail.xtremepush.com/reference/data_export_quick_sms-clicks-1.md): Generate a report for the recipient event, based on the filter provided - [totalClicks](https://docs.maxemail.xtremepush.com/reference/data_export_quick_sms-totalclicks-1.md): Generate a report for the recipient event, based on the filter provided - [replies](https://docs.maxemail.xtremepush.com/reference/data_export_quick_sms-replies-1.md): Generate a report for the recipient event, based on the filter provided - [unsubscribes](https://docs.maxemail.xtremepush.com/reference/data_export_quick_sms-unsubscribes-1.md): Generate a report for the recipient event, based on the filter provided - [Data Export Quick Transactional](https://docs.maxemail.xtremepush.com/reference/data-export-quick-transactional.md) - [sent](https://docs.maxemail.xtremepush.com/reference/data_export_quick_transactional-sent-1.md): Generate a report for the recipient event, based on the filter provided - [delivered](https://docs.maxemail.xtremepush.com/reference/data_export_quick_transactional-delivered-1.md): Generate a report for the recipient event, based on the filter provided - [bounced](https://docs.maxemail.xtremepush.com/reference/data_export_quick_transactional-bounced-1.md): Generate a report for the recipient event, based on the filter provided - [opened](https://docs.maxemail.xtremepush.com/reference/data_export_quick_transactional-opened-1.md): Generate a report for the recipient event, based on the filter provided - [totalOpens](https://docs.maxemail.xtremepush.com/reference/data_export_quick_transactional-totalopens-1.md): Generate a report for the recipient event, based on the filter provided - [clicked](https://docs.maxemail.xtremepush.com/reference/data_export_quick_transactional-clicked-1.md): Generate a report for the recipient event, based on the filter provided - [totalClicks](https://docs.maxemail.xtremepush.com/reference/data_export_quick_transactional-totalclicks-1.md): Generate a report for the recipient event, based on the filter provided - [responded](https://docs.maxemail.xtremepush.com/reference/data_export_quick_transactional-responded-1.md): Generate a report for the recipient event, based on the filter provided - [fetchAll](https://docs.maxemail.xtremepush.com/reference/datatable-fetchall-1.md): Get a list of all Datatables, regardless of the position within the folder hierarchy - [find](https://docs.maxemail.xtremepush.com/reference/datatable-find-1.md): Get details for a single Datatable - [truncateTable](https://docs.maxemail.xtremepush.com/reference/datatable-truncatetable-1.md): Remove all rows from the specified Datatable > ❗️ Data loss > > This action clears all the data stored in the Datatable. - [fetchRows](https://docs.maxemail.xtremepush.com/reference/datatable-fetchrows-1.md): Fetch data rows from a Datatable - [findRow](https://docs.maxemail.xtremepush.com/reference/datatable-findrow-1.md): Get a single Datatable row - [addRow](https://docs.maxemail.xtremepush.com/reference/datatable-addrow-1.md): Add a row to a Datatable > πŸ“˜ Individual use only > > This method to add row data should only be used on an individual basis. To insert multiple rows, see the [datatable_import](ref:datatable_import-importuploadedfile) service. - [updateRow](https://docs.maxemail.xtremepush.com/reference/datatable-updaterow-1.md): Update a Datatable row - [deleteRow](https://docs.maxemail.xtremepush.com/reference/datatable-deleterow-1.md): Remove a single row from a Datatable - [fetchAll](https://docs.maxemail.xtremepush.com/reference/datatable_field-fetchall-1.md): Get a list of Datatable fields for the given Datatable ID - [fetchRecent](https://docs.maxemail.xtremepush.com/reference/datatable_import-fetchrecent-1.md): Get information about recent Datatable imports - [importUploadedFile](https://docs.maxemail.xtremepush.com/reference/datatable_import-importuploadedfile-1.md): Import an uploaded file to a Datatable using its upload key - [getProgress](https://docs.maxemail.xtremepush.com/reference/datatable_import-getprogress-1.md): Get details of a current or completed import - [fetchAll](https://docs.maxemail.xtremepush.com/reference/email_campaign-fetchall-1.md): Returns a list of email campaigns under the specified campaign. > πŸ“˜ Folder tree > > To fetch emails in a folder, use [tree.fetchTree](ref:tree-fetchtree). - [fetchByFilter](https://docs.maxemail.xtremepush.com/reference/email_campaign-fetchbyfilter-1.md): Returns a list of email campaigns based on the filter options - [find](https://docs.maxemail.xtremepush.com/reference/email_campaign-find-1.md): Get a single Email Campaign - [findByIdArray](https://docs.maxemail.xtremepush.com/reference/email_campaign-findbyidarray-1.md): Get a list of email campaigns belonging to the node IDs requested, filtered by date - [calculateListTotal](https://docs.maxemail.xtremepush.com/reference/email_campaign-calculatelisttotal-1.md): Calculates the total number of recipients the email campaign will be sent to based on the include, exclude and segmentation applied - [getListTotal](https://docs.maxemail.xtremepush.com/reference/email_campaign-getlisttotal-1.md): Return the total number of recipients the email campaign will be sent to based on the include, exclude and segmentation applied - [insert](https://docs.maxemail.xtremepush.com/reference/email_campaign-insert-1.md): Create a new email campaign > πŸ‘ Campaign or folder? > > Unless the email campaign should be added to an existing variable campaign (Split Test), then set the `folder_id` rather than the `campaign_id`. In this case a standard campaign is created automatically. - [update](https://docs.maxemail.xtremepush.com/reference/email_campaign-update-1.md): Update an existing email - [delete](https://docs.maxemail.xtremepush.com/reference/email_campaign-delete-1.md): Deletes the specified email - [copy](https://docs.maxemail.xtremepush.com/reference/email_campaign-copy-1.md): Copy an existing email to a new folder/campaign/name - [getSeedRecipients](https://docs.maxemail.xtremepush.com/reference/email_campaign-getseedrecipients-1.md): Retrieves a list of recipients assigned to the email who are marked with a record type of both or seed - [setContent](https://docs.maxemail.xtremepush.com/reference/email_campaign-setcontent-1.md): Set the message content for the email > ❗️ Deprecated > > This method will be removed in a future version. See [email_campaign.storeContent](ref:email_campaign-storecontent). - [storeContent](https://docs.maxemail.xtremepush.com/reference/email_campaign-storecontent-1.md): Set the message content for the email - [getContent](https://docs.maxemail.xtremepush.com/reference/email_campaign-getcontent-1.md): Get the message content for the email - [exportReport](https://docs.maxemail.xtremepush.com/reference/email_campaign-exportreport-1.md): Generates a report for the email campaign, which can then be downloaded - [triggerFolder](https://docs.maxemail.xtremepush.com/reference/email_send-triggerfolder-1.md): Choose a random live Triggered Email from the given folder, and queue it to the specified recipient for immediate send The system uses a weighted random choice, so that over the course of many sends, there is even distribution amongst all live Triggered Emails in the folder. Only Triggered Emails directly in the target folder are used; child folders are not used. Will fail if no Triggered Emails in the folder have `approved` status. - [triggerFolderDelay](https://docs.maxemail.xtremepush.com/reference/email_send-triggerfolderdelay-1.md): Queue a Triggered Email in the same manner as [triggerFolder](ref:email_send.triggerfolder) but send to the recipient after a defined delay; optionally cancel any existing queued emails The profile data is stored in the queue and is not set to the recipient until the delay period. This means any other changes that made to the recipient's profile data within the delay period will be overwritten for any fields contained in the profile data submitted with this method. - [cancelTriggerFolder](https://docs.maxemail.xtremepush.com/reference/email_send-canceltriggerfolder-1.md): Cancel any existing queued/delayed triggered emails which match the `folderId` and recipient - [trigger](https://docs.maxemail.xtremepush.com/reference/email_send-trigger-1.md): Queues a live triggered email to the specified recipient for immediate send Will fail if the triggered email status is not `approved`. > πŸ‘ Folder recommended > > Rather than trigger a single email, use [triggerFolder](ref:email_send-triggerfolder) instead. See [Guide to Triggered Emails](ref:api-guide-triggered-emails#the-api) for more information. - [triggerDelay](https://docs.maxemail.xtremepush.com/reference/email_send-triggerdelay-1.md): Queue a Triggered Email to send to a recipient after a defined delay; optionally cancel any existing queued emails The profile data is stored in the queue and is not set to the recipient until the delay period. This means any other changes that made to the recipient's profile data within the delay period will be overwritten for any fields contained in the profile data submitted with this method. > πŸ‘ Folder recommended > > Rather than trigger a single email, use [triggerFolderDelay](ref:email_send-triggerfolderdelay) instead. See [Guide to Triggered Emails](ref:api-guide-triggered-emails#the-api) for more information. - [cancelTrigger](https://docs.maxemail.xtremepush.com/reference/email_send-canceltrigger-1.md): Cancel any existing queued/delayed triggered emails which match the `emailId` and recipient > πŸ‘ Folder recommended > > Rather than trigger a single email, use [cancelTriggerFolder](ref:email_send-canceltriggerfolder) instead. See [Guide to Triggered Emails](ref:api-guide-triggered-emails#the-api) for more information. - [fetchAll](https://docs.maxemail.xtremepush.com/reference/email_triggered-fetchall-1.md): Lists all emails under specified folder - [find](https://docs.maxemail.xtremepush.com/reference/email_triggered-find-1.md): Get a single Triggered Email - [insert](https://docs.maxemail.xtremepush.com/reference/email_triggered-insert-1.md): Create a new triggered email - [update](https://docs.maxemail.xtremepush.com/reference/email_triggered-update-1.md): Update an existing email - [delete](https://docs.maxemail.xtremepush.com/reference/email_triggered-delete-1.md): Deletes the specified email - [copy](https://docs.maxemail.xtremepush.com/reference/email_triggered-copy-1.md): Copy an existing email to a new folder/name - [storeContent](https://docs.maxemail.xtremepush.com/reference/email_triggered-storecontent-1.md): Set the message content for the email - [getContent](https://docs.maxemail.xtremepush.com/reference/email_triggered-getcontent-1.md): Get the message content for the email - [fetchAll](https://docs.maxemail.xtremepush.com/reference/field_type-fetchall-1.md): Get a list of field types - [find](https://docs.maxemail.xtremepush.com/reference/field_type-find-1.md): Get details for a single field type - [fromUrl](https://docs.maxemail.xtremepush.com/reference/file_transfer-fromurl-1.md): Upload a file to the system from a URL - [fromFtp](https://docs.maxemail.xtremepush.com/reference/file_transfer-fromftp-1.md): Instruct the system to retrieve a file from an FTP or SFTP site - [initialise](https://docs.maxemail.xtremepush.com/reference/file_upload-initialise-1.md): Generate a unique key for a file upload This must be called to create the file upload record, to receive the file content via [file_upload.handle](ref:file_upload-handle). - [handle](https://docs.maxemail.xtremepush.com/reference/file_upload-handle-1.md): Uploads a file to be stored against the given file upload key The file upload key is generated from [file_upload.initialise](ref:file_upload-initialise). > πŸ‘ Content-type > > Note the `Content-type` header must be `multipart/form-data`. - [inspect](https://docs.maxemail.xtremepush.com/reference/file_upload-inspect-1.md): Inspects the uploaded file to return file information - [inspectCsv](https://docs.maxemail.xtremepush.com/reference/file_upload-inspectcsv-1.md): Inspects an uploaded CSV or zipped CSV file Similar result to [file_upload.inspect](ref:file_upload-inspect), but supplemented with information about the CSV data. - [fetchAll](https://docs.maxemail.xtremepush.com/reference/folder-fetchall-1.md): Get a list of folders > ❗️ Deprecated > > To fetch nodes within a folder, use [tree.fetchTree](ref:tree-fetchtree). - [find](https://docs.maxemail.xtremepush.com/reference/folder-find-1.md): Get details for a single folder - [insert](https://docs.maxemail.xtremepush.com/reference/folder-insert-1.md): Create a new folder in the specified parent - [update](https://docs.maxemail.xtremepush.com/reference/folder-update-1.md): Update an existing folder using the data specified - [delete](https://docs.maxemail.xtremepush.com/reference/folder-delete-1.md): Delete a folder > ❗️ Data loss > > If a folder is deleted, all child nodes of any type will also be deleted. - [fetchAll](https://docs.maxemail.xtremepush.com/reference/list-fetchall-1.md): Get a list of lists, regardless of the position within the folder hierarchy > πŸ“˜ Folder tree > > To fetch lists in a folder, use [tree.fetchTree](ref:tree-fetchtree). - [find](https://docs.maxemail.xtremepush.com/reference/list-find-1.md): Get details for a single list - [insert](https://docs.maxemail.xtremepush.com/reference/list-insert-1.md): Create a new list in the specified folder > 🚧 Resource limit > > The number of lists allowed within a the system is limited to 500. This method will return an error if this is exceeded. - [update](https://docs.maxemail.xtremepush.com/reference/list-update-1.md): Update an existing list using the data specified - [truncate](https://docs.maxemail.xtremepush.com/reference/list-truncate-1.md): Remove all recipients from the specified list > πŸ‘ Non-destructive operation > > This only removes recipients' association with the list, but does not delete the recipients, who may appear on other lists. - [delete](https://docs.maxemail.xtremepush.com/reference/list-delete-1.md): Delete a list > πŸ‘ Non-destructive operation > > Deleting does not delete the associated recipients, who may appear on other lists. - [fetchRecipients](https://docs.maxemail.xtremepush.com/reference/list-fetchrecipients-1.md): Fetch recipients from a list > ❗️ Deprecated > > This method will be removed in a future version. See [list.fetchRecipientsData](ref:list-fetchrecipientsdata). - [fetchRecipientsData](https://docs.maxemail.xtremepush.com/reference/list-fetchrecipientsdata-1.md): Fetch recipients from a list, with optional profile field data included - [fetchRecipient](https://docs.maxemail.xtremepush.com/reference/list-fetchrecipient-1.md): Get a single recipient's entry on a list - [insertRecipient](https://docs.maxemail.xtremepush.com/reference/list-insertrecipient.md): Add a recipient to a list > πŸ“˜ Individual use only > > This method to should only be used on an individual basis. To insert multiple recipients, see the [list_import](ref:list_import-importuploadedfile) service. - [updateRecipient](https://docs.maxemail.xtremepush.com/reference/list-updaterecipient-1.md): Update a recipient's record on a list > πŸ“˜ Profile data association > > The ability to include profile data here is a convenience for when also updating the recipient's list details. Profile data is not associated to a list, use [recipient.update](ref:recipient-update) when only updating profile field values. - [deleteRecipient](https://docs.maxemail.xtremepush.com/reference/list-deleterecipient-1.md): Remove a single recipient from a list > πŸ‘ Non-destructive operation > > This only removes the recipient's association with the list, but does not delete the recipient, who may appear on other lists. - [insert](https://docs.maxemail.xtremepush.com/reference/list_export-insert.md): Generate a new list export - [update](https://docs.maxemail.xtremepush.com/reference/list_export-update.md): Update an existing list export - [delete](https://docs.maxemail.xtremepush.com/reference/list_export-delete.md): Delete a list export - [getProgress](https://docs.maxemail.xtremepush.com/reference/list_export-getprogress.md): Get the progress of the generation of a list export - [fetchRecent](https://docs.maxemail.xtremepush.com/reference/list_import-fetchrecent.md): Get information about recent list imports - [importUploadedFile](https://docs.maxemail.xtremepush.com/reference/list_import-importuploadedfile.md): Import an uploaded file to a list using its upload key - [getProgress](https://docs.maxemail.xtremepush.com/reference/list_import-getprogress.md): Get details of a current or completed import - [fetchAll](https://docs.maxemail.xtremepush.com/reference/profile-fetchall-1.md): Get a list of profiles, regardless of the position within the folder hierarchy > ❗️ Deprecated > > To fetch profiles in a folder, use [tree.fetchTree](ref:tree-fetchtree). - [fetchAllWithFields](https://docs.maxemail.xtremepush.com/reference/profile-fetchallwithfields-1.md): Get a list of all profiles and their profile fields, regardless of the position within the folder hierarchy - [find](https://docs.maxemail.xtremepush.com/reference/profile-find-1.md): Get details for a single profile - [insert](https://docs.maxemail.xtremepush.com/reference/profile-insert-1.md): Create a new profile in the specified folder > πŸ‘ Root folder > > Set the `folder_id` to "profile" to create the new profile in the tree root. > 🚧 Resource limit > > The number of profiles allowed within a the system is limited to 40. This method will return an error if this is exceeded. - [update](https://docs.maxemail.xtremepush.com/reference/profile-update-1.md): Update an existing profile using the data specified - [delete](https://docs.maxemail.xtremepush.com/reference/profile-delete-1.md): Delete a profile > ❗️ Data loss > > If a profile is deleted, all recipient data stored its profile fields will be lost. - [fetchAll](https://docs.maxemail.xtremepush.com/reference/profile_field-fetchall-1.md): Get a list of profile fields for the given profile ID - [find](https://docs.maxemail.xtremepush.com/reference/profile_field-find-1.md): Get details for a single profile field - [insert](https://docs.maxemail.xtremepush.com/reference/profile_field-insert-1.md): Create a new field in the specified profile > 🚧 Resource limit > > The number of profile fields allowed within a single profile is limited to 50. This method will return an error if this is exceeded. - [update](https://docs.maxemail.xtremepush.com/reference/profile_field-update-1.md): Update an existing field using the data specified - [delete](https://docs.maxemail.xtremepush.com/reference/profile_field-delete-1.md): Delete a profile field > ❗️ Data loss > > If a field is deleted, all recipient data stored in this field will be lost. - [fetchLists](https://docs.maxemail.xtremepush.com/reference/recipient-fetchlists-1.md): Get lists to which the recipient belongs - [find](https://docs.maxemail.xtremepush.com/reference/recipient-find-1.md): Get recipient details - [insert](https://docs.maxemail.xtremepush.com/reference/recipient-insert-1.md): Add a new recipient > 🚧 Confirm the use-case > > This method is not typically needed for most use-cases. Typical workloads will add bulk recipients to a list using the [list_import](ref:list_import-importuploadedfile) service, or an individual recipient using [list.insertRecipient](ref:list-insertrecipient). - [update](https://docs.maxemail.xtremepush.com/reference/recipient-update-1.md): Update an existing recipient - [updateByEmailAddress](https://docs.maxemail.xtremepush.com/reference/recipient-updatebyemailaddress.md): Update an existing recipient - [findByEmailAddress](https://docs.maxemail.xtremepush.com/reference/recipient-findbyemailaddress-1.md): Get recipient ID for an email address - [findEmailAddress](https://docs.maxemail.xtremepush.com/reference/recipient-findemailaddress-1.md): Get recipients matching a partial email address - [fetchProfileDataByRecipientId](https://docs.maxemail.xtremepush.com/reference/recipient-fetchprofiledatabyrecipientid-1.md): Get recipient profile field values - [fetchProfileDataByEmailAddress](https://docs.maxemail.xtremepush.com/reference/recipient-fetchprofiledatabyemailaddress-1.md): Get recipient profile field values - [fetchSentEmailsByRecipientId](https://docs.maxemail.xtremepush.com/reference/recipient-fetchsentemailsbyrecipientid-1.md): Get details of emails sent to a recipient - [fetchSentEmailsByEmailAddress](https://docs.maxemail.xtremepush.com/reference/recipient-fetchsentemailsbyemailaddress-1.md): Get details of emails sent to a recipient - [fetchModifedRecipients](https://docs.maxemail.xtremepush.com/reference/recipient-fetchmodifedrecipients-1.md): Get recipients and their profile field values that have been updated since a specific time This method checks for updates to the recipient and the profiles included in `profileDescriptions`. - [fetchAll](https://docs.maxemail.xtremepush.com/reference/snippet-fetchall-1.md): Returns a list of snippets. > ❗️ Deprecated > > To fetch snippets in a folder, use [tree.fetchTree](ref:tree-fetchtree). - [find](https://docs.maxemail.xtremepush.com/reference/snippet-find-1.md): Get a single Snippet - [insert](https://docs.maxemail.xtremepush.com/reference/snippet-insert-1.md): Create a new snippet - [update](https://docs.maxemail.xtremepush.com/reference/snippet-update-1.md): Update an existing snippet - [copy](https://docs.maxemail.xtremepush.com/reference/snippet-copy-1.md): Copy an existing snippet to a new folder/name - [delete](https://docs.maxemail.xtremepush.com/reference/snippet-delete-1.md): Deletes the specified snippet - [setContent](https://docs.maxemail.xtremepush.com/reference/snippet-setcontent-1.md): Set the message content for the snippet > ❗️ Deprecated > > This method will be removed in a future version. See [snippet.storeContent](ref:snippet-storecontent). - [storeContent](https://docs.maxemail.xtremepush.com/reference/snippet-storecontent-1.md): Set the message content for the snippet - [getContent](https://docs.maxemail.xtremepush.com/reference/snippet-getcontent-1.md): Get the message content for the snippet - [send](https://docs.maxemail.xtremepush.com/reference/transactional-send.md): Send a Transactional Email - [getFromAddresses](https://docs.maxemail.xtremepush.com/reference/transactional-getfromaddresses.md): Requests a list of fromAddresses that have been used in Transactional Emails - [getTags](https://docs.maxemail.xtremepush.com/reference/transactional-gettags.md): Requests a list of tags that have been used in Transactional Emails - [fetchRoot](https://docs.maxemail.xtremepush.com/reference/tree-fetchroot-1.md): Details the specified tree - [fetchTree](https://docs.maxemail.xtremepush.com/reference/tree-fetchtree-1.md): Fetch children for a node in the tree - [fetchNode](https://docs.maxemail.xtremepush.com/reference/tree-fetchnode-1.md): Fetch details for the given tree node To fetch multiple, see [tree.fetchNodes](ref:tree-fetchnodes). - [fetchNodes](https://docs.maxemail.xtremepush.com/reference/tree-fetchnodes-1.md): Fetch details for the given tree nodes To fetch one, see [tree.fetchNode](ref:tree-fetchnode). ## Pages - [Data Processing Provisions](https://docs.maxemail.xtremepush.com/page/data-processing-provisions.md) - [Datacentre details](https://docs.maxemail.xtremepush.com/page/datacentre-details.md) - [Enterprise Key Functionality](https://docs.maxemail.xtremepush.com/page/enterprise-key-functionality.md) - [General Features](https://docs.maxemail.xtremepush.com/page/general-features.md) - [Go Key Functionality](https://docs.maxemail.xtremepush.com/page/go-key-functionality.md) - [Platform SLA](https://docs.maxemail.xtremepush.com/page/platform-sla.md) - [Standard Platform Support Services](https://docs.maxemail.xtremepush.com/page/standard-platform-support-services.md) - [Terms and Conditions of use](https://docs.maxemail.xtremepush.com/page/terms-and-conditions-of-use.md) ## Changelog - [December 2025](https://docs.maxemail.xtremepush.com/changelog/2025-december.md) - [September 2025](https://docs.maxemail.xtremepush.com/changelog/2025-september.md) - [June 2025](https://docs.maxemail.xtremepush.com/changelog/2025-june.md) - [December 2024](https://docs.maxemail.xtremepush.com/changelog/2024-december.md) - [October 2024](https://docs.maxemail.xtremepush.com/changelog/2024-october.md) - [April 2024](https://docs.maxemail.xtremepush.com/changelog/2024-april.md) - [February 2024](https://docs.maxemail.xtremepush.com/changelog/2024-february.md) - [May 2023](https://docs.maxemail.xtremepush.com/changelog/2023-may.md) - [August 2022](https://docs.maxemail.xtremepush.com/changelog/2022-august.md) - [November 2021](https://docs.maxemail.xtremepush.com/changelog/2021-november.md)