Document ClientBuilder #9
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mercxry
commented
Sep 3, 2023
| @@ -120,6 +172,7 @@ impl ClientBuilder { | |||
| self | |||
| } | |||
|
|
|||
| /// Set the originating IP address of the client connecting to the JMAP API. | |||
| pub fn forwarded_for(mut self, forwarded_for: IpAddr) -> Self { | |||
| self.forwarded_for = Some(match forwarded_for { | |||
| IpAddr::V4(addr) => format!("for={}", addr), | |||
There was a problem hiding this comment.
Out of curiosity, shouldn't the header name be X-Forwarded-For instead of for?
Or does the JMAP RFC specify something different? 🤔
Couldn't find anything by quickly searching in it.
|
Thanks, it has been merged. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello 👋,
Thanks for the library! I'm building a small side-project to automatically manage my emails with custom rules (Sieve rules are not advanced enough), and since I'm using a provider that has a JMAP API this library seems to come in handy.
While I was trying to build a PoC, I noticed that there isn't much documentation for how the library works, so I thought I'd contribute a little bit while I was learning how to use it by looking at the code 🙂.
Let me know if there is anything incorrect, I tried my best to document as much as possible regarding the
ClientBuilder, I might have misunderstood some cases since I'm not very familiar with the JMAP RFCs. Hopefully this helps a bit with issue #2 as well 😄.