Susan Port (Support)

Description

Susan Port is an inbox management and support automation system that connects your WordPress site directly to your own Gmail account using Google OAuth 2.0.

This plugin helps you:

  • Triage incoming Gmail messages using your own rules
  • Move messages into Action or Actioned Gmail labels
  • Send template powered replies with variables such as sender name, subject, snippet, and site name
  • Use throttling to reduce repeat automatic replies
  • Test Gmail read, modify, and send permissions from WordPress
  • Extend workflows using separately installed optional add ons

Susan Port does not operate a central email processing service. Gmail data is exchanged directly between your WordPress site and Google after you configure your own Google OAuth credentials and authorize the connection.

Features

  • Gmail OAuth connection using credentials created by the site administrator
  • Gmail label configuration for Action and Actioned workflows
  • Custom rules with conditions on sender, domain, subject, or message text
  • Templates with tokens including {{sender_name}}, {{subject}}, {{snippet}}, and {{site_name}}
  • Throttled automatic replies
  • Inbox counters and Gmail testing tools
  • External cron endpoint for reliable background processing
  • Support for separately installed optional add ons

Privacy

Susan Port stores its configuration, OAuth credentials, access tokens, refresh tokens, rules, templates, and processing logs in the WordPress database on your site. Sensitive Google credentials and refresh tokens are stored in encrypted form by the plugin.

To provide Gmail functionality, the plugin communicates with Google services after the site administrator explicitly configures OAuth credentials and connects a Google account. Details of the information sent to Google are provided in the External services section below.

Susan Port does not transmit Gmail message content or OAuth tokens to the developer of this plugin.

Separately installed add ons may communicate with additional external services. Those add ons are responsible for documenting their own external-service usage and data handling.

External services

Google OAuth 2.0, OpenID Connect, and Gmail API

Susan Port requires Google services in order to connect to and work with a Gmail account. This functionality is not available until the site administrator enters their own Google OAuth Client ID and Client Secret and explicitly connects a Google account.

Depending on the action being performed, the plugin communicates with Google’s OAuth, OpenID Connect, and Gmail API endpoints.

Data sent to Google may include:

  • The OAuth Client ID, Client Secret, authorization code, redirect URI, and refresh token when authorizing or refreshing access
  • OAuth access tokens in authenticated API request headers
  • Gmail message and thread identifiers when reading or modifying messages
  • Gmail search queries when locating messages
  • Gmail label names and identifiers when listing, creating, adding, removing, or moving labels
  • Message content required by Gmail when Susan Port sends an automatic reply or a test email
  • The connected account identity when retrieving the account email address or Gmail profile

These requests occur only when the administrator connects Gmail, uses a Gmail testing tool, manually performs a Gmail-related action, or when a configured Susan Port background job processes Gmail.

Google provides these services. Please review Google’s terms and privacy information:

  • Google APIs Terms of Service: https://developers.google.com/terms
  • Google Terms of Service: https://policies.google.com/terms
  • Google Privacy Policy: https://policies.google.com/privacy

cron-job.org (optional)

The built-in documentation recommends cron-job.org as one optional way to call Susan Port’s external cron endpoint on a schedule. Susan Port does not create a cron-job.org account, send data to cron-job.org itself, or require that particular provider. You may use your hosting provider’s cron service or another scheduler instead.

If you choose cron-job.org, you manually provide it with the unique Susan Port cron endpoint URL. That URL contains the site’s cron secret. cron-job.org then sends scheduled HTTP POST requests to your WordPress site and may store the requested URL and response information according to its own policies.

  • cron-job.org Terms of Service: https://cron-job.org/en/tos/
  • cron-job.org Privacy Policy: https://cron-job.org/en/privacy/

External Cron Setup

Susan Port provides a secured external cron endpoint for background processing such as reading new Gmail messages, applying rules, sending configured replies, and running registered actions.

You will find the unique endpoint under Settings > Susan Port > External Cron. The URL contains a secret key and accepts POST requests.

How to set it up

  1. Open Settings > Susan Port > External Cron.
  2. Copy the endpoint URL.
  3. Create a scheduled HTTP request using your hosting provider, server cron, or another scheduler. cron-job.org is one optional provider.
  4. Set the request method to POST.
  5. Set the schedule to run every 5 minutes.
  6. Save the cron job.

Security

The cron endpoint contains a secret key unique to your site. Treat the URL as sensitive. You can rotate the key at any time using the Rotate Secret button. Rotating the key invalidates the previous endpoint URL, so remember to update your scheduler afterwards.

How Gmail Connection Works

Gmail access uses OAuth 2.0. You create and control the Google Cloud project and credentials used by your WordPress site.

The setup process is:

  • Create a Google Cloud project
  • Enable the Gmail API
  • Configure the OAuth consent screen
  • Add the exact Redirect URI displayed by Susan Port
  • Create an OAuth Client ID and Client Secret
  • Save those credentials in Susan Port
  • Click Connect and approve the requested Google permissions

The plugin requests Gmail read, modify, and send permissions together with OpenID and email identity permissions used to identify the connected account.

Screenshots

Installation

  1. Upload the plugin zip through Plugins > Add New and activate it.
  2. Go to Settings > Susan Port.
  3. Open the Gmail OAuth tab.
  4. Follow the Documentation tab to create a Google Cloud project and OAuth credentials.
  5. Paste your Client ID and Client Secret into Susan Port and save the settings.
  6. Click Connect to authorize Gmail.
  7. Configure your Action and Actioned labels.
  8. Create rules and templates for your workflow.
  9. Configure the external cron endpoint if you want reliable scheduled processing.

FAQ

Does Susan Port send my emails to the plugin developer?

No. Gmail data is exchanged directly between your WordPress site and Google. Susan Port does not send Gmail message content or OAuth tokens to the plugin developer.

Does Susan Port use an external service?

Yes. Gmail functionality requires Google’s OAuth and Gmail API services. See the External services section for exactly what is sent, when it is sent, and links to Google’s terms and privacy policy.

Do I provide my own Google OAuth credentials?

Yes. The site administrator creates a Google Cloud project and supplies the Client ID and Client Secret. Susan Port includes step by step setup documentation inside the plugin.

Can I use IMAP instead of the Gmail API?

No. Current versions use the Gmail API through OAuth.

Is an external cron service required?

Susan Port provides an HTTP cron endpoint so processing can run reliably on a schedule. You can call it from your own server or hosting provider. A third party service such as cron-job.org is optional.

Does Susan Port support add ons?

Yes. Separately installed add ons can register additional rule actions. Any external services used by an add on should be documented by that add on.

Reviews

There are no reviews for this plugin.

Contributors & Developers

“Susan Port (Support)” is open source software. The following people have contributed to this plugin.

Contributors

Translate “Susan Port (Support)” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

0.1.3

Harden settings and rule-action input validation.

0.1.2

Security, compatibility, documentation, and WordPress.org review updates.

0.1.0

Initial release.