Skip to content

Add OAuth2 authentication parameters for SMTP connections#2202

Open
KalinduGandara wants to merge 1 commit intowso2:mainfrom
KalinduGandara:fix_4772_main
Open

Add OAuth2 authentication parameters for SMTP connections#2202
KalinduGandara wants to merge 1 commit intowso2:mainfrom
KalinduGandara:fix_4772_main

Conversation

@KalinduGandara
Copy link
Copy Markdown
Contributor

This pull request updates the Email Connector documentation to improve and clarify OAuth2 authentication support. The main changes include expanding protocol support for OAuth2 and adding detailed configuration parameters.

OAuth2 Authentication Enhancements:

  • Updated the documentation to specify that OAuth2 authentication is now supported for IMAP, IMAPS, and SMTPS connections (previously, only IMAP and IMAPS were mentioned).
  • Added a new section to the connection configuration parameters table detailing all OAuth2-related configuration options, including enabling OAuth2, grant type, client credentials, token URL, and scope.

Fixes: wso2/product-integrator-mi#4772

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 27, 2026

Warning

Rate limit exceeded

@KalinduGandara has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 35 minutes and 24 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0279ee9d-e6dd-4ac8-ad0c-479c6d18fda2

📥 Commits

Reviewing files that changed from the base of the PR and between c4c1b68 and 315a4cf.

📒 Files selected for processing (2)
  • en/docs/reference/connectors/email-connector/1.x/email-connector-1.x-config.md
  • en/docs/reference/connectors/email-connector/email-connector-config.md
📝 Walkthrough

Walkthrough

The pull request updates documentation for the Email Connector to reflect OAuth2 authentication support for SMTPS connections. The first change extends the OAuth2 scope description in the 1.x configuration documentation to include SMTPS alongside existing IMAP and IMAPS protocols. The second change introduces a new OAuth2 authentication subsection in the main SMTPS configuration documentation, detailing configurable fields for OAuth2 setup including grant type, client credentials, refresh token, token URL, and scope—all marked as optional parameters.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description covers the main changes and links to the relevant issue, but lacks details from the required template sections such as Purpose, Goals, Approach, and other standard sections. Expand the description to follow the repository template more closely, including explicit Purpose, Goals, and Approach sections, plus any relevant Testing and Documentation details.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main change: adding OAuth2 authentication parameters for SMTP connections, which is the primary objective of the PR.
Linked Issues check ✅ Passed The PR fully addresses the objective to extend OAuth2 authentication support to SMTP/SMTPS connections by documenting new OAuth2 configuration parameters for SMTPS and updating scope descriptions.
Out of Scope Changes check ✅ Passed All changes are directly related to the linked issue #4772; documentation updates focus exclusively on OAuth2 support for SMTP/SMTPS connections with no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@en/docs/reference/connectors/email-connector/email-connector-config.md`:
- Line 209: Update the table header markup and casing: locate the table header
element shown as "<th colspan=\"3\">Oauth2 Authentication</td>" and change the
closing tag to "</th>" and the text "Oauth2" to "OAuth2" so it reads "<th
colspan=\"3\">OAuth2 Authentication</th>", ensuring valid HTML and consistent
casing.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d87ce227-8d40-446e-8b54-22f17adff3f8

📥 Commits

Reviewing files that changed from the base of the PR and between 86448ba and c4c1b68.

📒 Files selected for processing (2)
  • en/docs/reference/connectors/email-connector/1.x/email-connector-1.x-config.md
  • en/docs/reference/connectors/email-connector/email-connector-config.md

Comment thread en/docs/reference/connectors/email-connector/email-connector-config.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

OAuth2 Authentication Support for SMTP/SMTPS connections in Email Connector

1 participant