Struct ProtonApiSession 

pub struct ProtonApiSession { /* private fields */ }

An authenticated Proton API session.

Implementations

impl ProtonApiSession

pub fn resume( config: ProtonClientConfiguration, params: ResumeParameters, ) -> Result<Self>

Resume a session from previously obtained tokens.

pub async fn begin( config: ProtonClientConfiguration, username: &str, password: &[u8], ) -> Result<Self>

SRP password login.

Mirrors C# ProtonApiSession.BeginAsync: initiate an SRP session (auth/v4/info), run the client handshake, then authenticate (auth/v4). The returned session is ready for read/write workflows once the data password is applied (see CLAUDE.md key chain); if the account requires a second factor, [is_waiting_for_second_factor] is set and the caller must complete 2FA before authorized scopes are granted.

Both API calls are unauthenticated (no session id / bearer), matching the reference SDK.

pub async fn apply_second_factor_code(&mut self, code: &str) -> Result<()>

Submit a second-factor code (POST auth/v4/2fa).

Mirrors C# ProtonApiSession.ApplySecondFactorCodeAsync: on success the server returns the now-elevated scopes; clear the waiting flag and adopt them. Must be called on a session whose [is_waiting_for_second_factor] is set (typically right after [begin], before the session is shared with a Drive client).

pub async fn refresh_scopes(&mut self) -> Result<()>

Refresh the session’s authorized scopes (GET auth/v4/scopes).

Mirrors C# ProtonApiSession.RefreshScopesAsync.

pub async fn end(&self) -> Result<()>

End the session server-side (DELETE auth/v4).

pub fn http(&self) -> &ApiHttpClient

pub fn session_id(&self) -> &SessionId

pub fn user_id(&self) -> &UserId

pub fn username(&self) -> &str

pub fn scopes(&self) -> &[String]

pub fn password_mode(&self) -> PasswordMode

pub fn is_waiting_for_second_factor(&self) -> bool

Whether the account still needs a second-factor code before its scopes are fully authorized.

pub async fn current_tokens(&self) -> Tokens

Snapshot current tokens for persistence (they may have rotated on refresh).

Trait Implementations

impl Clone for ProtonApiSession

fn clone(&self) -> ProtonApiSession

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.