Cloud Mail 2020 Python Edition

Questions / Feedback?

on_set_cookie Event

Fired for every cookie set by the server.

Syntax

class OAuthSetCookieEventParams(object):
  @property
  def name() -> str: ...
  @property
  def value() -> str: ...
  @property
  def expires() -> str: ...
  @property
  def domain() -> str: ...
  @property
  def path() -> str: ...
  @property
  def secure() -> bool: ...

# In class OAuth:
@property
def on_set_cookie() -> Callable[[OAuthSetCookieEventParams], None]: ...
@on_set_cookie.setter
def on_set_cookie(event_hook: Callable[[OAuthSetCookieEventParams], None]) -> None: ...

Remarks

The on_set_cookie event is fired for every "Set-Cookie:" header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (url_server) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (url_path) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted through a secure (HTTPS) connection only.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
Cloud Mail 2020 Python Edition - Version 20.0 [Build 7718]