Search.setIndex({docnames:["_api/airflow/providers/imap/hooks/imap/index","_api/airflow/providers/imap/hooks/index","_api/airflow/providers/imap/index","_api/airflow/providers/imap/sensors/imap_attachment/index","_api/airflow/providers/imap/sensors/index","commits","connections/imap","index","installing-providers-from-sources"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["_api/airflow/providers/imap/hooks/imap/index.rst","_api/airflow/providers/imap/hooks/index.rst","_api/airflow/providers/imap/index.rst","_api/airflow/providers/imap/sensors/imap_attachment/index.rst","_api/airflow/providers/imap/sensors/index.rst","commits.rst","connections/imap.rst","index.rst","installing-providers-from-sources.rst"],objects:{"airflow.providers":[[2,0,0,"-","imap"]],"airflow.providers.imap":[[1,0,0,"-","hooks"],[4,0,0,"-","sensors"]],"airflow.providers.imap.hooks":[[0,0,0,"-","imap"]],"airflow.providers.imap.hooks.imap":[[0,1,1,"","ImapHook"],[0,1,1,"","Mail"],[0,1,1,"","MailPart"]],"airflow.providers.imap.hooks.imap.ImapHook":[[0,2,1,"","__enter__"],[0,2,1,"","__exit__"],[0,3,1,"","conn_name_attr"],[0,3,1,"","conn_type"],[0,3,1,"","default_conn_name"],[0,2,1,"","download_mail_attachments"],[0,2,1,"","get_conn"],[0,2,1,"","has_mail_attachment"],[0,3,1,"","hook_name"],[0,2,1,"","retrieve_mail_attachments"]],"airflow.providers.imap.hooks.imap.Mail":[[0,2,1,"","get_attachments_by_name"],[0,2,1,"","has_attachments"]],"airflow.providers.imap.hooks.imap.MailPart":[[0,2,1,"","get_file"],[0,2,1,"","has_equal_name"],[0,2,1,"","has_matching_name"],[0,2,1,"","is_attachment"]],"airflow.providers.imap.sensors":[[3,0,0,"-","imap_attachment"]],"airflow.providers.imap.sensors.imap_attachment":[[3,1,1,"","ImapAttachmentSensor"]],"airflow.providers.imap.sensors.imap_attachment.ImapAttachmentSensor":[[3,2,1,"","poke"],[3,3,1,"","template_fields"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute"},terms:{"0":[0,1,2,3,4,6,8],"00642a46d0":5,"0080354502":5,"01":5,"02":5,"03":5,"032cf7cdbc":5,"04":5,"05":5,"05443c6dc8":5,"06":5,"07":5,"08":5,"08dfd8cd00":5,"09":5,"0a0e1af800":5,"0a68588479":5,"0aff69fbd2":5,"0b0e4f7a4c":5,"0b2":5,"0beta1":5,"10":[5,7],"10163":5,"10205":5,"10483":5,"10528":5,"10543":5,"11":[5,8],"11032":5,"11154":5,"11238":5,"11242":5,"11249":5,"11487":5,"11688":5,"11826":5,"11855":5,"12":[5,8],"12082":5,"12093":5,"12206":5,"12212":5,"12304":5,"12366":5,"12390":5,"12444":5,"12449":5,"12466":5,"12558":5,"12917":5,"12955":5,"12af6a0800":5,"12c5e5d8a":5,"13":5,"13148":5,"13380":5,"13717":5,"13767":5,"14013":5,"143":6,"14734":5,"14886":5,"15":5,"15301":5,"15393":5,"15576":5,"15667":[5,7],"16":5,"16294":5,"16405":5,"16464":5,"16501":5,"16e7129719":5,"17":5,"17682":5,"17890":5,"18":5,"19":5,"1d36b0303b":5,"1fba5402bb":5,"2":[0,1,2,3,4,6,8],"20":5,"2020":5,"2021":[5,8],"2022":5,"2037303eef":5,"20440":[5,7],"20441":[5,7],"20523":5,"20565":5,"20571":5,"20614":5,"20651":5,"20951":5,"20968":5,"21":5,"21257":5,"21439":5,"22":5,"22056":5,"23":5,"23rc1":5,"24":5,"24c8e4c2d6":5,"25":5,"25a5f553c3":5,"26":5,"27":5,"29":5,"295d66f914":5,"2a1":5,"3":[0,1,2,3,4,5,6,7,8],"30":5,"31":5,"32971a1a2d":5,"349b0811c3":5,"3696c34c28":5,"375d1ca229":5,"37681bca00":5,"3fd5ef3555":5,"406f":8,"41bf172c1d":5,"49":8,"4d03e33c11":5,"4d3a":8,"4e8f9cc8d0":5,"4fa9cfd7d":5,"512":8,"5220e4c384":5,"54":8,"59eb5de78c":5,"5a439e84eb":5,"5b2fe0e740":5,"5c6e":8,"6":5,"602abe8394":5,"6646":5,"6674":8,"6708":5,"6714":5,"6817":5,"6889a333cf":5,"68e4c4dcb0":5,"6c3a67d4fc":5,"6cf76d7ac0":5,"6e6526a0f6":5,"6f8ab9e6da":5,"7268":5,"7330":5,"7338":5,"7456":5,"76ed2a49c6":5,"7825e8f590":5,"7828":5,"8":5,"807ad32ce5":5,"85a18e13d9":5,"872b1566a1":5,"8807":5,"8886":5,"8891":5,"8898":5,"88bdcfa0df":5,"8984":5,"8994":5,"8ec4":8,"9026":5,"92585ca4cb":5,"9320":5,"9370":5,"9404":5,"9408":5,"9550":5,"97496ba2b4":5,"97a429f9d0":5,"9887":5,"993":6,"9a04013b0":5,"9b39f24780":5,"9c94b72d44":5,"class":[5,7],"do":8,"export":6,"final":5,"import":[5,7,8],"new":5,"return":[0,3],"super":5,"true":[0,3,6],By:8,For:[5,6,8],If:[0,3,6,7,8],It:[0,8],The:[0,3,6,8],There:8,To:8,__enter__:0,__exit__:0,__init__:5,a0821235fb:5,abl:0,about:[5,8],abov:[6,8],ac2f72c98d:5,access:[5,7],ad:5,add:[5,7],ae7cb4a1e2:5,after:5,against:3,aip:5,airflow:8,airflow_conn_imap_default:6,airflow_conn_imap_nonssl:6,aka:8,all:[0,3,5,6,7],allow:[3,5,7],alreadi:[0,8],also:[0,6,8],an:[0,1,2,3,4,5,6,7,8],ani:[0,8],anoth:6,apach:8,apache_airflow_providers_imap:8,api:7,appli:[5,7],apply_default:[5,7],ar:[0,7,8],arg:5,argument:5,asc:8,attach:[0,3],attachment_nam:3,august:5,authent:0,author:0,auto:[5,7],autoapi:5,autom:5,automat:[0,7],avail:8,b2a28d1590:5,b40dffa085:5,ba4b:8,backport:5,base:[0,3],basehook:0,basesensoroper:3,bash:8,batch:5,bbc627a3da:5,be75dcd39c:5,been:0,being:[3,6],belong:8,below:8,bin:8,binari:8,black:5,bodi:0,bool:[0,3],broader:3,broken:5,bst:8,buggfix:5,build:[5,8],c34ef853c8:5,c7e5bce57f:5,ca4238eb4d:5,call:[0,5],can:[3,6,7,8],candid:5,cbf8001d76:5,cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f:8,cde1:8,cdec301254:5,certif:8,certifi:8,cf141506a2:5,chang:[5,6],changelog:5,chapter:8,check:[0,3,5,8],check_regex:[0,3],checksum:8,choos:[6,8],classifi:7,cleanup:5,client:[0,6],close:0,code:8,com:[6,8],come:5,command:5,comment:5,commit:5,compat:5,complet:7,compon:6,conn_id:3,conn_name_attr:0,conn_typ:0,connect:[0,3,5,7],constructor:5,contain:[0,8],context:[0,3,5],correct:[5,8],coverag:5,creat:8,cross:5,curl:8,d0e7db4024:5,d200:5,d202:5,d56e7b56bb:5,d7de:8,d94fa37830:5,d:8,data:5,db:7,decemb:5,decor:[5,7],default_conn_nam:0,delai:5,dep:8,depend:[5,6],describ:8,descript:5,dest:8,detail:[0,3,5,7,8],dev0:[0,1,2,3,4,5,6,7,8],dev:5,dictionari:6,diff:8,differ:8,directori:[0,8],discoveri:5,distribut:8,doc:5,document:[5,7],down:8,download:[0,8],download_mail_attach:0,drop:8,due:7,dynam:5,e08a:8,each:0,ecf4:8,echo:8,ee7ca128a1:5,ee87953652:5,enabl:[5,6],encod:6,entri:5,environ:6,equal:[0,3],essenti:8,everyth:0,everywher:5,exampl:[6,8],exc_tb:0,exc_typ:0,exc_val:0,except:0,exist:7,experiment:[0,1,2,3,4,5,6,7,8],explicit:5,express:[0,3,5],extra:6,f3521fb0e3:5,f3e87c5030:5,f5b96315fe:5,f6bd817a3a:5,f77417eb0d:5,fals:[0,3,6],fdd9b6f65b:5,featur:[0,1,2,3,4,5,6,8],feb:5,field:[5,6],file:[0,5,7,8],filenam:0,find:0,find_first:0,fingerprint:8,first:[0,7],fix:5,folder:[0,3,8],follow:8,form:5,formmatt:5,found:0,foundat:8,framework:7,fresh:5,friendli:5,from:[0,5,7],gener:5,get:[0,3,8],get_attachments_by_nam:0,get_conn:0,get_fil:0,give:0,given:[0,3],gmail:8,good:8,gpg:8,grammar:5,grpc:5,guid:8,gz:8,ha:0,handl:5,happen:0,has_attach:0,has_equal_nam:0,has_mail_attach:0,has_matching_nam:0,hash:5,have:[5,7],high:5,hook:[2,5,6],hook_nam:0,host:6,how:8,http:8,i:8,id:[0,3,8],ignor:0,imap4:[0,3],imap:8,imap_attach:[2,4],imap_conn_id:[0,3],imap_default:[0,3,6],imapattachmentsensor:3,imaphook:[0,5],imaplib:[0,3],implement:5,implicit:5,improv:5,inbox:[0,3],includ:[0,5],increas:5,indic:8,individu:5,influenc:6,inform:[0,5],initi:7,insid:5,instal:5,instruct:8,integr:[0,5,6],internet:[5,7],introduc:5,is_attach:0,issu:5,issuer:8,its:0,januari:5,json:6,june:5,just:3,k8:5,ka:8,kaxil:8,kaxilnaik:8,kei:8,know:8,kwarg:3,l:8,la:8,latest:5,latest_onli:0,lazili:5,least:7,left:8,level:5,librari:0,line:5,link:[5,8],list:[0,5,7],local:[0,8],local_output_directori:0,log:0,logger:5,logging_mixin:0,loggingmixin:0,login:[0,6],logo:5,look:[0,3],ls:8,machin:0,made:8,magic:5,mail:[0,3],mail_bodi:0,mail_filt:[0,3],mail_fold:[0,3],mailpart:0,main:8,manag:[0,5,8],manual:7,markdown:5,match:[0,5,8],md:5,messag:[5,7],meta:5,migrat:7,mirror:8,miss:5,mktemp:8,modul:5,month:5,more:[0,5],most:8,move:5,myimap:6,mypi:5,naik:8,name:[0,3,5],non:6,none:8,not_found_mod:0,note:[5,6],notifi:0,now:5,number:5,o:8,object:0,octob:5,offici:8,onc:8,one:8,onli:[0,3],open:0,oper:[5,6],optimis:7,option:[5,6,7],org:8,origin:8,other:[0,3],otherwis:7,out:5,output:0,owner:8,package_nam:8,package_vers:8,page:[5,8],paramet:[0,3,6],pars:3,part:0,password:6,payload:0,per:5,pgp:8,pgpk:8,pgpv:8,pip:[5,7,8],pleas:[0,8],point:5,poke:3,popular:5,port:[5,6,7],prepar:5,present:3,previou:8,primari:8,print:0,project:5,protocol:[0,5,7],provid:8,provider_download_dir:8,py3:8,py:5,pydocstyl:5,pypi:[5,7],python2:5,python:[0,5,7,8],quit:0,rais:0,rc2:5,rc3:5,readm:[5,7],rebas:5,receiv:0,recommend:8,ref:5,refer:5,refernc:5,regardless:6,regener:5,regular:[0,3],relas:5,relat:[5,6],releas:[5,7],relev:8,rema:5,remain:5,remov:[5,7,8],renam:5,replac:5,repositori:7,requir:7,retriev:0,retrieve_mail_attach:0,rsa:8,run:[3,7,8],s:[0,3,5,8],sat:8,script:[5,8],sdist:8,search:[0,3],see:[0,3,5],select:8,self:[0,3,8],sensor:[2,5,6],sep:8,separ:5,sequenc:[3,5],server:[0,3,8],set:[0,3,5,6,7],setup:5,sha512:8,sha:8,shasum:8,should:[0,6,8],show:6,sign:8,signatur:[5,8],simplifi:[0,5],softwar:8,sourc:[0,3,7],specif:[0,3],specifi:[0,6],sphinx:5,squash:5,ssl:6,standard:6,step:8,str:[0,3],string:5,subject:5,sum:8,support:[0,5,7],synchron:5,syntax:6,t:0,tar:8,template_field:[3,5],temporari:8,than:[0,3],thi:[0,1,2,3,4,5,6,7,8],those:8,through:3,toc:5,tool:5,top:[7,8],transfer:5,trove:7,trust:8,tupl:0,type:[0,3,5,6,7],typehint:5,typo:5,uniqu:5,unknown:8,up:5,updat:[5,7],upgrad:[5,7],uri:6,url:6,us:[0,5,6,8],use_ssl:[5,6,7],user:8,usernam:6,utf:5,util:[0,3],valid:[0,8],valu:0,variabl:6,version:[5,7,8],via:[0,6,7,8],wait:3,want:[7,8],warn:[0,5,8],wave:5,well:8,what:0,when:[3,6],where:[0,3],whether:6,whl:8,why:8,won:0,word:5,work:0,worri:8,wrapper:0,wrong:5,wrongli:5,you:[0,3,6,7,8],your:7},titles:["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.imap.hooks.imap</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.imap.hooks</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.imap</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.imap.sensors.imap_attachment</span></code>","<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.imap.sensors</span></code>","Package apache-airflow-providers-imap","IMAP Connection","<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-imap</span></code>","Installing from sources"],titleterms:{"0":[5,7],"1":[5,7],"2":[5,7],"break":7,"class":[0,3],"default":6,airflow:[0,1,2,3,4,5,7],apach:[5,7],authent:6,chang:7,changelog:7,commit:7,configur:6,connect:6,content:[0,3,7],featur:7,from:8,hook:[0,1],id:6,imap:[0,1,2,3,4,5,6,7],imap_attach:3,instal:[7,8],integr:8,misc:7,modul:[0,3],packag:[5,7,8],provid:[0,1,2,3,4,5,7],pypi:8,refer:7,releas:8,resourc:7,sensor:[3,4],sourc:8,submodul:[1,4],subpackag:2,verifi:8}})