123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>MailKit</name>
- </assembly>
- <members>
- <member name="T:MailKit.Net.Imap.ImapClient">
- <summary>
- An IMAP client that can be used to retrieve messages from a server.
- </summary>
- <remarks>
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> class supports both the "imap" and "imaps"
- protocols. The "imap" protocol makes a clear-text connection to the IMAP
- server and does not use SSL or TLS unless the IMAP server supports the
- <a href="https://tools.ietf.org/html/rfc3501#section-6.2.1">STARTTLS</a> extension.
- The "imaps" protocol, however, connects to the IMAP server using an
- SSL-wrapped connection.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.CompressAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously enable compression over the IMAP connection.
- </summary>
- <remarks>
- <para>Asynchronously enables compression over the IMAP connection.</para>
- <para>If the IMAP server supports the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Compress"/> extension,
- it is possible at any point after connecting to enable compression to reduce network
- bandwidth usage. Ideally, this method should be called before authenticating.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Compression must be enabled before a folder has been selected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the COMPRESS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the COMPRESS command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.EnableQuickResyncAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously enable the QRESYNC feature.
- </summary>
- <remarks>
- <para>Enables the <a href="https://tools.ietf.org/html/rfc5162">QRESYNC</a> feature.</para>
- <para>The QRESYNC extension improves resynchronization performance of folders by
- querying the IMAP server for a list of changes when the folder is opened using the
- <see cref="M:MailKit.Net.Imap.ImapFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/>
- method.</para>
- <para>If this feature is enabled, the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event is replaced
- with the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event.</para>
- <para>This method needs to be called immediately after calling one of the
- <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a> methods, before
- opening any folders.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Quick resynchronization needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the QRESYNC extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ENABLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.EnableUTF8Async(System.Threading.CancellationToken)">
- <summary>
- Asynchronously enable the UTF8=ACCEPT extension.
- </summary>
- <remarks>
- Enables the <a href="https://tools.ietf.org/html/rfc6855">UTF8=ACCEPT</a> extension.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- UTF8=ACCEPT needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the UTF8=ACCEPT extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ENABLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.IdentifyAsync(MailKit.Net.Imap.ImapImplementation,System.Threading.CancellationToken)">
- <summary>
- Asynchronously identify the client implementation to the server and obtain the server implementation details.
- </summary>
- <remarks>
- <para>Passes along the client implementation details to the server while also obtaining implementation
- details from the server.</para>
- <para>If the <paramref name="clientImplementation"/> is <c>null</c> or no properties have been set, no
- identifying information will be sent to the server.</para>
- <note type="security">
- <para>Security Implications</para>
- <para>This command has the danger of violating the privacy of users if misused. Clients should
- notify users that they send the ID command.</para>
- <para>It is highly desirable that implementations provide a method of disabling ID support, perhaps by
- not calling this method at all, or by passing <c>null</c> as the <paramref name="clientImplementation"/>
- argument.</para>
- <para>Implementors must exercise extreme care in adding properties to the <paramref name="clientImplementation"/>.
- Some properties, such as a processor ID number, Ethernet address, or other unique (or mostly unique) identifier
- would allow tracking of users in ways that violate user privacy expectations and may also make it easier for
- attackers to exploit security holes in the client.</para>
- </note>
- </remarks>
- <returns>The implementation details of the server if available; otherwise, <c>null</c>.</returns>
- <param name="clientImplementation">The client implementation.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ID extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ID command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.AuthenticateAsync(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.AuthenticateAsync(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>If the IMAP server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then LOGIN command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="encoding">The text encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.ConnectAsync(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified IMAP server.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified IMAP or IMAP/S server.</para>
- <para>If the <paramref name="port"/> has a value of <c>0</c>, then the
- <paramref name="options"/> parameter is used to determine the default port to
- connect to. The default port used with <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>
- is <c>993</c>. All other values will use a default port of <c>143</c>.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>993</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> will be
- populated.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the IMAP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.ConnectAsync(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified IMAP or IMAP/S server using the provided socket.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified IMAP or IMAP/S server using
- the provided socket.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>993</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the IMAP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.ConnectAsync(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified IMAP or IMAP/S server using the provided stream.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified IMAP or IMAP/S server using
- the provided stream.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>993</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="stream">The stream to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the IMAP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.DisconnectAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously disconnect the service.
- </summary>
- <remarks>
- If <paramref name="quit"/> is <c>true</c>, a <c>LOGOUT</c> command will be issued in order to disconnect cleanly.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="quit">If set to <c>true</c>, a <c>LOGOUT</c> command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.NoOpAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously ping the IMAP server to keep the connection alive.
- </summary>
- <remarks>
- <para>The <c>NOOP</c> command is typically used to keep the connection with the IMAP server
- alive. When a client goes too long (typically 30 minutes) without sending any commands to the
- IMAP server, the IMAP server will close the connection with the client, forcing the client to
- reconnect before it can send any more commands.</para>
- <para>The <c>NOOP</c> command also provides a great way for a client to check for new
- messages.</para>
- <para>When the IMAP server receives a <c>NOOP</c> command, it will reply to the client with a
- list of pending updates such as <c>EXISTS</c> and <c>RECENT</c> counts on the currently
- selected folder. To receive these notifications, subscribe to the
- <see cref="E:MailKit.MailFolder.CountChanged"/> and <see cref="E:MailKit.MailFolder.RecentChanged"/> events,
- respectively.</para>
- <para>For more information about the <c>NOOP</c> command, see
- <a href="https://tools.ietf.org/html/rfc3501#section-6.1.2">rfc3501</a>.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOOP command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.IdleAsync(System.Threading.CancellationToken,System.Threading.CancellationToken)">
- <summary>
- Asynchronously toggle the <see cref="T:MailKit.Net.Imap.ImapClient"/> into the IDLE state.
- </summary>
- <remarks>
- <para>When a client enters the IDLE state, the IMAP server will send
- events to the client as they occur on the selected folder. These events
- may include notifications of new messages arriving, expunge notifications,
- flag changes, etc.</para>
- <para>Due to the nature of the IDLE command, a folder must be selected
- before a client can enter into the IDLE state. This can be done by
- opening a folder using
- <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- or any of the other variants.</para>
- <para>While the IDLE command is running, no other commands may be issued until the
- <paramref name="doneToken"/> is cancelled.</para>
- <note type="note">It is especially important to cancel the <paramref name="doneToken"/>
- before cancelling the <paramref name="cancellationToken"/> when using SSL or TLS due to
- the fact that <see cref="T:System.Net.Security.SslStream"/> cannot be polled.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="doneToken">The cancellation token used to return to the non-idle state.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="doneToken"/> must be cancellable (i.e. <see cref="P:System.Threading.CancellationToken.None"/> cannot be used).
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- A <see cref="T:MailKit.Net.Imap.ImapFolder"/> has not been opened.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the IDLE extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the IDLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.NotifyAsync(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)">
- <summary>
- Asynchronously request the specified notification events from the IMAP server.
- </summary>
- <remarks>
- <para>The <a href="https://tools.ietf.org/html/rfc5465">NOTIFY</a> command is used to expand
- which notifications the client wishes to be notified about, including status notifications
- about folders other than the currently selected folder. It can also be used to automatically
- FETCH information about new messages that have arrived in the currently selected folder.</para>
- <para>This, combined with <see cref="M:MailKit.Net.Imap.ImapClient.IdleAsync(System.Threading.CancellationToken,System.Threading.CancellationToken)"/>,
- can be used to get instant notifications for changes to any of the specified folders.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="status"><c>true</c> if the server should immediately notify the client of the
- selected folder's status; otherwise, <c>false</c>.</param>
- <param name="eventGroups">The specific event groups that the client would like to receive notifications for.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="eventGroups"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="eventGroups"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- One or more <see cref="T:MailKit.Net.Imap.ImapEventGroup"/> is invalid.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the NOTIFY extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOTIFY command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.DisableNotifyAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously disable any previously requested notification events from the IMAP server.
- </summary>
- <remarks>
- Disables any notification events requested in a prior call to
- <see cref="M:MailKit.Net.Imap.ImapClient.NotifyAsync(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)"/>.
- request.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the NOTIFY extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOTIFY command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetFoldersAsync(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The namespace folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the LIST or LSUB command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetFolderAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the folder for the specified path.
- </summary>
- <remarks>
- Gets the folder for the specified path.
- </remarks>
- <returns>The folder.</returns>
- <param name="path">The folder path.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="path"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the IDLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetMetadataAsync(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA or METADATA-SERVER extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetMetadataAsync(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="tags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA or METADATA-SERVER extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.SetMetadataAsync(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Sets the specified metadata.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="metadata"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA or METADATA-SERVER extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapClient"/> class.
- </summary>
- <remarks>
- Before you can retrieve messages with the <see cref="T:MailKit.Net.Imap.ImapClient"/>, you must first
- call one of the <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a>
- methods and then authenticate with the one of the
- <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a>
- methods.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.#ctor(MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapClient"/> class.
- </summary>
- <remarks>
- Before you can retrieve messages with the <see cref="T:MailKit.Net.Imap.ImapClient"/>, you must first
- call one of the <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a>
- methods and then authenticate with the one of the
- <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a>
- methods.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="ProtocolLogger"/>
- </example>
- <param name="protocolLogger">The protocol logger.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="protocolLogger"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the IMAP server.
- </summary>
- <remarks>
- <para>Gets an object that can be used to synchronize access to the IMAP server.</para>
- <para>When using the non-Async methods from multiple threads, it is important to lock the
- <see cref="P:MailKit.Net.Imap.ImapClient.SyncRoot"/> object for thread safety when using the synchronous methods.</para>
- </remarks>
- <value>The lock object.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.Protocol">
- <summary>
- Get the protocol supported by the message service.
- </summary>
- <remarks>
- Gets the protocol supported by the message service.
- </remarks>
- <value>The protocol.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.Capabilities">
- <summary>
- Get the capabilities supported by the IMAP server.
- </summary>
- <remarks>
- The capabilities will not be known until a successful connection has been made via one of
- the <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a> methods and may
- change as a side-effect of calling one of the
- <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a>
- methods.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The capabilities.</value>
- <exception cref="T:System.ArgumentException">
- Capabilities cannot be enabled, they may only be disabled.
- </exception>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.AppendLimit">
- <summary>
- Gets the maximum size of a message that can be appended to a folder.
- </summary>
- <remarks>
- <para>Gets the maximum size of a message, in bytes, that can be appended to a folder.</para>
- <note type="note">If the value is not set, then the limit is unspecified.</note>
- </remarks>
- <value>The append limit.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.InternationalizationLevel">
- <summary>
- Gets the internationalization level supported by the IMAP server.
- </summary>
- <remarks>
- <para>Gets the internationalization level supported by the IMAP server.</para>
- <para>For more information, see
- <a href="https://tools.ietf.org/html/rfc5255#section-4">section 4 of rfc5255</a>.</para>
- </remarks>
- <value>The internationalization level.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.Rights">
- <summary>
- Get the access rights supported by the IMAP server.
- </summary>
- <remarks>
- These rights are additional rights supported by the IMAP server beyond the standard rights
- defined in <a href="https://tools.ietf.org/html/rfc4314#section-2.1">section 2.1 of rfc4314</a>
- and will not be populated until the client is successfully connected.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The rights.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.CreateImapFolder(MailKit.Net.Imap.ImapFolderConstructorArgs)">
- <summary>
- Instantiate a new <see cref="T:MailKit.Net.Imap.ImapFolder"/>.
- </summary>
- <remarks>
- <para>Creates a new <see cref="T:MailKit.Net.Imap.ImapFolder"/> instance.</para>
- <note type="note">This method's purpose is to allow subclassing <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</note>
- </remarks>
- <returns>The IMAP folder instance.</returns>
- <param name="args">The constructior arguments.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="args"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Compress(System.Threading.CancellationToken)">
- <summary>
- Enable compression over the IMAP connection.
- </summary>
- <remarks>
- <para>Enables compression over the IMAP connection.</para>
- <para>If the IMAP server supports the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Compress"/> extension,
- it is possible at any point after connecting to enable compression to reduce network
- bandwidth usage. Ideally, this method should be called before authenticating.</para>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Compression must be enabled before a folder has been selected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Compress"/> extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the COMPRESS command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)">
- <summary>
- Enable the QRESYNC feature.
- </summary>
- <remarks>
- <para>Enables the <a href="https://tools.ietf.org/html/rfc5162">QRESYNC</a> feature.</para>
- <para>The QRESYNC extension improves resynchronization performance of folders by
- querying the IMAP server for a list of changes when the folder is opened using the
- <see cref="M:MailKit.Net.Imap.ImapFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/>
- method.</para>
- <para>If this feature is enabled, the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event is replaced
- with the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event.</para>
- <para>This method needs to be called immediately after calling one of the
- <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a> methods, before
- opening any folders.</para>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Quick resynchronization needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the QRESYNC extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ENABLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.EnableUTF8(System.Threading.CancellationToken)">
- <summary>
- Enable the UTF8=ACCEPT extension.
- </summary>
- <remarks>
- Enables the <a href="https://tools.ietf.org/html/rfc6855">UTF8=ACCEPT</a> extension.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- UTF8=ACCEPT needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the UTF8=ACCEPT extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ENABLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Identify(MailKit.Net.Imap.ImapImplementation,System.Threading.CancellationToken)">
- <summary>
- Identify the client implementation to the server and obtain the server implementation details.
- </summary>
- <remarks>
- <para>Passes along the client implementation details to the server while also obtaining implementation
- details from the server.</para>
- <para>If the <paramref name="clientImplementation"/> is <c>null</c> or no properties have been set, no
- identifying information will be sent to the server.</para>
- <note type="security">
- <para>Security Implications</para>
- <para>This command has the danger of violating the privacy of users if misused. Clients should
- notify users that they send the ID command.</para>
- <para>It is highly desirable that implementations provide a method of disabling ID support, perhaps by
- not calling this method at all, or by passing <c>null</c> as the <paramref name="clientImplementation"/>
- argument.</para>
- <para>Implementors must exercise extreme care in adding properties to the <paramref name="clientImplementation"/>.
- Some properties, such as a processor ID number, Ethernet address, or other unique (or mostly unique) identifier
- would allow tracking of users in ways that violate user privacy expectations and may also make it easier for
- attackers to exploit security holes in the client.</para>
- </note>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <returns>The implementation details of the server if available; otherwise, <c>null</c>.</returns>
- <param name="clientImplementation">The client implementation.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ID extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ID command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms">
- <summary>
- Get the authentication mechanisms supported by the IMAP server.
- </summary>
- <remarks>
- <para>The authentication mechanisms are queried as part of the
- <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a>
- method.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> hash set
- before authenticating.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The authentication mechanisms.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.ThreadingAlgorithms">
- <summary>
- Get the threading algorithms supported by the IMAP server.
- </summary>
- <remarks>
- The threading algorithms are queried as part of the
- <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a>
- and <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a> methods.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The supported threading algorithms.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.Timeout">
- <summary>
- Get or set the timeout for network streaming operations, in milliseconds.
- </summary>
- <remarks>
- Gets or sets the underlying socket stream's <see cref="P:System.IO.Stream.ReadTimeout"/>
- and <see cref="P:System.IO.Stream.WriteTimeout"/> values.
- </remarks>
- <value>The timeout in milliseconds.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.IsConnected">
- <summary>
- Get whether or not the client is currently connected to an IMAP server.
- </summary>
- <remarks>
- <para>The <see cref="P:MailKit.Net.Imap.ImapClient.IsConnected"/> state is set to <c>true</c> immediately after
- one of the <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a>
- methods succeeds and is not set back to <c>false</c> until either the client
- is disconnected via <see cref="M:MailKit.Net.Imap.ImapClient.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> or until an
- <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> is thrown while attempting to read or write to
- the underlying network socket.</para>
- <para>When an <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> is caught, the connection state of the
- <see cref="T:MailKit.Net.Imap.ImapClient"/> should be checked before continuing.</para>
- </remarks>
- <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.IsSecure">
- <summary>
- Get whether or not the connection is secure (typically via SSL or TLS).
- </summary>
- <remarks>
- Gets whether or not the connection is secure (typically via SSL or TLS).
- </remarks>
- <value><c>true</c> if the connection is secure; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.IsAuthenticated">
- <summary>
- Get whether or not the client is currently authenticated with the IMAP server.
- </summary>
- <remarks>
- <para>Gets whether or not the client is currently authenticated with the IMAP server.</para>
- <para>To authenticate with the IMAP server, use one of the
- <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a>
- methods.</para>
- </remarks>
- <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.IsIdle">
- <summary>
- Get whether or not the client is currently in the IDLE state.
- </summary>
- <remarks>
- Gets whether or not the client is currently in the IDLE state.
- </remarks>
- <value><c>true</c> if an IDLE command is active; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Authenticate(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Authenticate(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>If the IMAP server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then LOGIN command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <param name="encoding">The text encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Connect(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified IMAP server.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified IMAP or IMAP/S server.</para>
- <para>If the <paramref name="port"/> has a value of <c>0</c>, then the
- <paramref name="options"/> parameter is used to determine the default port to
- connect to. The default port used with <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>
- is <c>993</c>. All other values will use a default port of <c>143</c>.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>993</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> will be
- populated.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the IMAP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Connect(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified IMAP or IMAP/S server using the provided socket.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified IMAP or IMAP/S server using
- the provided socket.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>993</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- <para>The <paramref name="host"/> is a zero-length string.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the IMAP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Connect(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified IMAP or IMAP/S server using the provided stream.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified IMAP or IMAP/S server using
- the provided stream.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>993</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <param name="stream">The stream to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the IMAP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- An IMAP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Disconnect(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Disconnect the service.
- </summary>
- <remarks>
- If <paramref name="quit"/> is <c>true</c>, a <c>LOGOUT</c> command will be issued in order to disconnect cleanly.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- <param name="quit">If set to <c>true</c>, a <c>LOGOUT</c> command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.NoOp(System.Threading.CancellationToken)">
- <summary>
- Ping the IMAP server to keep the connection alive.
- </summary>
- <remarks>
- <para>The <c>NOOP</c> command is typically used to keep the connection with the IMAP server
- alive. When a client goes too long (typically 30 minutes) without sending any commands to the
- IMAP server, the IMAP server will close the connection with the client, forcing the client to
- reconnect before it can send any more commands.</para>
- <para>The <c>NOOP</c> command also provides a great way for a client to check for new
- messages.</para>
- <para>When the IMAP server receives a <c>NOOP</c> command, it will reply to the client with a
- list of pending updates such as <c>EXISTS</c> and <c>RECENT</c> counts on the currently
- selected folder. To receive these notifications, subscribe to the
- <see cref="E:MailKit.MailFolder.CountChanged"/> and <see cref="E:MailKit.MailFolder.RecentChanged"/> events,
- respectively.</para>
- <para>For more information about the <c>NOOP</c> command, see
- <a href="https://tools.ietf.org/html/rfc3501#section-6.1.2">rfc3501</a>.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOOP command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Idle(System.Threading.CancellationToken,System.Threading.CancellationToken)">
- <summary>
- Toggle the <see cref="T:MailKit.Net.Imap.ImapClient"/> into the IDLE state.
- </summary>
- <remarks>
- <para>When a client enters the IDLE state, the IMAP server will send
- events to the client as they occur on the selected folder. These events
- may include notifications of new messages arriving, expunge notifications,
- flag changes, etc.</para>
- <para>Due to the nature of the IDLE command, a folder must be selected
- before a client can enter into the IDLE state. This can be done by
- opening a folder using
- <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- or any of the other variants.</para>
- <para>While the IDLE command is running, no other commands may be issued until the
- <paramref name="doneToken"/> is cancelled.</para>
- <note type="note">It is especially important to cancel the <paramref name="doneToken"/>
- before cancelling the <paramref name="cancellationToken"/> when using SSL or TLS due to
- the fact that <see cref="T:System.Net.Security.SslStream"/> cannot be polled.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- <param name="doneToken">The cancellation token used to return to the non-idle state.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="doneToken"/> must be cancellable (i.e. <see cref="P:System.Threading.CancellationToken.None"/> cannot be used).
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- A <see cref="T:MailKit.Net.Imap.ImapFolder"/> has not been opened.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the IDLE extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the IDLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Notify(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)">
- <summary>
- Request the specified notification events from the IMAP server.
- </summary>
- <remarks>
- <para>The <a href="https://tools.ietf.org/html/rfc5465">NOTIFY</a> command is used to expand
- which notifications the client wishes to be notified about, including status notifications
- about folders other than the currently selected folder. It can also be used to automatically
- FETCH information about new messages that have arrived in the currently selected folder.</para>
- <para>This, combined with <see cref="M:MailKit.Net.Imap.ImapClient.Idle(System.Threading.CancellationToken,System.Threading.CancellationToken)"/>,
- can be used to get instant notifications for changes to any of the specified folders.</para>
- </remarks>
- <param name="status"><c>true</c> if the server should immediately notify the client of the
- selected folder's status; otherwise, <c>false</c>.</param>
- <param name="eventGroups">The specific event groups that the client would like to receive notifications for.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="eventGroups"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="eventGroups"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- One or more <see cref="T:MailKit.Net.Imap.ImapEventGroup"/> is invalid.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the NOTIFY extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOTIFY command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.DisableNotify(System.Threading.CancellationToken)">
- <summary>
- Disable any previously requested notification events from the IMAP server.
- </summary>
- <remarks>
- Disables any notification events requested in a prior call to
- <see cref="M:MailKit.Net.Imap.ImapClient.Notify(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)"/>.
- request.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the NOTIFY extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOTIFY command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.PersonalNamespaces">
- <summary>
- Get the personal namespaces.
- </summary>
- <remarks>
- The personal folder namespaces contain a user's personal mailbox folders.
- </remarks>
- <value>The personal namespaces.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.SharedNamespaces">
- <summary>
- Get the shared namespaces.
- </summary>
- <remarks>
- The shared folder namespaces contain mailbox folders that are shared with the user.
- </remarks>
- <value>The shared namespaces.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.OtherNamespaces">
- <summary>
- Get the other namespaces.
- </summary>
- <remarks>
- The other folder namespaces contain other mailbox folders.
- </remarks>
- <value>The other namespaces.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.SupportsQuotas">
- <summary>
- Get whether or not the mail store supports quotas.
- </summary>
- <remarks>
- Gets whether or not the mail store supports quotas.
- </remarks>
- <value><c>true</c> if the mail store supports quotas; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapClient.Inbox">
- <summary>
- Get the Inbox folder.
- </summary>
- <remarks>
- <para>The Inbox folder is the default folder and always exists on the server.</para>
- <note type="note">This property will only be available after the client has been authenticated.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- <value>The Inbox folder.</value>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetFolder(MailKit.SpecialFolder)">
- <summary>
- Get the specified special folder.
- </summary>
- <remarks>
- Not all IMAP servers support special folders. Only IMAP servers
- supporting the <see cref="F:MailKit.Net.Imap.ImapCapabilities.SpecialUse"/> or
- <see cref="F:MailKit.Net.Imap.ImapCapabilities.XList"/> extensions may have
- special folders.
- </remarks>
- <returns>The folder if available; otherwise <c>null</c>.</returns>
- <param name="folder">The type of special folder.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="folder"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the SPECIAL-USE nor XLIST extensions.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetFolder(MailKit.FolderNamespace)">
- <summary>
- Get the folder for the specified namespace.
- </summary>
- <remarks>
- Gets the folder for the specified namespace.
- </remarks>
- <returns>The folder.</returns>
- <param name="namespace">The namespace.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The folder could not be found.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetFolders(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The namespace folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the LIST or LSUB command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetFolder(System.String,System.Threading.CancellationToken)">
- <summary>
- Get the folder for the specified path.
- </summary>
- <remarks>
- Gets the folder for the specified path.
- </remarks>
- <returns>The folder.</returns>
- <param name="path">The folder path.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="path"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the IDLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetMetadata(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA or METADATA-SERVER extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.GetMetadata(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="tags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA or METADATA-SERVER extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.SetMetadata(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Sets the specified metadata.
- </summary>
- <remarks>
- Sets the specified metadata.
- </remarks>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="metadata"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA or METADATA-SERVER extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapClient.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Imap.ImapClient"/> and
- optionally releases the managed resources.
- </summary>
- <remarks>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Imap.ImapClient"/> and
- optionally releases the managed resources.
- </remarks>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="T:MailKit.Net.Imap.IImapClient">
- <summary>
- An interface for an IMAP client.
- </summary>
- <remarks>
- Implemented by <see cref="T:MailKit.Net.Imap.ImapClient"/>.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Imap.IImapClient.Capabilities">
- <summary>
- Get the capabilities supported by the IMAP server.
- </summary>
- <remarks>
- The capabilities will not be known until a successful connection has been made via one of
- the <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a> methods and may
- change as a side-effect of calling one of the
- <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a>
- methods.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The capabilities.</value>
- <exception cref="T:System.ArgumentException">
- Capabilities cannot be enabled, they may only be disabled.
- </exception>
- </member>
- <member name="P:MailKit.Net.Imap.IImapClient.AppendLimit">
- <summary>
- Gets the maximum size of a message that can be appended to a folder.
- </summary>
- <remarks>
- <para>Gets the maximum size of a message, in bytes, that can be appended to a folder.</para>
- <note type="note">If the value is not set, then the limit is unspecified.</note>
- </remarks>
- <value>The append limit.</value>
- </member>
- <member name="P:MailKit.Net.Imap.IImapClient.InternationalizationLevel">
- <summary>
- Gets the internationalization level supported by the IMAP server.
- </summary>
- <remarks>
- <para>Gets the internationalization level supported by the IMAP server.</para>
- <para>For more information, see
- <a href="https://tools.ietf.org/html/rfc5255#section-4">section 4 of rfc5255</a>.</para>
- </remarks>
- <value>The internationalization level.</value>
- </member>
- <member name="P:MailKit.Net.Imap.IImapClient.Rights">
- <summary>
- Get the access rights supported by the IMAP server.
- </summary>
- <remarks>
- These rights are additional rights supported by the IMAP server beyond the standard rights
- defined in <a href="https://tools.ietf.org/html/rfc4314#section-2.1">section 2.1 of rfc4314</a>
- and will not be populated until the client is successfully connected.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The rights.</value>
- </member>
- <member name="P:MailKit.Net.Imap.IImapClient.IsIdle">
- <summary>
- Get whether or not the client is currently in the IDLE state.
- </summary>
- <remarks>
- Gets whether or not the client is currently in the IDLE state.
- </remarks>
- <value><c>true</c> if an IDLE command is active; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.Compress(System.Threading.CancellationToken)">
- <summary>
- Enable compression over the IMAP connection.
- </summary>
- <remarks>
- <para>Enables compression over the IMAP connection.</para>
- <para>If the IMAP server supports the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Compress"/> extension,
- it is possible at any point after connecting to enable compression to reduce network
- bandwidth usage. Ideally, this method should be called before authenticating.</para>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Compression must be enabled before a folder has been selected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Compress"/> extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the COMPRESS command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.CompressAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously enable compression over the IMAP connection.
- </summary>
- <remarks>
- <para>Asynchronously enables compression over the IMAP connection.</para>
- <para>If the IMAP server supports the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Compress"/> extension,
- it is possible at any point after connecting to enable compression to reduce network
- bandwidth usage. Ideally, this method should be called before authenticating.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Compression must be enabled before a folder has been selected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the COMPRESS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the COMPRESS command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.EnableUTF8(System.Threading.CancellationToken)">
- <summary>
- Enable the UTF8=ACCEPT extension.
- </summary>
- <remarks>
- Enables the <a href="https://tools.ietf.org/html/rfc6855">UTF8=ACCEPT</a> extension.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- UTF8=ACCEPT needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the UTF8=ACCEPT extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ENABLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.EnableUTF8Async(System.Threading.CancellationToken)">
- <summary>
- Asynchronously enable the UTF8=ACCEPT extension.
- </summary>
- <remarks>
- Enables the <a href="https://tools.ietf.org/html/rfc6855">UTF8=ACCEPT</a> extension.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- UTF8=ACCEPT needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the UTF8=ACCEPT extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ENABLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.Identify(MailKit.Net.Imap.ImapImplementation,System.Threading.CancellationToken)">
- <summary>
- Identify the client implementation to the server and obtain the server implementation details.
- </summary>
- <remarks>
- <para>Passes along the client implementation details to the server while also obtaining implementation
- details from the server.</para>
- <para>If the <paramref name="clientImplementation"/> is <c>null</c> or no properties have been set, no
- identifying information will be sent to the server.</para>
- <note type="security">
- <para>Security Implications</para>
- <para>This command has the danger of violating the privacy of users if misused. Clients should
- notify users that they send the ID command.</para>
- <para>It is highly desirable that implementations provide a method of disabling ID support, perhaps by
- not calling this method at all, or by passing <c>null</c> as the <paramref name="clientImplementation"/>
- argument.</para>
- <para>Implementors must exercise extreme care in adding properties to the <paramref name="clientImplementation"/>.
- Some properties, such as a processor ID number, Ethernet address, or other unique (or mostly unique) identifier
- would allow tracking of users in ways that violate user privacy expectations and may also make it easier for
- attackers to exploit security holes in the client.</para>
- </note>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <returns>The implementation details of the server if available; otherwise, <c>null</c>.</returns>
- <param name="clientImplementation">The client implementation.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ID extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ID command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.IdentifyAsync(MailKit.Net.Imap.ImapImplementation,System.Threading.CancellationToken)">
- <summary>
- Asynchronously identify the client implementation to the server and obtain the server implementation details.
- </summary>
- <remarks>
- <para>Passes along the client implementation details to the server while also obtaining implementation
- details from the server.</para>
- <para>If the <paramref name="clientImplementation"/> is <c>null</c> or no properties have been set, no
- identifying information will be sent to the server.</para>
- <note type="security">
- <para>Security Implications</para>
- <para>This command has the danger of violating the privacy of users if misused. Clients should
- notify users that they send the ID command.</para>
- <para>It is highly desirable that implementations provide a method of disabling ID support, perhaps by
- not calling this method at all, or by passing <c>null</c> as the <paramref name="clientImplementation"/>
- argument.</para>
- <para>Implementors must exercise extreme care in adding properties to the <paramref name="clientImplementation"/>.
- Some properties, such as a processor ID number, Ethernet address, or other unique (or mostly unique) identifier
- would allow tracking of users in ways that violate user privacy expectations and may also make it easier for
- attackers to exploit security holes in the client.</para>
- </note>
- </remarks>
- <returns>The implementation details of the server if available; otherwise, <c>null</c>.</returns>
- <param name="clientImplementation">The client implementation.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ID extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the ID command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.Idle(System.Threading.CancellationToken,System.Threading.CancellationToken)">
- <summary>
- Toggle the <see cref="T:MailKit.Net.Imap.ImapClient"/> into the IDLE state.
- </summary>
- <remarks>
- <para>When a client enters the IDLE state, the IMAP server will send
- events to the client as they occur on the selected folder. These events
- may include notifications of new messages arriving, expunge notifications,
- flag changes, etc.</para>
- <para>Due to the nature of the IDLE command, a folder must be selected
- before a client can enter into the IDLE state. This can be done by
- opening a folder using
- <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- or any of the other variants.</para>
- <para>While the IDLE command is running, no other commands may be issued until the
- <paramref name="doneToken"/> is cancelled.</para>
- <note type="note">It is especially important to cancel the <paramref name="doneToken"/>
- before cancelling the <paramref name="cancellationToken"/> when using SSL or TLS due to
- the fact that <see cref="T:System.Net.Security.SslStream"/> cannot be polled.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- <param name="doneToken">The cancellation token used to return to the non-idle state.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="doneToken"/> must be cancellable (i.e. <see cref="P:System.Threading.CancellationToken.None"/> cannot be used).
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- A <see cref="T:MailKit.Net.Imap.ImapFolder"/> has not been opened.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the IDLE extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the IDLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.IdleAsync(System.Threading.CancellationToken,System.Threading.CancellationToken)">
- <summary>
- Asynchronously toggle the <see cref="T:MailKit.Net.Imap.ImapClient"/> into the IDLE state.
- </summary>
- <remarks>
- <para>When a client enters the IDLE state, the IMAP server will send
- events to the client as they occur on the selected folder. These events
- may include notifications of new messages arriving, expunge notifications,
- flag changes, etc.</para>
- <para>Due to the nature of the IDLE command, a folder must be selected
- before a client can enter into the IDLE state. This can be done by
- opening a folder using
- <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- or any of the other variants.</para>
- <para>While the IDLE command is running, no other commands may be issued until the
- <paramref name="doneToken"/> is cancelled.</para>
- <note type="note">It is especially important to cancel the <paramref name="doneToken"/>
- before cancelling the <paramref name="cancellationToken"/> when using SSL or TLS due to
- the fact that <see cref="T:System.Net.Security.SslStream"/> cannot be polled.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="doneToken">The cancellation token used to return to the non-idle state.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="doneToken"/> must be cancellable (i.e. <see cref="P:System.Threading.CancellationToken.None"/> cannot be used).
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- A <see cref="T:MailKit.Net.Imap.ImapFolder"/> has not been opened.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the IDLE extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the IDLE command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.Notify(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)">
- <summary>
- Request the specified notification events from the IMAP server.
- </summary>
- <remarks>
- <para>The <a href="https://tools.ietf.org/html/rfc5465">NOTIFY</a> command is used to expand
- which notifications the client wishes to be notified about, including status notifications
- about folders other than the currently selected folder. It can also be used to automatically
- FETCH information about new messages that have arrived in the currently selected folder.</para>
- <para>This, combined with <see cref="M:MailKit.Net.Imap.IImapClient.Idle(System.Threading.CancellationToken,System.Threading.CancellationToken)"/>,
- can be used to get instant notifications for changes to any of the specified folders.</para>
- </remarks>
- <param name="status"><c>true</c> if the server should immediately notify the client of the
- selected folder's status; otherwise, <c>false</c>.</param>
- <param name="eventGroups">The specific event groups that the client would like to receive notifications for.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="eventGroups"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="eventGroups"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- One or more <see cref="T:MailKit.Net.Imap.ImapEventGroup"/> is invalid.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the NOTIFY extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOTIFY command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.NotifyAsync(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)">
- <summary>
- Asynchronously request the specified notification events from the IMAP server.
- </summary>
- <remarks>
- <para>The <a href="https://tools.ietf.org/html/rfc5465">NOTIFY</a> command is used to expand
- which notifications the client wishes to be notified about, including status notifications
- about folders other than the currently selected folder. It can also be used to automatically
- FETCH information about new messages that have arrived in the currently selected folder.</para>
- <para>This, combined with <see cref="M:MailKit.Net.Imap.IImapClient.IdleAsync(System.Threading.CancellationToken,System.Threading.CancellationToken)"/>,
- can be used to get instant notifications for changes to any of the specified folders.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="status"><c>true</c> if the server should immediately notify the client of the
- selected folder's status; otherwise, <c>false</c>.</param>
- <param name="eventGroups">The specific event groups that the client would like to receive notifications for.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="eventGroups"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="eventGroups"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- One or more <see cref="T:MailKit.Net.Imap.ImapEventGroup"/> is invalid.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the NOTIFY extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOTIFY command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.DisableNotify(System.Threading.CancellationToken)">
- <summary>
- Disable any previously requested notification events from the IMAP server.
- </summary>
- <remarks>
- Disables any notification events requested in a prior call to
- <see cref="M:MailKit.Net.Imap.IImapClient.Notify(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)"/>.
- request.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the NOTIFY extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOTIFY command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapClient.DisableNotifyAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously disable any previously requested notification events from the IMAP server.
- </summary>
- <remarks>
- Disables any notification events requested in a prior call to
- <see cref="M:MailKit.Net.Imap.IImapClient.NotifyAsync(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)"/>.
- request.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the NOTIFY extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied to the NOTIFY command with a NO or BAD response.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="T:MailKit.Net.Imap.IImapFolder">
- <summary>
- An interface for an IMAP folder.
- </summary>
- <remarks>
- Implemented by <see cref="T:MailKit.Net.Imap.ImapFolder"/>.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetHeaders(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetHeadersAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetHeaders(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetHeadersAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetBodyPart(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetBodyPartAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetBodyPart(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetBodyPartAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetStreams(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Net.Imap.ImapFetchStreamCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Gets the streams for the specified messages.</para>
- </remarks>
- <param name="uids">The uids of the messages.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="callback"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetStreamsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Net.Imap.ImapFetchStreamAsyncCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Asynchronously gets the streams for the specified messages.</para>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="uids">The uids of the messages.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="callback"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetStreams(System.Collections.Generic.IList{System.Int32},MailKit.Net.Imap.ImapFetchStreamCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Gets the streams for the specified messages.</para>
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="callback"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetStreamsAsync(System.Collections.Generic.IList{System.Int32},MailKit.Net.Imap.ImapFetchStreamAsyncCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Asynchronously gets the streams for the specified messages.</para>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="callback"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetStreams(System.Int32,System.Int32,MailKit.Net.Imap.ImapFetchStreamCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Gets the streams for the specified messages.</para>
- </remarks>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="callback"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.GetStreamsAsync(System.Int32,System.Int32,MailKit.Net.Imap.ImapFetchStreamAsyncCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Asynchronously gets the streams for the specified messages.</para>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="callback"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.Search(System.String,System.Threading.CancellationToken)">
- <summary>
- Search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Sends a <c>UID SEARCH</c> command with the specified query passed directly to the IMAP server
- with no interpretation by MailKit. This means that the query may contain any arguments that a
- <c>UID SEARCH</c> command is allowed to have according to the IMAP specifications and any
- extensions that are supported, including <c>RETURN</c> parameters.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="query"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.SearchAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Sends a <c>UID SEARCH</c> command with the specified query passed directly to the IMAP server
- with no interpretation by MailKit. This means that the query may contain any arguments that a
- <c>UID SEARCH</c> command is allowed to have according to the IMAP specifications and any
- extensions that are supported, including <c>RETURN</c> parameters.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="query"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.Sort(System.String,System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- Sends a <c>UID SORT</c> command with the specified query passed directly to the IMAP server
- with no interpretation by MailKit. This means that the query may contain any arguments that a
- <c>UID SORT</c> command is allowed to have according to the IMAP specifications and any
- extensions that are supported, including <c>RETURN</c> parameters.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="query"/> is an empty string.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the SORT extension.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.IImapFolder.SortAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- Sends a <c>UID SORT</c> command with the specified query passed directly to the IMAP server
- with no interpretation by MailKit. This means that the query may contain any arguments that a
- <c>UID SORT</c> command is allowed to have according to the IMAP specifications and any
- extensions that are supported, including <c>RETURN</c> parameters.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="query"/> is an empty string.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the SORT extension.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="T:MailKit.Net.Imap.ImapFetchStreamCallback">
- <summary>
- A callback used when fetching message streams.
- </summary>
- <remarks>
- <para>This callback is meant to be used with the various
- <a href="Overload_MailKit_Net_Imap_ImapFolder_GetStreams.htm">GetStreams</a>
- methods.</para>
- <para>Once this callback returns, the stream argument will be disposed, so
- it is important to consume the stream right away and not add it to a queue
- for later processing.</para>
- </remarks>
- <param name="folder">The IMAP folder that the message belongs to.</param>
- <param name="index">The index of the message in the folder.</param>
- <param name="uid">The UID of the message in the folder.</param>
- <param name="stream">The raw message (or part) stream.</param>
- </member>
- <member name="T:MailKit.Net.Imap.ImapFetchStreamAsyncCallback">
- <summary>
- An asynchronous callback used when fetching message streams.
- </summary>
- <remarks>
- <para>This callback is meant to be used with the various
- <a href="Overload_MailKit_Net_Imap_ImapFolder_GetStreamsAsync.htm">GetStreamsAsync</a>
- methods.</para>
- <para>Once this callback returns, the stream argument will be disposed, so
- it is important to consume the stream right away and not add it to a queue
- for later processing.</para>
- </remarks>
- <returns>An awaitable task context.</returns>
- <param name="folder">The IMAP folder that the message belongs to.</param>
- <param name="index">The index of the message in the folder.</param>
- <param name="uid">The UID of the message in the folder.</param>
- <param name="stream">The raw message (or part) stream.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="T:MailKit.Net.Imap.ImapCapabilities">
- <summary>
- Capabilities supported by an IMAP server.
- </summary>
- <remarks>
- Capabilities are read as part of the response to the <c>CAPABILITY</c> command that
- is issued during the connection and authentication phases of the
- <see cref="T:MailKit.Net.Imap.ImapClient"/>.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.None">
- <summary>
- The server does not support any additional extensions.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.IMAP4">
- <summary>
- The server implements the core IMAP4 commands.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.IMAP4rev1">
- <summary>
- The server implements the core IMAP4rev1 commands.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.IMAP4rev2">
- <summary>
- The server implements the core IMAP4rev2 commands.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Status">
- <summary>
- The server supports the <c>STATUS</c> command.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Acl">
- <summary>
- The server supports the ACL extension defined in <a href="https://tools.ietf.org/html/rfc2086">rfc2086</a>
- and <a href="https://tools.ietf.org/html/rfc4314">rfc4314</a>.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Quota">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2087">QUOTA</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.LiteralPlus">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2088">LITERAL+</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Idle">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2177">IDLE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.MailboxReferrals">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2193">MAILBOX-REFERRALS</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.LoginReferrals">
- <summary>
- the server supports the <a href="https://tools.ietf.org/html/rfc2221">LOGIN-REFERRALS</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Namespace">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2342">NAMESPACE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Id">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2971">ID</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Children">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc3348">CHILDREN</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.LoginDisabled">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc3501">LOGINDISABLED</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.StartTLS">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc3501">STARTTLS</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.MultiAppend">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc3502">MULTIAPPEND</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Binary">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc3516">BINARY</a> content extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Unselect">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc3691">UNSELECT</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.UidPlus">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc4315">UIDPLUS</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Catenate">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc4469">CATENATE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.CondStore">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc4551">CONDSTORE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.ESearch">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc4731">ESEARCH</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.SaslIR">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc4959">SASL-IR</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Compress">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc4978">COMPRESS</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Within">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5032">WITHIN</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Enable">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5161">ENABLE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.QuickResync">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5162">QRESYNC</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.SearchResults">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5182">SEARCHRES</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Sort">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5256">SORT</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Thread">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5256">THREAD</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Annotate">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5257">ANNOTATE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.ListExtended">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5258">LIST-EXTENDED</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Convert">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5259">CONVERT</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Language">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5255">LANGUAGE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.I18NLevel">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5255">I18NLEVEL</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.ESort">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5267">ESORT</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Context">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5267">CONTEXT</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Metadata">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5464">METADATA</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.MetadataServer">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5464">METADATA-SERVER</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Notify">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5465">NOTIFY</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Filters">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5466">FILTERS</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.ListStatus">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5819">LIST-STATUS</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.SortDisplay">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc5957">SORT=DISPLAY</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.CreateSpecialUse">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6154">CREATE-SPECIAL-USE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.SpecialUse">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6154">SPECIAL-USE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.FuzzySearch">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6203">SEARCH=FUZZY</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.MultiSearch">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6237">MULTISEARCH</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Move">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6851">MOVE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.UTF8Accept">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6855">UTF8=ACCEPT</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.UTF8Only">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6855">UTF8=ONLY</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.LiteralMinus">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc7888">LITERAL-</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.AppendLimit">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc7889">APPENDLIMIT</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.Unauthenticate">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc8437">UNAUTHENTICATE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.StatusSize">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc8438">STATUS=SIZE</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.ListMyRights">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc8440">LIST-MYRIGHTS</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.ObjectID">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.XList">
- <summary>
- The server supports the <a href="https://developers.google.com/gmail/imap_extensions">XLIST</a> extension (GMail).
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCapabilities.GMailExt1">
- <summary>
- The server supports the <a href="https://developers.google.com/gmail/imap_extensions">X-GM-EXT1</a> extension (GMail).
- </summary>
- </member>
- <member name="T:MailKit.Net.Imap.ImapContinuationHandler">
- <summary>
- An IMAP continuation handler.
- </summary>
- <remarks>
- All exceptions thrown by the handler are considered fatal and will
- force-disconnect the connection. If a non-fatal error occurs, set
- it on the <see cref="P:MailKit.Net.Imap.ImapCommand.Exception"/> property.
- </remarks>
- </member>
- <member name="T:MailKit.Net.Imap.ImapUntaggedHandler">
- <summary>
- An IMAP untagged response handler.
- </summary>
- <remarks>
- <para>Most IMAP commands return their results in untagged responses.</para>
- </remarks>
- </member>
- <member name="T:MailKit.Net.Imap.ImapCommandStatus">
- <summary>
- IMAP command status.
- </summary>
- </member>
- <member name="T:MailKit.Net.Imap.ImapIdleContext">
- <summary>
- An IMAP IDLE context.
- </summary>
- <remarks>
- <para>An IMAP IDLE command does not work like normal commands. Unlike most commands,
- the IDLE command does not end until the client sends a separate "DONE" command.</para>
- <para>In order to facilitate this, the way this works is that the consumer of MailKit's
- IMAP APIs provides a 'doneToken' which signals to the command-processing loop to
- send the "DONE" command. Since, like every other IMAP command, it is also necessary to
- provide a means of cancelling the IDLE command, it becomes necessary to link the
- 'doneToken' and the 'cancellationToken' together.</para>
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapIdleContext.#ctor(MailKit.Net.Imap.ImapEngine,System.Threading.CancellationToken,System.Threading.CancellationToken)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapIdleContext"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapIdleContext"/>.
- </remarks>
- <param name="engine">The IMAP engine.</param>
- <param name="doneToken">The done token.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="P:MailKit.Net.Imap.ImapIdleContext.Engine">
- <summary>
- Get the engine.
- </summary>
- <remarks>
- Gets the engine.
- </remarks>
- <value>The engine.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapIdleContext.CancellationToken">
- <summary>
- Get the cancellation token.
- </summary>
- <remarks>
- Get the cancellation token.
- </remarks>
- <value>The cancellation token.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapIdleContext.DoneToken">
- <summary>
- Get the done token.
- </summary>
- <remarks>
- Gets the done token.
- </remarks>
- <value>The done token.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapIdleContext.ContinuationHandler(MailKit.Net.Imap.ImapEngine,MailKit.Net.Imap.ImapCommand,System.String,System.Boolean)">
- <summary>
- Callback method to be used as the ImapCommand's ContinuationHandler.
- </summary>
- <remarks>
- Callback method to be used as the ImapCommand's ContinuationHandler.
- </remarks>
- <param name="engine">The ImapEngine.</param>
- <param name="ic">The ImapCommand.</param>
- <param name="text">The text.</param>
- <param name="doAsync"><c>true</c> if the command is being run asynchronously; otherwise, <c>false</c>.</param>
- <returns></returns>
- </member>
- <member name="M:MailKit.Net.Imap.ImapIdleContext.Dispose">
- <summary>
- Releases all resource used by the <see cref="T:MailKit.Net.Imap.ImapIdleContext"/> object.
- </summary>
- <remarks>Call <see cref="M:MailKit.Net.Imap.ImapIdleContext.Dispose"/> when you are finished using the <see cref="T:MailKit.Net.Imap.ImapIdleContext"/>. The
- <see cref="M:MailKit.Net.Imap.ImapIdleContext.Dispose"/> method leaves the <see cref="T:MailKit.Net.Imap.ImapIdleContext"/> in an unusable state. After
- calling <see cref="M:MailKit.Net.Imap.ImapIdleContext.Dispose"/>, you must release all references to the
- <see cref="T:MailKit.Net.Imap.ImapIdleContext"/> so the garbage collector can reclaim the memory that the
- <see cref="T:MailKit.Net.Imap.ImapIdleContext"/> was occupying.</remarks>
- </member>
- <member name="T:MailKit.Net.Imap.ImapLiteral">
- <summary>
- An IMAP literal object.
- </summary>
- <remarks>
- The literal can be a string, byte[], Stream, or a MimeMessage.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapLiteral.#ctor(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Action{System.Int32})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapLiteral"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapLiteral"/>.
- </remarks>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="action">The progress update action.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapLiteral.#ctor(MimeKit.FormatOptions,System.Byte[])">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapLiteral"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapLiteral"/>.
- </remarks>
- <param name="options">The formatting options.</param>
- <param name="literal">The literal.</param>
- </member>
- <member name="P:MailKit.Net.Imap.ImapLiteral.Length">
- <summary>
- Get the length of the literal, in bytes.
- </summary>
- <remarks>
- Gets the length of the literal, in bytes.
- </remarks>
- <value>The length.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapLiteral.WriteToAsync(MailKit.Net.Imap.ImapStream,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Write the literal to the specified stream.
- </summary>
- <remarks>
- Writes the literal to the specified stream.
- </remarks>
- <param name="stream">The stream.</param>
- <param name="doAsync">Whether the literal should be written asynchronously or not.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="T:MailKit.Net.Imap.ImapCommandPart">
- <summary>
- A partial IMAP command.
- </summary>
- <remarks>
- IMAP commands that contain literal strings are broken up into multiple parts
- in case the IMAP server does not support the LITERAL+ extension. These parts
- are then sent individually as we receive "+" responses from the server.
- </remarks>
- </member>
- <member name="T:MailKit.Net.Imap.ImapCommand">
- <summary>
- An IMAP command.
- </summary>
- </member>
- <member name="M:MailKit.Net.Imap.ImapCommand.#ctor(MailKit.Net.Imap.ImapEngine,System.Threading.CancellationToken,MailKit.Net.Imap.ImapFolder,MimeKit.FormatOptions,System.String,System.Object[])">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapCommand"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapCommand"/>.
- </remarks>
- <param name="engine">The IMAP engine that will be sending the command.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="folder">The IMAP folder that the command operates on.</param>
- <param name="options">The formatting options.</param>
- <param name="format">The command format.</param>
- <param name="args">The command arguments.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapCommand.#ctor(MailKit.Net.Imap.ImapEngine,System.Threading.CancellationToken,MailKit.Net.Imap.ImapFolder,System.String,System.Object[])">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapCommand"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapCommand"/>.
- </remarks>
- <param name="engine">The IMAP engine that will be sending the command.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="folder">The IMAP folder that the command operates on.</param>
- <param name="format">The command format.</param>
- <param name="args">The command arguments.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapCommand.RegisterUntaggedHandler(System.String,MailKit.Net.Imap.ImapUntaggedHandler)">
- <summary>
- Registers the untagged handler for the specified atom token.
- </summary>
- <param name="atom">The atom token.</param>
- <param name="handler">The handler.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="atom"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="handler"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Untagged handlers must be registered before the command has been queued.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapCommand.StepAsync(System.Boolean)">
- <summary>
- Sends the next part of the command to the server.
- </summary>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="T:MailKit.Net.Imap.ImapCommandException">
- <summary>
- An exception that is thrown when an IMAP command returns NO or BAD.
- </summary>
- <remarks>
- The exception that is thrown when an IMAP command fails. Unlike a <see cref="T:MailKit.Net.Imap.ImapProtocolException"/>,
- a <see cref="T:MailKit.Net.Imap.ImapCommandException"/> does not require the <see cref="T:MailKit.Net.Imap.ImapClient"/> to be reconnected.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapCommandException.Create(System.String,MailKit.Net.Imap.ImapCommand)">
- <summary>
- Create a new <see cref="T:MailKit.Net.Imap.ImapCommandException"/> based on the specified command name and <see cref="T:MailKit.Net.Imap.ImapCommand"/> state.
- </summary>
- <remarks>
- Create a new <see cref="T:MailKit.Net.Imap.ImapCommandException"/> based on the specified command name and <see cref="T:MailKit.Net.Imap.ImapCommand"/> state.
- </remarks>
- <returns>A new command exception.</returns>
- <param name="command">The command name.</param>
- <param name="ic">The command state.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapCommandException.#ctor(MailKit.Net.Imap.ImapCommandResponse,System.String,System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapCommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapCommandException"/>.
- </remarks>
- <param name="response">The IMAP command response.</param>
- <param name="message">The error message.</param>
- <param name="responseText">The human-readable response text.</param>
- <param name="innerException">The inner exception.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapCommandException.#ctor(MailKit.Net.Imap.ImapCommandResponse,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapCommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapCommandException"/>.
- </remarks>
- <param name="response">The IMAP command response.</param>
- <param name="responseText">The human-readable response text.</param>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapCommandException.#ctor(MailKit.Net.Imap.ImapCommandResponse,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapCommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapCommandException"/>.
- </remarks>
- <param name="response">The IMAP command response.</param>
- <param name="responseText">The human-readable response text.</param>
- </member>
- <member name="P:MailKit.Net.Imap.ImapCommandException.Response">
- <summary>
- Gets the IMAP command response.
- </summary>
- <remarks>
- Gets the IMAP command response.
- </remarks>
- <value>The IMAP command response.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapCommandException.ResponseText">
- <summary>
- Gets the human-readable IMAP command response text.
- </summary>
- <remarks>
- Gets the human-readable IMAP command response text.
- </remarks>
- <value>The response text.</value>
- </member>
- <member name="T:MailKit.Net.Imap.ImapCommandResponse">
- <summary>
- An enumeration of possible IMAP command responses.
- </summary>
- <remarks>
- An enumeration of possible IMAP command responses.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCommandResponse.None">
- <summary>
- No IMAP command response yet.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCommandResponse.Ok">
- <summary>
- The command resulted in an "OK" response.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCommandResponse.No">
- <summary>
- The command resulted in a "NO" response.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapCommandResponse.Bad">
- <summary>
- The command resulted in a "BAD" response.
- </summary>
- </member>
- <member name="T:MailKit.Net.Imap.ImapEngineState">
- <summary>
- The state of the <see cref="T:MailKit.Net.Imap.ImapEngine"/>.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEngineState.Disconnected">
- <summary>
- The ImapEngine is in the disconnected state.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEngineState.Connecting">
- <summary>
- The ImapEngine is in the process of connecting.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEngineState.Connected">
- <summary>
- The ImapEngine is connected but not yet authenticated.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEngineState.Authenticated">
- <summary>
- The ImapEngine is in the authenticated state.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEngineState.Selected">
- <summary>
- The ImapEngine is in the selected state.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEngineState.Idle">
- <summary>
- The ImapEngine is in the IDLE state.
- </summary>
- </member>
- <member name="T:MailKit.Net.Imap.ImapEngine">
- <summary>
- An IMAP command engine.
- </summary>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.AuthenticationMechanisms">
- <summary>
- Get the authentication mechanisms supported by the IMAP server.
- </summary>
- <remarks>
- The authentication mechanisms are queried durring the
- <see cref="M:MailKit.Net.Imap.ImapEngine.ConnectAsync(MailKit.Net.Imap.ImapStream,System.Boolean,System.Threading.CancellationToken)"/> method.
- </remarks>
- <value>The authentication mechanisms.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.CompressionAlgorithms">
- <summary>
- Get the compression algorithms supported by the IMAP server.
- </summary>
- <remarks>
- The compression algorithms are populated by the
- <see cref="M:MailKit.Net.Imap.ImapEngine.QueryCapabilitiesAsync(System.Boolean,System.Threading.CancellationToken)"/> method.
- </remarks>
- <value>The compression algorithms.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.ThreadingAlgorithms">
- <summary>
- Get the threading algorithms supported by the IMAP server.
- </summary>
- <remarks>
- The threading algorithms are populated by the
- <see cref="M:MailKit.Net.Imap.ImapEngine.QueryCapabilitiesAsync(System.Boolean,System.Threading.CancellationToken)"/> method.
- </remarks>
- <value>The threading algorithms.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.AppendLimit">
- <summary>
- Gets the append limit supported by the IMAP server.
- </summary>
- <remarks>
- Gets the append limit supported by the IMAP server.
- </remarks>
- <value>The append limit.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.I18NLevel">
- <summary>
- Gets the I18NLEVEL supported by the IMAP server.
- </summary>
- <remarks>
- Gets the I18NLEVEL supported by the IMAP server.
- </remarks>
- <value>The internationalization level.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Capabilities">
- <summary>
- Get the capabilities supported by the IMAP server.
- </summary>
- <remarks>
- The capabilities will not be known until a successful connection
- has been made via the <see cref="M:MailKit.Net.Imap.ImapEngine.ConnectAsync(MailKit.Net.Imap.ImapStream,System.Boolean,System.Threading.CancellationToken)"/> method.
- </remarks>
- <value>The capabilities.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.IsBusy">
- <summary>
- Indicates whether or not the engine is busy processing commands.
- </summary>
- <remarks>
- Indicates whether or not the engine is busy processing commands.
- </remarks>
- <value><c>true</c> if th e engine is busy processing commands; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.CapabilitiesVersion">
- <summary>
- Get the capabilities version.
- </summary>
- <remarks>
- Every time the engine receives an untagged CAPABILITIES
- response from the server, it increments this value.
- </remarks>
- <value>The capabilities version.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.ProtocolVersion">
- <summary>
- Get the IMAP protocol version.
- </summary>
- <remarks>
- Gets the IMAP protocol version.
- </remarks>
- <value>The IMAP protocol version.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Rights">
- <summary>
- Get the rights specified in the capabilities.
- </summary>
- <remarks>
- Gets the rights specified in the capabilities.
- </remarks>
- <value>The rights.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.SupportedCharsets">
- <summary>
- Get the supported charsets.
- </summary>
- <remarks>
- Gets the supported charsets.
- </remarks>
- <value>The supported charsets.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.SupportedContexts">
- <summary>
- Get the supported contexts.
- </summary>
- <remarks>
- Gets the supported contexts.
- </remarks>
- <value>The supported contexts.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.QResyncEnabled">
- <summary>
- Get whether or not the QRESYNC feature has been enabled.
- </summary>
- <remarks>
- Gets whether or not the QRESYNC feature has been enabled.
- </remarks>
- <value><c>true</c> if the QRESYNC feature has been enabled; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.UTF8Enabled">
- <summary>
- Get whether or not the UTF8=ACCEPT feature has been enabled.
- </summary>
- <remarks>
- Gets whether or not the UTF8=ACCEPT feature has been enabled.
- </remarks>
- <value><c>true</c> if the UTF8=ACCEPT feature has been enabled; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Uri">
- <summary>
- Get the URI of the IMAP server.
- </summary>
- <remarks>
- Gets the URI of the IMAP server.
- </remarks>
- <value>The URI of the IMAP server.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Stream">
- <summary>
- Get the underlying IMAP stream.
- </summary>
- <remarks>
- Gets the underlying IMAP stream.
- </remarks>
- <value>The IMAP stream.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.State">
- <summary>
- Get or sets the state of the engine.
- </summary>
- <remarks>
- Gets or sets the state of the engine.
- </remarks>
- <value>The engine state.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.IsConnected">
- <summary>
- Get whether or not the engine is currently connected to a IMAP server.
- </summary>
- <remarks>
- Gets whether or not the engine is currently connected to a IMAP server.
- </remarks>
- <value><c>true</c> if the engine is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.PersonalNamespaces">
- <summary>
- Gets the personal folder namespaces.
- </summary>
- <remarks>
- Gets the personal folder namespaces.
- </remarks>
- <value>The personal folder namespaces.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.SharedNamespaces">
- <summary>
- Gets the shared folder namespaces.
- </summary>
- <remarks>
- Gets the shared folder namespaces.
- </remarks>
- <value>The shared folder namespaces.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.OtherNamespaces">
- <summary>
- Gets the other folder namespaces.
- </summary>
- <remarks>
- Gets the other folder namespaces.
- </remarks>
- <value>The other folder namespaces.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Selected">
- <summary>
- Gets the selected folder.
- </summary>
- <remarks>
- Gets the selected folder.
- </remarks>
- <value>The selected folder.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.IsDisposed">
- <summary>
- Gets a value indicating whether the engine is disposed.
- </summary>
- <remarks>
- Gets a value indicating whether the engine is disposed.
- </remarks>
- <value><c>true</c> if the engine is disposed; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.NotifySelectedNewExpunge">
- <summary>
- Gets whether the current NOTIFY status prevents using indexes and * for referencing messages.
- </summary>
- <remarks>
- Gets whether the current NOTIFY status prevents using indexes and * for referencing messages. This is the case when the client has asked for MessageNew or MessageExpunge events on the SELECTED mailbox.
- </remarks>
- <value><c>true</c> if the use of indexes and * is prevented; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Inbox">
- <summary>
- Gets the Inbox folder.
- </summary>
- <value>The Inbox folder.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.All">
- <summary>
- Gets the special folder containing an aggregate of all messages.
- </summary>
- <value>The folder containing all messages.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Archive">
- <summary>
- Gets the special archive folder.
- </summary>
- <value>The archive folder.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Drafts">
- <summary>
- Gets the special folder containing drafts.
- </summary>
- <value>The drafts folder.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Flagged">
- <summary>
- Gets the special folder containing flagged messages.
- </summary>
- <value>The flagged folder.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Junk">
- <summary>
- Gets the special folder containing junk messages.
- </summary>
- <value>The junk folder.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Sent">
- <summary>
- Gets the special folder containing sent messages.
- </summary>
- <value>The sent.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEngine.Trash">
- <summary>
- Gets the folder containing deleted messages.
- </summary>
- <value>The trash folder.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.SetStream(MailKit.Net.Imap.ImapStream)">
- <summary>
- Sets the stream - this is only here to be used by the unit tests.
- </summary>
- <param name="stream">The IMAP stream.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.ConnectAsync(MailKit.Net.Imap.ImapStream,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Takes posession of the <see cref="T:MailKit.Net.Imap.ImapStream"/> and reads the greeting.
- </summary>
- <param name="stream">The IMAP stream.</param>
- <param name="doAsync">Whether or not asyncrhonois IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.Disconnect">
- <summary>
- Disconnects the <see cref="T:MailKit.Net.Imap.ImapEngine"/>.
- </summary>
- <remarks>
- Disconnects the <see cref="T:MailKit.Net.Imap.ImapEngine"/>.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.ReadToken(System.Threading.CancellationToken)">
- <summary>
- Reads the next token.
- </summary>
- <returns>The token.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.InvalidOperationException">
- The engine is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- An IMAP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.ParseResponseCodeAsync(System.Boolean,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Parses the response code.
- </summary>
- <returns>The response code.</returns>
- <param name="isTagged">Whether or not the resp-code is tagged vs untagged.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.ProcessUntaggedResponseAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Processes an untagged response.
- </summary>
- <returns>The untagged response.</returns>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.IterateAsync(System.Boolean)">
- <summary>
- Iterate the command pipeline.
- </summary>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.RunAsync(MailKit.Net.Imap.ImapCommand,System.Boolean)">
- <summary>
- Wait for the specified command to finish.
- </summary>
- <param name="ic">The IMAP command.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="ic"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.QueueCommand(System.Threading.CancellationToken,MailKit.Net.Imap.ImapFolder,MimeKit.FormatOptions,System.String,System.Object[])">
- <summary>
- Queues the command.
- </summary>
- <returns>The command.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="folder">The folder that the command operates on.</param>
- <param name="options">The formatting options.</param>
- <param name="format">The command format.</param>
- <param name="args">The command arguments.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.QueueCommand(System.Threading.CancellationToken,MailKit.Net.Imap.ImapFolder,System.String,System.Object[])">
- <summary>
- Queues the command.
- </summary>
- <returns>The command.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="folder">The folder that the command operates on.</param>
- <param name="format">The command format.</param>
- <param name="args">The command arguments.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.QueueCommand(MailKit.Net.Imap.ImapCommand)">
- <summary>
- Queues the command.
- </summary>
- <param name="ic">The IMAP command.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.QueryCapabilitiesAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Queries the capabilities.
- </summary>
- <returns>The command result.</returns>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.CacheFolder(MailKit.Net.Imap.ImapFolder)">
- <summary>
- Cache the specified folder.
- </summary>
- <param name="folder">The folder.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.GetCachedFolder(System.String,MailKit.Net.Imap.ImapFolder@)">
- <summary>
- Gets the cached folder.
- </summary>
- <returns><c>true</c> if the folder was retreived from the cache; otherwise, <c>false</c>.</returns>
- <param name="encodedName">The encoded folder name.</param>
- <param name="folder">The cached folder.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.LookupParentFoldersAsync(System.Collections.Generic.IEnumerable{MailKit.Net.Imap.ImapFolder},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Looks up and sets the <see cref="P:MailKit.MailFolder.ParentFolder"/> property of each of the folders.
- </summary>
- <param name="folders">The IMAP folders.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.QueryNamespacesAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Queries the namespaces.
- </summary>
- <returns>The command result.</returns>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.AssignSpecialFolder(MailKit.Net.Imap.ImapFolder)">
- <summary>
- Assigns a folder as a special folder.
- </summary>
- <param name="folder">The special folder.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.AssignSpecialFolders(System.Collections.Generic.IList{MailKit.Net.Imap.ImapFolder})">
- <summary>
- Assigns the special folders.
- </summary>
- <param name="list">The list of folders.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.QuerySpecialFoldersAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Queries the special folders.
- </summary>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.GetQuotaRootFolderAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Gets the folder representing the specified quota root.
- </summary>
- <returns>The folder.</returns>
- <param name="quotaRoot">The name of the quota root.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.GetFolderAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Gets the folder for the specified path.
- </summary>
- <returns>The folder.</returns>
- <param name="path">The folder path.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.GetFoldersAsync(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Gets all of the folders within the specified namespace.
- </remarks>
- <returns>The list of folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.DecodeMailboxName(System.String)">
- <summary>
- Decodes the name of the mailbox.
- </summary>
- <returns>The mailbox name.</returns>
- <param name="encodedName">The encoded name.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.EncodeMailboxName(System.String)">
- <summary>
- Encodes the name of the mailbox.
- </summary>
- <returns>The mailbox name.</returns>
- <param name="mailboxName">The encoded mailbox name.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.IsValidMailboxName(System.String,System.Char)">
- <summary>
- Determines whether the mailbox name is valid or not.
- </summary>
- <returns><c>true</c> if the mailbox name is valid; otherwise, <c>false</c>.</returns>
- <param name="mailboxName">The mailbox name.</param>
- <param name="delim">The path delimeter.</param>
- </member>
- <member name="E:MailKit.Net.Imap.ImapEngine.Alert">
- <summary>
- Occurs when the engine receives an alert message from the server.
- </summary>
- </member>
- <member name="E:MailKit.Net.Imap.ImapEngine.FolderCreated">
- <summary>
- Occurs when the engine receives a notification that a folder has been created.
- </summary>
- </member>
- <member name="E:MailKit.Net.Imap.ImapEngine.MetadataChanged">
- <summary>
- Occurs when the engine receives a notification that metadata has changed.
- </summary>
- </member>
- <member name="E:MailKit.Net.Imap.ImapEngine.NotificationOverflow">
- <summary>
- Occurs when the engine receives a notification overflow message from the server.
- </summary>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEngine.Dispose">
- <summary>
- Releases all resource used by the <see cref="T:MailKit.Net.Imap.ImapEngine"/> object.
- </summary>
- <remarks>Call <see cref="M:MailKit.Net.Imap.ImapEngine.Dispose"/> when you are finished using the <see cref="T:MailKit.Net.Imap.ImapEngine"/>. The
- <see cref="M:MailKit.Net.Imap.ImapEngine.Dispose"/> method leaves the <see cref="T:MailKit.Net.Imap.ImapEngine"/> in an unusable state. After
- calling <see cref="M:MailKit.Net.Imap.ImapEngine.Dispose"/>, you must release all references to the <see cref="T:MailKit.Net.Imap.ImapEngine"/> so
- the garbage collector can reclaim the memory that the <see cref="T:MailKit.Net.Imap.ImapEngine"/> was occupying.</remarks>
- </member>
- <member name="T:MailKit.Net.Imap.ImapEventGroup">
- <summary>
- An IMAP event group used with the NOTIFY command.
- </summary>
- <remarks>
- An IMAP event group used with the NOTIFY command.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEventGroup.#ctor(MailKit.Net.Imap.ImapMailboxFilter,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEvent})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEventGroup"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEventGroup"/> class.
- </remarks>
- <param name="mailboxFilter">The mailbox filter.</param>
- <param name="events">The list of IMAP events.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="mailboxFilter"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="events"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEventGroup.MailboxFilter">
- <summary>
- Get the mailbox filter.
- </summary>
- <remarks>
- Gets the mailbox filter.
- </remarks>
- <value>The mailbox filter.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEventGroup.Events">
- <summary>
- Get the list of IMAP events.
- </summary>
- <remarks>
- Gets the list of IMAP events.
- </remarks>
- <value>The events.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEventGroup.Format(MailKit.Net.Imap.ImapEngine,System.Text.StringBuilder,System.Collections.Generic.IList{System.Object},System.Boolean@)">
- <summary>
- Format the IMAP NOTIFY command for this particular IMAP event group.
- </summary>
- <remarks>
- Formats the IMAP NOTIFY command for this particular IMAP event group.
- </remarks>
- <param name="engine">The IMAP engine.</param>
- <param name="command">The IMAP command builder.</param>
- <param name="args">The IMAP command argument builder.</param>
- <param name="notifySelectedNewExpunge">Gets set to <c>true</c> if the NOTIFY command requests the MessageNew or
- MessageExpunged events for a SELECTED or SELECTED-DELAYED mailbox filter; otherwise it is left unchanged.</param>
- </member>
- <member name="T:MailKit.Net.Imap.ImapMailboxFilter">
- <summary>
- An IMAP mailbox filter for use with the NOTIFY command.
- </summary>
- <remarks>
- An IMAP mailbox filter for use with the NOTIFY command.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapMailboxFilter.Selected">
- <summary>
- An IMAP mailbox filter specifying that the client wants immediate notifications for
- the currently selected folder.
- </summary>
- <remarks>
- The <c>SELECTED</c> mailbox specifier requires the server to send immediate
- notifications for the currently selected mailbox about all specified
- message events.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapMailboxFilter.SelectedDelayed">
- <summary>
- An IMAP mailbox filter specifying the currently selected folder but delays notifications
- until a command has been issued.
- </summary>
- <remarks>
- The <c>SELECTED-DELAYED</c> mailbox specifier requires the server to delay a
- <see cref="F:MailKit.Net.Imap.ImapEvent.MessageExpunge"/> event until the client issues a command that allows
- returning information about expunged messages (see
- <a href="https://tools.ietf.org/html/rfc3501#section-7.4.1">Section 7.4.1 of RFC3501]</a>
- for more details), for example, till a <c>NOOP</c> or an <c>IDLE</c> command has been issued.
- When <c>SELECTED-DELAYED</c> is specified, the server MAY also delay returning other message
- events until the client issues one of the commands specified above, or it MAY return them
- immediately.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapMailboxFilter.Inboxes">
- <summary>
- An IMAP mailbox filter specifying the currently selected folder.
- </summary>
- <remarks>
- <para>The <c>INBOXES</c> mailbox specifier refers to all selectable mailboxes in the user's
- personal namespace(s) to which messages may be delivered by a Message Delivery Agent (MDA).
- </para>
- <para>If the IMAP server cannot easily compute this set, it MUST treat <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.Inboxes"/>
- as equivalent to <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.Personal"/>.</para>
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapMailboxFilter.Personal">
- <summary>
- An IMAP mailbox filter specifying all selectable folders within the user's personal namespace.
- </summary>
- <remarks>
- The <c>PERSONAL</c> mailbox specifier refers to all selectable folders within the user's personal namespace.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapMailboxFilter.Subscribed">
- <summary>
- An IMAP mailbox filter that refers to all subscribed folders.
- </summary>
- <remarks>
- <para>The <c>SUBSCRIBED</c> mailbox specifier refers to all folders subscribed to by the user.</para>
- <para>If the subscription list changes, the server MUST reevaluate the list.</para>
- </remarks>
- </member>
- <member name="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes">
- <summary>
- An IMAP mailbox filter that specifies a list of folders to receive notifications about.
- </summary>
- <remarks>
- An IMAP mailbox filter that specifies a list of folders to receive notifications about.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes.#ctor(System.Collections.Generic.IList{MailKit.IMailFolder})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes"/> class.
- </remarks>
- <param name="folders">The list of folders to watch for events.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folders"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The list of <paramref name="folders"/> is empty.</para>
- <para>-or-</para>
- <para>The list of <paramref name="folders"/> contains folders that are not of
- type <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes.#ctor(MailKit.IMailFolder[])">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes"/> class.
- </remarks>
- <param name="folders">The list of folders to watch for events.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folders"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The list of <paramref name="folders"/> is empty.</para>
- <para>-or-</para>
- <para>The list of <paramref name="folders"/> contains folders that are not of
- type <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes.#ctor(System.String,System.Collections.Generic.IList{MailKit.IMailFolder})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes"/> class.
- </remarks>
- <param name="name">The name of the mailbox filter.</param>
- <param name="folders">The list of folders to watch for events.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folders"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The list of <paramref name="folders"/> is empty.</para>
- <para>-or-</para>
- <para>The list of <paramref name="folders"/> contains folders that are not of
- type <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes.Format(MailKit.Net.Imap.ImapEngine,System.Text.StringBuilder,System.Collections.Generic.IList{System.Object})">
- <summary>
- Format the IMAP NOTIFY command for this particular IMAP mailbox filter.
- </summary>
- <remarks>
- Formats the IMAP NOTIFY command for this particular IMAP mailbox filter.
- </remarks>
- <param name="engine">The IMAP engine.</param>
- <param name="command">The IMAP command builder.</param>
- <param name="args">The IMAP command argument builder.</param>
- </member>
- <member name="T:MailKit.Net.Imap.ImapMailboxFilter.Subtree">
- <summary>
- An IMAP mailbox filter that specifies a list of folder subtrees to get notifications about.
- </summary>
- <remarks>
- <para>The client will receive notifications for each specified folder plus all selectable
- folders that are subordinate to any of the specified folders.</para>
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Subtree.#ctor(System.Collections.Generic.IList{MailKit.IMailFolder})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Subtree"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Subtree"/> class.
- </remarks>
- <param name="folders">The list of folders to watch for events.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folders"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The list of <paramref name="folders"/> is empty.</para>
- <para>-or-</para>
- <para>The list of <paramref name="folders"/> contains folders that are not of
- type <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Subtree.#ctor(MailKit.IMailFolder[])">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Subtree"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Subtree"/> class.
- </remarks>
- <param name="folders">The list of folders to watch for events.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folders"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The list of <paramref name="folders"/> is empty.</para>
- <para>-or-</para>
- <para>The list of <paramref name="folders"/> contains folders that are not of
- type <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapMailboxFilter.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter"/> class.
- </remarks>
- <param name="name">The name of the mailbox filter.</param>
- </member>
- <member name="P:MailKit.Net.Imap.ImapMailboxFilter.Name">
- <summary>
- Get the name of the mailbox filter.
- </summary>
- <remarks>
- Gets the name of the mailbox filter.
- </remarks>
- <value>The name.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Format(MailKit.Net.Imap.ImapEngine,System.Text.StringBuilder,System.Collections.Generic.IList{System.Object})">
- <summary>
- Format the IMAP NOTIFY command for this particular IMAP mailbox filter.
- </summary>
- <remarks>
- Formats the IMAP NOTIFY command for this particular IMAP mailbox filter.
- </remarks>
- <param name="engine">The IMAP engine.</param>
- <param name="command">The IMAP command builder.</param>
- <param name="args">The IMAP command argument builder.</param>
- </member>
- <member name="T:MailKit.Net.Imap.ImapEvent">
- <summary>
- An IMAP notification event.
- </summary>
- <remarks>
- An IMAP notification event.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEvent.MessageExpunge">
- <summary>
- An IMAP event notification for expunged messages.
- </summary>
- <remarks>
- <para>If the expunged message or messages are in the selected mailbox, the server notifies the client
- using <see cref="E:MailKit.IMailFolder.MessageExpunged"/> (or <see cref="E:MailKit.IMailFolder.MessagesVanished"/> if
- the <a href="https://tools.ietf.org/html/rfc5162">QRESYNC</a> extension has been enabled via
- <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/> or
- <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResyncAsync(System.Threading.CancellationToken)"/>).</para>
- <para>If the expunged message or messages are in another mailbox, the <see cref="P:MailKit.IMailFolder.UidNext"/>
- and <see cref="P:MailKit.IMailFolder.Count"/> properties will be updated and the appropriate
- <see cref="E:MailKit.IMailFolder.UidNextChanged"/> and <see cref="E:MailKit.IMailFolder.CountChanged"/> events will be
- emitted for the relevant folder. If the <a href="https://tools.ietf.org/html/rfc5162">QRESYNC</a>
- extension is enabled, the <see cref="P:MailKit.IMailFolder.HighestModSeq"/> property will also be updated and
- the <see cref="E:MailKit.IMailFolder.HighestModSeqChanged"/> event will be emitted.</para>
- <note type="note">if a client requests <see cref="F:MailKit.Net.Imap.ImapEvent.MessageExpunge"/> with the <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.Selected"/>
- mailbox specifier, the meaning of a message index can change at any time, so the client cannot use
- message indexes in commands anymore. The client MUST use API variants that take <see cref="T:MailKit.UniqueId"/> or
- a <see cref="T:System.Collections.Generic.IList`1"/>. The meaning of <c>*</c>* can also change when messages are added or expunged.
- A client wishing to keep using message indexes can either use the <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.SelectedDelayed"/>
- mailbox specifier or can avoid using the <see cref="F:MailKit.Net.Imap.ImapEvent.MessageExpunge"/> event entirely.</note>
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEvent.FlagChange">
- <summary>
- An IMAP event notification for message flag changes.
- </summary>
- <remarks>
- <para>If the <see cref="F:MailKit.Net.Imap.ImapEvent.FlagChange"/> notification arrives for a message located in the currently selected
- folder, then that folder will emit a <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> event as well as a
- <see cref="E:MailKit.IMailFolder.MessageSummaryFetched"/> event with an appropriately populated
- <see cref="T:MailKit.IMessageSummary"/>.</para>
- <para>On the other hand, if the <see cref="F:MailKit.Net.Imap.ImapEvent.FlagChange"/> notification arrives for a message that is not
- located in the currently selected folder, then the events that are emitted will depend on the
- <see cref="T:MailKit.Net.Imap.ImapCapabilities"/> of the IMAP server.</para>
- <para>If the server supports the <see cref="F:MailKit.Net.Imap.ImapCapabilities.CondStore"/> capability (or the
- <see cref="F:MailKit.Net.Imap.ImapCapabilities.QuickResync"/> capability and the client has enabled it via
- <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>), then the
- <see cref="E:MailKit.IMailFolder.HighestModSeqChanged"/> event will be emitted as well as the
- <see cref="E:MailKit.IMailFolder.UidValidityChanged"/> event (if the latter has changed). If the number of
- seen messages has changed, then the <see cref="E:MailKit.IMailFolder.UnreadChanged"/> event may also be emitted.</para>
- <para>If the server does not support either the <see cref="F:MailKit.Net.Imap.ImapCapabilities.CondStore"/> capability nor
- the <see cref="F:MailKit.Net.Imap.ImapCapabilities.QuickResync"/> capability and the client has not enabled the later capability
- via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>, then the server may choose
- only to notify the client of <see cref="P:MailKit.IMailFolder.UidValidity"/> changes by emitting the
- <see cref="E:MailKit.IMailFolder.UidValidityChanged"/> event.</para>
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEvent.AnnotationChange">
- <summary>
- An IMAP event notification for message annotation changes.
- </summary>
- <remarks>
- <para>If the <see cref="F:MailKit.Net.Imap.ImapEvent.AnnotationChange"/> notification arrives for a message located in the currently selected
- folder, then that folder will emit a <see cref="E:MailKit.IMailFolder.AnnotationsChanged"/> event as well as a
- <see cref="E:MailKit.IMailFolder.MessageSummaryFetched"/> event with an appropriately populated
- <see cref="T:MailKit.IMessageSummary"/>.</para>
- <para>On the other hand, if the <see cref="F:MailKit.Net.Imap.ImapEvent.AnnotationChange"/> notification arrives for a message that is not
- located in the currently selected folder, then the events that are emitted will depend on the
- <see cref="T:MailKit.Net.Imap.ImapCapabilities"/> of the IMAP server.</para>
- <para>If the server supports the <see cref="F:MailKit.Net.Imap.ImapCapabilities.CondStore"/> capability (or the
- <see cref="F:MailKit.Net.Imap.ImapCapabilities.QuickResync"/> capability and the client has enabled it via
- <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>), then the
- <see cref="E:MailKit.IMailFolder.HighestModSeqChanged"/> event will be emitted as well as the
- <see cref="E:MailKit.IMailFolder.UidValidityChanged"/> event (if the latter has changed). If the number of
- seen messages has changed, then the <see cref="E:MailKit.IMailFolder.UnreadChanged"/> event may also be emitted.</para>
- <para>If the server does not support either the <see cref="F:MailKit.Net.Imap.ImapCapabilities.CondStore"/> capability nor
- the <see cref="F:MailKit.Net.Imap.ImapCapabilities.QuickResync"/> capability and the client has not enabled the later capability
- via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>, then the server may choose
- only to notify the client of <see cref="P:MailKit.IMailFolder.UidValidity"/> changes by emitting the
- <see cref="E:MailKit.IMailFolder.UidValidityChanged"/> event.</para>
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEvent.MailboxName">
- <summary>
- AN IMAP event notification for folders that have been created, deleted, or renamed.
- </summary>
- <remarks>
- <para>These notifications are sent if an affected mailbox name was created, deleted, or renamed.</para>
- <para>As these notifications are received by the client, the apropriate will be emitted:
- <see cref="E:MailKit.MailStore.FolderCreated"/>, <see cref="E:MailKit.IMailFolder.Deleted"/>, or
- <see cref="E:MailKit.IMailFolder.Renamed"/>, respectively.</para>
- <note type="info">If the server supports <see cref="F:MailKit.Net.Imap.ImapCapabilities.Acl"/>, granting or revocation of the
- <see cref="F:MailKit.AccessRight.LookupFolder"/> right to the current user on the affected folder will also be
- considered folder creation or deletion, respectively. If a folder is created or deleted, the folder itself
- and its direct parent (whether it is an existing folder or not) are considered to be affected.</note>
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEvent.SubscriptionChange">
- <summary>
- An IMAP event notification for folders who have had their subscription status changed.
- </summary>
- <remarks>
- <para>This event requests that the server notifies the client of any subscription changes,
- causing the <see cref="E:MailKit.IMailFolder.Subscribed"/> or <see cref="E:MailKit.IMailFolder.Unsubscribed"/>
- events to be emitted accordingly on the affected <see cref="T:MailKit.IMailFolder"/>.</para>
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEvent.MailboxMetadataChange">
- <summary>
- An IMAP event notification for changes to folder metadata.
- </summary>
- <remarks>
- <para>Support for this event type is OPTIONAL unless <see cref="F:MailKit.Net.Imap.ImapCapabilities.Metadata"/> is supported
- by the server, in which case support for this event type is REQUIRED.</para>
- <para>If the server does support this event, then the <see cref="E:MailKit.IMailFolder.MetadataChanged"/> event
- will be emitted whenever metadata changes for any folder included in the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter"/>.</para>
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapEvent.ServerMetadataChange">
- <summary>
- An IMAP event notification for changes to server metadata.
- </summary>
- <remarks>
- <para>Support for this event type is OPTIONAL unless <see cref="F:MailKit.Net.Imap.ImapCapabilities.Metadata"/> is supported
- by the server, in which case support for this event type is REQUIRED.</para>
- <para>If the server does support this event, then the <see cref="E:MailKit.IMailStore.MetadataChanged"/> event
- will be emitted whenever metadata changes.</para>
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEvent.#ctor(System.String,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent"/> class.
- </remarks>
- <param name="name">The name of the IMAP event.</param>
- <param name="isMessageEvent"><c>true</c> if the event is a message event; otherwise, <c>false</c>.</param>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEvent.IsMessageEvent">
- <summary>
- Get whether or not this <see cref="T:MailKit.Net.Imap.ImapEvent"/> is a message event.
- </summary>
- <remarks>
- Gets whether or not this <see cref="T:MailKit.Net.Imap.ImapEvent"/> is a message event.
- </remarks>
- <value><c>true</c> if is message event; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapEvent.Name">
- <summary>
- Get the name of the IMAP event.
- </summary>
- <remarks>
- Gets the name of the IMAP event.
- </remarks>
- <value>The name of the IMAP event.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEvent.Format(MailKit.Net.Imap.ImapEngine,System.Text.StringBuilder,System.Collections.Generic.IList{System.Object},System.Boolean)">
- <summary>
- Format the IMAP NOTIFY command for this particular IMAP mailbox filter.
- </summary>
- <remarks>
- Formats the IMAP NOTIFY command for this particular IMAP mailbox filter.
- </remarks>
- <param name="engine">The IMAP engine.</param>
- <param name="command">The IMAP command builder.</param>
- <param name="args">The IMAP command argument builder.</param>
- <param name="isSelectedFilter"><c>true</c> if the event is being registered for a
- <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.Selected"/> or <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.SelectedDelayed"/>
- mailbox filter.</param>
- </member>
- <member name="T:MailKit.Net.Imap.ImapEvent.MessageNew">
- <summary>
- An IMAP event notification for new or appended messages.
- </summary>
- <remarks>
- <para>An IMAP event notification for new or appended messages.</para>
- <para>If the new or appended message is in the selected folder, the folder will emit the
- <see cref="E:MailKit.IMailFolder.CountChanged"/> event, followed by a
- <see cref="E:MailKit.IMailFolder.MessageSummaryFetched"/> event containing the information requested by the client.</para>
- <note type="note">These events will not be emitted for any message created by the client on this particular folder
- as a result of, for example, a call to
- <see cref="M:MailKit.IMailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>
- or <see cref="M:MailKit.IMailFolder.CopyTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)"/>.</note>
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEvent.MessageNew.#ctor(MailKit.MessageSummaryItems)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent.MessageNew"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent.MessageNew"/> class.
- </remarks>
- <param name="items">The message summary items to automatically retrieve for new messages.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEvent.MessageNew.#ctor(MailKit.MessageSummaryItems,System.Collections.Generic.HashSet{MimeKit.HeaderId})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent.MessageNew"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent.MessageNew"/> class.
- </remarks>
- <param name="items">The message summary items to automatically retrieve for new messages.</param>
- <param name="headers">Additional message headers to retrieve for new messages.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEvent.MessageNew.#ctor(MailKit.MessageSummaryItems,System.Collections.Generic.HashSet{System.String})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent.MessageNew"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent.MessageNew"/> class.
- </remarks>
- <param name="items">The message summary items to automatically retrieve for new messages.</param>
- <param name="headers">Additional message headers to retrieve for new messages.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapEvent.MessageNew.Format(MailKit.Net.Imap.ImapEngine,System.Text.StringBuilder,System.Collections.Generic.IList{System.Object},System.Boolean)">
- <summary>
- Format the IMAP NOTIFY command for this particular IMAP mailbox filter.
- </summary>
- <remarks>
- Formats the IMAP NOTIFY command for this particular IMAP mailbox filter.
- </remarks>
- <param name="engine">The IMAP engine.</param>
- <param name="command">The IMAP command builder.</param>
- <param name="args">The IMAP command argument builder.</param>
- <param name="isSelectedFilter"><c>true</c> if the event is being registered for a
- <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.Selected"/> or <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.SelectedDelayed"/>
- mailbox filter.</param>
- </member>
- <member name="T:MailKit.Net.Imap.ImapFolder">
- <summary>
- An IMAP folder.
- </summary>
- <remarks>
- An IMAP folder.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.#ctor(MailKit.Net.Imap.ImapFolderConstructorArgs)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapFolder"/> class.
- </summary>
- <remarks>
- <para>Creates a new <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</para>
- <para>If you subclass <see cref="T:MailKit.Net.Imap.ImapFolder"/>, you will also need to subclass
- <see cref="T:MailKit.Net.Imap.ImapClient"/> and override the
- <see cref="M:MailKit.Net.Imap.ImapClient.CreateImapFolder(MailKit.Net.Imap.ImapFolderConstructorArgs)"/>
- method in order to return a new instance of your ImapFolder subclass.</para>
- </remarks>
- <param name="args">The constructor arguments.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="args"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.Net.Imap.ImapFolder.Engine">
- <summary>
- Get the IMAP command engine.
- </summary>
- <remarks>
- Gets the IMAP command engine.
- </remarks>
- <value>The engine.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapFolder.EncodedName">
- <summary>
- Get the encoded name of the folder.
- </summary>
- <remarks>
- Gets the encoded name of the folder.
- </remarks>
- <value>The encoded name.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapFolder.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the IMAP server.
- </summary>
- <remarks>
- <para>Gets an object that can be used to synchronize access to the IMAP server.</para>
- <para>When using the non-Async methods from multiple threads, it is important to lock the
- <see cref="P:MailKit.Net.Imap.ImapFolder.SyncRoot"/> object for thread safety when using the synchronous methods.</para>
- </remarks>
- <value>The lock object.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.OnParentFolderRenamed">
- <summary>
- Notifies the folder that a parent folder has been renamed.
- </summary>
- <remarks>
- Updates the <see cref="P:MailKit.MailFolder.FullName"/> property.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Imap.ImapFolder.IsOpen">
- <summary>
- Gets a value indicating whether the folder is currently open.
- </summary>
- <remarks>
- Gets a value indicating whether the folder is currently open.
- </remarks>
- <value><c>true</c> if the folder is currently open; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Open the folder using the requested folder access.
- </summary>
- <remarks>
- <para>This variant of the <see cref="M:MailKit.Net.Imap.ImapFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- method is meant for quick resynchronization of the folder. Before calling this method,
- the <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/> method MUST be called.</para>
- <para>You should also make sure to add listeners to the <see cref="E:MailKit.MailFolder.MessagesVanished"/> and
- <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events to get notifications of changes since
- the last time the folder was opened.</para>
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="uidValidity">The last known <see cref="P:MailKit.MailFolder.UidValidity"/> value.</param>
- <param name="highestModSeq">The last known <see cref="P:MailKit.MailFolder.HighestModSeq"/> value.</param>
- <param name="uids">The last known list of unique message identifiers.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="access"/> is not a valid value.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The QRESYNC feature has not been enabled.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the QRESYNC extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.OpenAsync(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously open the folder using the requested folder access.
- </summary>
- <remarks>
- <para>This variant of the <see cref="M:MailKit.Net.Imap.ImapFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- method is meant for quick resynchronization of the folder. Before calling this method,
- the <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/> method MUST be called.</para>
- <para>You should also make sure to add listeners to the <see cref="E:MailKit.MailFolder.MessagesVanished"/> and
- <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events to get notifications of changes since
- the last time the folder was opened.</para>
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="uidValidity">The last known <see cref="P:MailKit.MailFolder.UidValidity"/> value.</param>
- <param name="highestModSeq">The last known <see cref="P:MailKit.MailFolder.HighestModSeq"/> value.</param>
- <param name="uids">The last known list of unique message identifiers.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="access"/> is not a valid value.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The QRESYNC feature has not been enabled.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the QRESYNC extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)">
- <summary>
- Open the folder using the requested folder access.
- </summary>
- <remarks>
- Opens the folder using the requested folder access.
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="access"/> is not a valid value.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.OpenAsync(MailKit.FolderAccess,System.Threading.CancellationToken)">
- <summary>
- Asynchronously open the folder using the requested folder access.
- </summary>
- <remarks>
- Opens the folder using the requested folder access.
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="access"/> is not a valid value.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Close(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Close the folder, optionally expunging the messages marked for deletion.
- </summary>
- <remarks>
- Closes the folder, optionally expunging the messages marked for deletion.
- </remarks>
- <param name="expunge">If set to <c>true</c>, expunge.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CloseAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously close the folder, optionally expunging the messages marked for deletion.
- </summary>
- <remarks>
- Closes the folder, optionally expunging the messages marked for deletion.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="expunge">If set to <c>true</c>, expunge.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Create(System.String,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="isMessageFolder"><c>true</c> if the folder will be used to contain messages; otherwise <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CreateAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="isMessageFolder"><c>true</c> if the folder will be used to contain messages; otherwise <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Create(System.String,System.Collections.Generic.IEnumerable{MailKit.SpecialFolder},System.Threading.CancellationToken)">
- <summary>
- Create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUses">A list of special uses for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="specialUses"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the CREATE-SPECIAL-USE extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CreateAsync(System.String,System.Collections.Generic.IEnumerable{MailKit.SpecialFolder},System.Threading.CancellationToken)">
- <summary>
- Asynchronously create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUses">A list of special uses for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="specialUses"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the CREATE-SPECIAL-USE extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Rename(MailKit.IMailFolder,System.String,System.Threading.CancellationToken)">
- <summary>
- Rename the folder to exist with a new name under a new parent folder.
- </summary>
- <remarks>
- Renames the folder to exist with a new name under a new parent folder.
- </remarks>
- <param name="parent">The new parent folder.</param>
- <param name="name">The new name of the folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="parent"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="name"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="parent"/> does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- <para>-or-</para>
- <para><paramref name="name"/> is not a legal folder name.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The folder cannot be renamed (it is either a namespace or the Inbox).
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RenameAsync(MailKit.IMailFolder,System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously rename the folder to exist with a new name under a new parent folder.
- </summary>
- <remarks>
- Renames the folder to exist with a new name under a new parent folder.
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="parent">The new parent folder.</param>
- <param name="name">The new name of the folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="parent"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="name"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="parent"/> does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- <para>-or-</para>
- <para><paramref name="name"/> is not a legal folder name.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The folder cannot be renamed (it is either a namespace or the Inbox).
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Delete(System.Threading.CancellationToken)">
- <summary>
- Delete the folder on the IMAP server.
- </summary>
- <remarks>
- <para>Deletes the folder on the IMAP server.</para>
- <note type="note">This method will not delete any child folders.</note>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The folder cannot be deleted (it is either a namespace or the Inbox).
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.DeleteAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously delete the folder on the IMAP server.
- </summary>
- <remarks>
- <para>Deletes the folder on the IMAP server.</para>
- <note type="note">This method will not delete any child folders.</note>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The folder cannot be deleted (it is either a namespace or the Inbox).
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Subscribe(System.Threading.CancellationToken)">
- <summary>
- Subscribe the folder.
- </summary>
- <remarks>
- Subscribes the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SubscribeAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously subscribe the folder.
- </summary>
- <remarks>
- Subscribes the folder.
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Unsubscribe(System.Threading.CancellationToken)">
- <summary>
- Unsubscribe the folder.
- </summary>
- <remarks>
- Unsubscribes the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.UnsubscribeAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously unsubscribe the folder.
- </summary>
- <remarks>
- Unsubscribes the folder.
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetSubfolders(MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get the subfolders.
- </summary>
- <remarks>
- Gets the subfolders.
- </remarks>
- <returns>The subfolders.</returns>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetSubfoldersAsync(MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the subfolders.
- </summary>
- <remarks>
- Gets the subfolders.
- </remarks>
- <returns>The subfolders.</returns>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetSubfolder(System.String,System.Threading.CancellationToken)">
- <summary>
- Get the specified subfolder.
- </summary>
- <remarks>
- Gets the specified subfolder.
- </remarks>
- <returns>The subfolder.</returns>
- <param name="name">The name of the subfolder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is either an empty string or contains the <see cref="P:MailKit.MailFolder.DirectorySeparator"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The requested folder could not be found.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetSubfolderAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the specified subfolder.
- </summary>
- <remarks>
- Gets the specified subfolder.
- </remarks>
- <returns>The subfolder.</returns>
- <param name="name">The name of the subfolder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is either an empty string or contains the <see cref="P:MailKit.MailFolder.DirectorySeparator"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The requested folder could not be found.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Check(System.Threading.CancellationToken)">
- <summary>
- Force the server to sync its in-memory state with its disk state.
- </summary>
- <remarks>
- <para>The <c>CHECK</c> command forces the IMAP server to sync its
- in-memory state with its disk state.</para>
- <para>For more information about the <c>CHECK</c> command, see
- <a href="https://tools.ietf.org/html/rfc3501#section-6.4.1">rfc350101</a>.</para>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CheckAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously force the server to sync its in-memory state with its disk state.
- </summary>
- <remarks>
- <para>The <c>CHECK</c> command forces the IMAP server to sync its
- in-memory state with its disk state.</para>
- <para>For more information about the <c>CHECK</c> command, see
- <a href="https://tools.ietf.org/html/rfc3501#section-6.4.1">rfc350101</a>.</para>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)">
- <summary>
- Update the values of the specified items.
- </summary>
- <remarks>
- <para>Updates the values of the specified items.</para>
- <para>The <see cref="M:MailKit.Net.Imap.ImapFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> method
- MUST NOT be used on a folder that is already in the opened state. Instead, other ways
- of getting the desired information should be used.</para>
- <para>For example, a common use for the <see cref="M:MailKit.Net.Imap.ImapFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- method is to get the number of unread messages in the folder. When the folder is open, however, it is
- possible to use the <see cref="M:MailKit.Net.Imap.ImapFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)"/>
- method to query for the list of unread messages.</para>
- <para>For more information about the <c>STATUS</c> command, see
- <a href="https://tools.ietf.org/html/rfc3501#section-6.3.10">rfc3501</a>.</para>
- </remarks>
- <param name="items">The items to update.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the STATUS command.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.StatusAsync(MailKit.StatusItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously update the values of the specified items.
- </summary>
- <remarks>
- <para>Updates the values of the specified items.</para>
- <para>The <see cref="M:MailKit.Net.Imap.ImapFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> method
- MUST NOT be used on a folder that is already in the opened state. Instead, other ways
- of getting the desired information should be used.</para>
- <para>For example, a common use for the <see cref="M:MailKit.Net.Imap.ImapFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- method is to get the number of unread messages in the folder. When the folder is open, however, it is
- possible to use the <see cref="M:MailKit.Net.Imap.ImapFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)"/>
- method to query for the list of unread messages.</para>
- <para>For more information about the <c>STATUS</c> command, see
- <a href="https://tools.ietf.org/html/rfc3501#section-6.3.10">rfc3501</a>.</para>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="items">The items to update.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the STATUS command.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetAccessControlList(System.Threading.CancellationToken)">
- <summary>
- Get the complete access control list for the folder.
- </summary>
- <remarks>
- Gets the complete access control list for the folder.
- </remarks>
- <returns>The access control list.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetAccessControlListAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the complete access control list for the folder.
- </summary>
- <remarks>
- Gets the complete access control list for the folder.
- </remarks>
- <returns>The access control list.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetAccessRights(System.String,System.Threading.CancellationToken)">
- <summary>
- Get the access rights for a particular identifier.
- </summary>
- <remarks>
- Gets the access rights for a particular identifier.
- </remarks>
- <returns>The access rights.</returns>
- <param name="name">The identifier name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetAccessRightsAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the access rights for a particular identifier.
- </summary>
- <remarks>
- Gets the access rights for a particular identifier.
- </remarks>
- <returns>The access rights.</returns>
- <param name="name">The identifier name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMyAccessRights(System.Threading.CancellationToken)">
- <summary>
- Get the access rights for the current authenticated user.
- </summary>
- <remarks>
- Gets the access rights for the current authenticated user.
- </remarks>
- <returns>The access rights.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMyAccessRightsAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the access rights for the current authenticated user.
- </summary>
- <remarks>
- Gets the access rights for the current authenticated user.
- </remarks>
- <returns>The access rights.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Add access rights for the specified identity.
- </summary>
- <remarks>
- Adds the given access rights for the specified identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- No rights were specified.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add access rights for the specified identity.
- </summary>
- <remarks>
- Adds the given access rights for the specified identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- No rights were specified.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Remove access rights for the specified identity.
- </summary>
- <remarks>
- Removes the given access rights for the specified identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- No rights were specified.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove access rights for the specified identity.
- </summary>
- <remarks>
- Removes the given access rights for the specified identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- No rights were specified.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Set the access rights for the specified identity.
- </summary>
- <remarks>
- Sets the access rights for the specified identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the access rights for the specified identity.
- </summary>
- <remarks>
- Sets the access rights for the specified identity.
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveAccess(System.String,System.Threading.CancellationToken)">
- <summary>
- Remove all access rights for the given identity.
- </summary>
- <remarks>
- Removes all access rights for the given identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveAccessAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove all access rights for the given identity.
- </summary>
- <remarks>
- Removes all access rights for the given identity.
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="name">The identity name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMetadata(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Get the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMetadataAsync(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMetadata(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Get the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="tags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMetadataAsync(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="tags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetMetadata(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Set the specified metadata.
- </summary>
- <remarks>
- Sets the specified metadata.
- </remarks>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="metadata"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetMetadataAsync(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the specified metadata.
- </summary>
- <remarks>
- Sets the specified metadata.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="metadata"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the METADATA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetQuota(System.Threading.CancellationToken)">
- <summary>
- Get the quota information for the folder.
- </summary>
- <remarks>
- <para>Gets the quota information for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.Net.Imap.ImapClient.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The folder quota.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the QUOTA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetQuotaAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the quota information for the folder.
- </summary>
- <remarks>
- <para>Gets the quota information for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.Net.Imap.ImapClient.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The folder quota.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the QUOTA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetQuota(System.Nullable{System.UInt32},System.Nullable{System.UInt32},System.Threading.CancellationToken)">
- <summary>
- Set the quota limits for the folder.
- </summary>
- <remarks>
- <para>Sets the quota limits for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.Net.Imap.ImapClient.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The folder quota.</returns>
- <param name="messageLimit">If not <c>null</c>, sets the maximum number of messages to allow.</param>
- <param name="storageLimit">If not <c>null</c>, sets the maximum storage size (in kilobytes).</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the QUOTA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetQuotaAsync(System.Nullable{System.UInt32},System.Nullable{System.UInt32},System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the quota limits for the folder.
- </summary>
- <remarks>
- <para>Sets the quota limits for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.Net.Imap.ImapClient.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The folder quota.</returns>
- <param name="messageLimit">If not <c>null</c>, sets the maximum number of messages to allow.</param>
- <param name="storageLimit">If not <c>null</c>, sets the maximum storage size (in kilobytes).</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the QUOTA extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Expunge(System.Threading.CancellationToken)">
- <summary>
- Expunge the folder, permanently removing all messages marked for deletion.
- </summary>
- <remarks>
- <para>The <c>EXPUNGE</c> command permanently removes all messages in the folder
- that have the <see cref="F:MailKit.MessageFlags.Deleted"/> flag set.</para>
- <para>For more information about the <c>EXPUNGE</c> command, see
- <a href="https://tools.ietf.org/html/rfc3501#section-6.4.3">rfc3501</a>.</para>
- <note type="note">Normally, a <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted
- for each message that is expunged. However, if the IMAP server supports the QRESYNC extension
- and it has been enabled via the <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>
- method, then the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than
- the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.ExpungeAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously expunge the folder, permanently removing all messages marked for deletion.
- </summary>
- <remarks>
- <para>The <c>EXPUNGE</c> command permanently removes all messages in the folder
- that have the <see cref="F:MailKit.MessageFlags.Deleted"/> flag set.</para>
- <para>For more information about the <c>EXPUNGE</c> command, see
- <a href="https://tools.ietf.org/html/rfc3501#section-6.4.3">rfc3501</a>.</para>
- <note type="note">Normally, a <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted
- for each message that is expunged. However, if the IMAP server supports the QRESYNC extension
- and it has been enabled via the <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>
- method, then the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than
- the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Expunge(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Expunge the specified uids, permanently removing them from the folder.
- </summary>
- <remarks>
- <para>Expunges the specified uids, permanently removing them from the folder.</para>
- <para>If the IMAP server supports the UIDPLUS extension (check the
- <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> for the <see cref="F:MailKit.Net.Imap.ImapCapabilities.UidPlus"/>
- flag), then this operation is atomic. Otherwise, MailKit implements this operation
- by first searching for the full list of message uids in the folder that are marked for
- deletion, unmarking the set of message uids that are not within the specified list of
- uids to be be expunged, expunging the folder (thus expunging the requested uids), and
- finally restoring the deleted flag on the collection of message uids that were originally
- marked for deletion that were not included in the list of uids provided. For this reason,
- it is advisable for clients that wish to maintain state to implement this themselves when
- the IMAP server does not support the UIDPLUS extension.</para>
- <para>For more information about the <c>UID EXPUNGE</c> command, see
- <a href="https://tools.ietf.org/html/rfc4315#section-2.1">rfc4315</a>.</para>
- <note type="note">Normally, a <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted
- for each message that is expunged. However, if the IMAP server supports the QRESYNC extension
- and it has been enabled via the <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>
- method, then the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than
- the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <param name="uids">The message uids.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.ExpungeAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously expunge the specified uids, permanently removing them from the folder.
- </summary>
- <remarks>
- <para>Expunges the specified uids, permanently removing them from the folder.</para>
- <para>If the IMAP server supports the UIDPLUS extension (check the
- <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> for the <see cref="F:MailKit.Net.Imap.ImapCapabilities.UidPlus"/>
- flag), then this operation is atomic. Otherwise, MailKit implements this operation
- by first searching for the full list of message uids in the folder that are marked for
- deletion, unmarking the set of message uids that are not within the specified list of
- uids to be be expunged, expunging the folder (thus expunging the requested uids), and
- finally restoring the deleted flag on the collection of message uids that were originally
- marked for deletion that were not included in the list of uids provided. For this reason,
- it is advisable for clients that wish to maintain state to implement this themselves when
- the IMAP server does not support the UIDPLUS extension.</para>
- <para>For more information about the <c>UID EXPUNGE</c> command, see
- <a href="https://tools.ietf.org/html/rfc4315#section-2.1">rfc4315</a>.</para>
- <note type="note">Normally, a <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted
- for each message that is expunged. However, if the IMAP server supports the QRESYNC extension
- and it has been enabled via the <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>
- method, then the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than
- the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The message uids.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Append(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages does not match the number of flags.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AppendAsync(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages does not match the number of flags.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Append(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="dates"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages, flags, and dates do not match.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AppendAsync(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="dates"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages, flags, and dates do not match.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CopyTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Copies the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- <paramref name="destination"/> does not exist.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CopyToAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Copies the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- <paramref name="destination"/> does not exist.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.MoveTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified messages to the destination folder.
- </summary>
- <remarks>
- <para>Moves the specified messages to the destination folder.</para>
- <para>If the IMAP server supports the MOVE extension (check the <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/>
- property for the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Move"/> flag), then this operation will be atomic.
- Otherwise, MailKit implements this by first copying the messages to the destination folder, then
- marking them for deletion in the originating folder, and finally expunging them (see
- <see cref="M:MailKit.Net.Imap.ImapFolder.Expunge(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/> for more information about how a
- subset of messages are expunged). Since the server could disconnect at any point between those 3
- (or more) commands, it is advisable for clients to implement their own logic for moving messages when
- the IMAP server does not support the MOVE command in order to better handle spontanious server
- disconnects and other error conditions.</para>
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- <paramref name="destination"/> does not exist.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.MoveToAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified messages to the destination folder.
- </summary>
- <remarks>
- <para>Moves the specified messages to the destination folder.</para>
- <para>If the IMAP server supports the MOVE extension (check the <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/>
- property for the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Move"/> flag), then this operation will be atomic.
- Otherwise, MailKit implements this by first copying the messages to the destination folder, then
- marking them for deletion in the originating folder, and finally expunging them (see
- <see cref="M:MailKit.Net.Imap.ImapFolder.Expunge(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/> for more information about how a
- subset of messages are expunged). Since the server could disconnect at any point between those 3
- (or more) commands, it is advisable for clients to implement their own logic for moving messages when
- the IMAP server does not support the MOVE command in order to better handle spontanious server
- disconnects and other error conditions.</para>
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- <paramref name="destination"/> does not exist.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CopyTo(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Copies the specified messages to the destination folder.
- </remarks>
- <param name="indexes">The indexes of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- <paramref name="destination"/> does not exist.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CopyToAsync(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Copies the specified messages to the destination folder.
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="indexes">The indexes of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- <paramref name="destination"/> does not exist.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.MoveTo(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified messages to the destination folder.
- </summary>
- <remarks>
- <para>If the IMAP server supports the MOVE command, then the MOVE command will be used. Otherwise,
- the messages will first be copied to the destination folder and then marked as \Deleted in the
- originating folder. Since the server could disconnect at any point between those 2 operations, it
- may be advisable to implement your own logic for moving messages in this case in order to better
- handle spontanious server disconnects and other error conditions.</para>
- </remarks>
- <param name="indexes">The indexes of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- <paramref name="destination"/> does not exist.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.MoveToAsync(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified messages to the destination folder.
- </summary>
- <remarks>
- <para>If the IMAP server supports the MOVE command, then the MOVE command will be used. Otherwise,
- the messages will first be copied to the destination folder and then marked as \Deleted in the
- originating folder. Since the server could disconnect at any point between those 2 operations, it
- may be advisable to implement your own logic for moving messages in this case in order to better
- handle spontanious server disconnects and other error conditions.</para>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="indexes">The indexes of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- <paramref name="destination"/> does not exist.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetEnumerator">
- <summary>
- Get an enumerator for the messages in the folder.
- </summary>
- <remarks>
- Gets an enumerator for the messages in the folder.
- </remarks>
- <returns>The enumerator.</returns>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Store(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages.
- </summary>
- <remarks>
- Stores the annotations for the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.StoreAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Store(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.StoreAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Store(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages.
- </summary>
- <remarks>
- Stores the annotations for the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.StoreAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Store(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.StoreAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.s
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the IMAP server supports the QRESYNC extension and the application has
- enabled this feature via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages
- that have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the IMAP server supports the QRESYNC extension and the application has
- enabled this feature via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages
- that have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the IMAP server supports the QRESYNC extension and the application has
- enabled this feature via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages
- that have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the IMAP server supports the QRESYNC extension and the application has
- enabled this feature via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages
- that have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the IMAP server supports the QRESYNC extension and the application has
- enabled this feature via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages
- that have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the IMAP server supports the QRESYNC extension and the application has
- enabled this feature via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages
- that have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="items"/> is empty.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="items"/> is empty.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the specified <paramref name="headers"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the specified <paramref name="headers"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="items"/> is empty.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="items"/> is empty.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetches the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the specified <paramref name="headers"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetches the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the IMAP server may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the specified <paramref name="headers"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CreateStream(System.Nullable{MailKit.UniqueId},System.String,System.Int32,System.Int32)">
- <summary>
- Create a backing stream for use with the GetMessage, GetBodyPart, and GetStream methods.
- </summary>
- <remarks>
- <para>Allows subclass implementations to override the type of stream
- created for use with the GetMessage, GetBodyPart and GetStream methods.</para>
- <para>This could be useful for subclass implementations that intend to implement
- support for caching and/or for subclass implementations that want to use
- temporary file streams instead of memory-based streams for larger amounts of
- message data.</para>
- <para>Subclasses that implement caching using this API should wait for
- <see cref="M:MailKit.Net.Imap.ImapFolder.CommitStream(System.IO.Stream,MailKit.UniqueId,System.String,System.Int32,System.Int32)"/> before adding the stream to their cache.</para>
- <para>Streams returned by this method SHOULD clean up any allocated resources
- such as deleting temporary files from the file system.</para>
- <note type="note">The <paramref name="uid"/> will not be available for the various
- GetMessage(), GetBodyPart() and GetStream() methods that take a message index rather
- than a <see cref="T:MailKit.UniqueId"/>. It may also not be available if the IMAP server
- response does not specify the <c>UID</c> value prior to sending the <c>literal-string</c>
- token containing the message stream.</note>
- </remarks>
- <seealso cref="M:MailKit.Net.Imap.ImapFolder.CommitStream(System.IO.Stream,MailKit.UniqueId,System.String,System.Int32,System.Int32)"/>
- <returns>The stream.</returns>
- <param name="uid">The unique identifier of the message, if available.</param>
- <param name="section">The section of the message that is being fetched.</param>
- <param name="offset">The starting offset of the message section being fetched.</param>
- <param name="length">The length of the stream being fetched, measured in bytes.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.CommitStream(System.IO.Stream,MailKit.UniqueId,System.String,System.Int32,System.Int32)">
- <summary>
- Commit a stream returned by <see cref="M:MailKit.Net.Imap.ImapFolder.CreateStream(System.Nullable{MailKit.UniqueId},System.String,System.Int32,System.Int32)"/>.
- </summary>
- <remarks>
- <para>Commits a stream returned by <see cref="M:MailKit.Net.Imap.ImapFolder.CreateStream(System.Nullable{MailKit.UniqueId},System.String,System.Int32,System.Int32)"/>.</para>
- <para>This method is called only after both the message data has successfully
- been written to the stream returned by <see cref="M:MailKit.Net.Imap.ImapFolder.CreateStream(System.Nullable{MailKit.UniqueId},System.String,System.Int32,System.Int32)"/> and a
- <see cref="T:MailKit.UniqueId"/> has been obtained for the associated message.</para>
- <para>For subclasses implementing caching, this method should be used for
- committing the stream to their cache.</para>
- <note type="note">Subclass implementations may take advantage of the fact that
- <see cref="M:MailKit.Net.Imap.ImapFolder.CommitStream(System.IO.Stream,MailKit.UniqueId,System.String,System.Int32,System.Int32)"/> allows returning a new <see cref="T:System.IO.Stream"/>
- reference if they move a file on the file system and wish to return a new
- <see cref="T:System.IO.FileStream"/> based on the new path, for example.</note>
- </remarks>
- <seealso cref="M:MailKit.Net.Imap.ImapFolder.CreateStream(System.Nullable{MailKit.UniqueId},System.String,System.Int32,System.Int32)"/>
- <returns>The stream.</returns>
- <param name="stream">The stream.</param>
- <param name="uid">The unique identifier of the message.</param>
- <param name="section">The section of the message that the stream represents.</param>
- <param name="offset">The starting offset of the message section.</param>
- <param name="length">The length of the stream, measured in bytes.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeaders(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message headers.
- </summary>
- <remarks>
- Gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeadersAsync(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message headers.
- </summary>
- <remarks>
- Gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeaders(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeadersAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeaders(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeadersAsync(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeaders(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message headers.
- </summary>
- <remarks>
- Gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeadersAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message headers.
- </summary>
- <remarks>
- Gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeaders(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeadersAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeaders(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetHeadersAsync(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message.
- </summary>
- <remarks>
- Gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMessageAsync(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message.
- </summary>
- <remarks>
- Gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message.
- </summary>
- <remarks>
- Gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetMessageAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message.
- </summary>
- <remarks>
- Gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPart(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPartAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPart(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPartAsync(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPart(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPartAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="partSpecifier">The body part specifier.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="partSpecifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPart(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPartAsync(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStream(MailKit.UniqueId,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- Fetches a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamAsync(MailKit.UniqueId,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously gets a substream of the specified message.
- </summary>
- <remarks>
- Fetches a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStream(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- Fetches a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamAsync(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously gets a substream of the specified message.
- </summary>
- <remarks>
- Fetches a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStream(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified body part.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously gets a substream of the specified body part.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStream(MailKit.UniqueId,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message. If the starting offset is beyond
- the end of the specified section of the message, an empty stream is returned. If
- the number of bytes desired extends beyond the end of the section, a truncated
- stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamAsync(MailKit.UniqueId,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously gets a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message. If the starting offset is beyond
- the end of the specified section of the message, an empty stream is returned. If
- the number of bytes desired extends beyond the end of the section, a truncated
- stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStream(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously gets a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStream(System.Int32,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message. If the starting offset is beyond
- the end of the specified section of the message, an empty stream is returned. If
- the number of bytes desired extends beyond the end of the section, a truncated
- stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamAsync(System.Int32,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously gets a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message. If the starting offset is beyond
- the end of the specified section of the message, an empty stream is returned. If
- the number of bytes desired extends beyond the end of the section, a truncated
- stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The IMAP server did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreams(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Net.Imap.ImapFetchStreamCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Gets the streams for the specified messages.</para>
- </remarks>
- <param name="uids">The uids of the messages.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="callback"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Net.Imap.ImapFetchStreamAsyncCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Asynchronously gets the streams for the specified messages.</para>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="uids">The uids of the messages.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="callback"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreams(System.Collections.Generic.IList{System.Int32},MailKit.Net.Imap.ImapFetchStreamCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Gets the streams for the specified messages.</para>
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="callback"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamsAsync(System.Collections.Generic.IList{System.Int32},MailKit.Net.Imap.ImapFetchStreamAsyncCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Asynchronously gets the streams for the specified messages.</para>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="callback"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreams(System.Int32,System.Int32,MailKit.Net.Imap.ImapFetchStreamCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Gets the streams for the specified messages.</para>
- </remarks>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="callback"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamsAsync(System.Int32,System.Int32,MailKit.Net.Imap.ImapFetchStreamAsyncCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the streams for the specified messages.
- </summary>
- <remarks>
- <para>Asynchronously gets the streams for the specified messages.</para>
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="callback"></param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="callback"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Adds a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously adds a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Removes a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously removes a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Sets the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sets the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Adds a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously adds a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Removes a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously removes a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Sets the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sets the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages.
- </summary>
- <remarks>
- Sets the labels of the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages.
- </summary>
- <remarks>
- Sets the labels of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Sets the labels of the specified messages.
- </summary>
- <remarks>
- Sets the labels of the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sets the labels of the specified messages.
- </summary>
- <remarks>
- Sets the labels of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.AddLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SetLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Search(System.String,System.Threading.CancellationToken)">
- <summary>
- Search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Sends a <c>UID SEARCH</c> command with the specified query passed directly to the IMAP server
- with no interpretation by MailKit. This means that the query may contain any arguments that a
- <c>UID SEARCH</c> command is allowed to have according to the IMAP specifications and any
- extensions that are supported, including <c>RETURN</c> parameters.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="query"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SearchAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Sends a <c>UID SEARCH</c> command with the specified query passed directly to the IMAP server
- with no interpretation by MailKit. This means that the query may contain any arguments that a
- <c>UID SEARCH</c> command is allowed to have according to the IMAP specifications and any
- extensions that are supported, including <c>RETURN</c> parameters.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="query"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SearchAsync(MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Search(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The IMAP server does not support the ESEARCH extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SearchAsync(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The IMAP server does not support the ESEARCH extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Sort(System.String,System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- Sends a <c>UID SORT</c> command with the specified query passed directly to the IMAP server
- with no interpretation by MailKit. This means that the query may contain any arguments that a
- <c>UID SORT</c> command is allowed to have according to the IMAP specifications and any
- extensions that are supported, including <c>RETURN</c> parameters.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="query"/> is an empty string.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the SORT extension.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SortAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- Sends a <c>UID SORT</c> command with the specified query passed directly to the IMAP server
- with no interpretation by MailKit. This means that the query may contain any arguments that a
- <c>UID SORT</c> command is allowed to have according to the IMAP specifications and any
- extensions that are supported, including <c>RETURN</c> parameters.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="query"/> is an empty string.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The IMAP server does not support the SORT extension.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Sort(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="orderBy"/> is empty.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The server does not support the SORT extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SortAsync(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="orderBy"/> is empty.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The server does not support the SORT extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Sort(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="orderBy"/> is empty.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The IMAP server does not support the ESORT extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.SortAsync(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="orderBy"/> is empty.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The IMAP server does not support the ESORT extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Thread(MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not supported.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The server does not support the THREAD extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.ThreadAsync(MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not supported.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The server does not support the THREAD extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.Thread(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not supported.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The server does not support the THREAD extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolder.ThreadAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not supported.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
- <para>-or-</para>
- <para>The server does not support the THREAD extension.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.Net.Imap.ImapCommandException">
- The server replied with a NO or BAD response.
- </exception>
- </member>
- <member name="T:MailKit.Net.Imap.ImapFolderConstructorArgs">
- <summary>
- Constructor arguments for <see cref="T:MailKit.Net.Imap.ImapFolder"/>.
- </summary>
- <remarks>
- Constructor arguments for <see cref="T:MailKit.Net.Imap.ImapFolder"/>.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapFolderConstructorArgs.#ctor(MailKit.Net.Imap.ImapEngine,System.String,MailKit.FolderAttributes,System.Char)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapFolderConstructorArgs"/> class.
- </summary>
- <param name="engine">The IMAP command engine.</param>
- <param name="encodedName">The encoded name.</param>
- <param name="attributes">The attributes.</param>
- <param name="delim">The directory separator.</param>
- </member>
- <member name="P:MailKit.Net.Imap.ImapFolderConstructorArgs.Attributes">
- <summary>
- Get the folder attributes.
- </summary>
- <remarks>
- Gets the folder attributes.
- </remarks>
- <value>The folder attributes.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapFolderConstructorArgs.DirectorySeparator">
- <summary>
- Get the directory separator.
- </summary>
- <remarks>
- Gets the directory separator.
- </remarks>
- <value>The directory separator.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapFolderConstructorArgs.FullName">
- <summary>
- Get the full name of the folder.
- </summary>
- <remarks>
- This is the equivalent of the full path of a file on a file system.
- </remarks>
- <value>The full name of the folder.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapFolderConstructorArgs.Name">
- <summary>
- Get the name of the folder.
- </summary>
- <remarks>
- This is the equivalent of the file name of a file on the file system.
- </remarks>
- <value>The name of the folder.</value>
- </member>
- <member name="T:MailKit.Net.Imap.ImapImplementation">
- <summary>
- The details of an IMAP client or server implementation.
- </summary>
- <remarks>
- Allows an IMAP client and server to share their implementation details
- with each other for the purposes of debugging.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Imap.ImapImplementation.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapImplementation"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapImplementation"/>.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.Properties">
- <summary>
- Get the identification properties.
- </summary>
- <remarks>
- Gets the dictionary of raw identification properties.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The properties.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.Name">
- <summary>
- Get or set the name of the program.
- </summary>
- <remarks>
- Gets or sets the name of the program.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The program name.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.Version">
- <summary>
- Get or set the version of the program.
- </summary>
- <remarks>
- Gets or sets the version of the program.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The program version.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.OS">
- <summary>
- Get or set the name of the operating system.
- </summary>
- <remarks>
- Gets or sets the name of the operating system.
- </remarks>
- <value>The name of the operation system.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.OSVersion">
- <summary>
- Get or set the version of the operating system.
- </summary>
- <remarks>
- Gets or sets the version of the operating system.
- </remarks>
- <value>The version of the operation system.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.Vendor">
- <summary>
- Get or set the name of the vendor.
- </summary>
- <remarks>
- Gets or sets the name of the vendor.
- </remarks>
- <value>The name of the vendor.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.SupportUrl">
- <summary>
- Get or set the support URL.
- </summary>
- <remarks>
- Gets or sets the support URL.
- </remarks>
- <value>The support URL.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.Address">
- <summary>
- Get or set the postal address of the vendor.
- </summary>
- <remarks>
- Gets or sets the postal address of the vendor.
- </remarks>
- <value>The postal address.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.ReleaseDate">
- <summary>
- Get or set the release date of the program.
- </summary>
- <remarks>
- Gets or sets the release date of the program.
- </remarks>
- <value>The release date.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.Command">
- <summary>
- Get or set the command used to start the program.
- </summary>
- <remarks>
- Gets or sets the command used to start the program.
- </remarks>
- <value>The command used to start the program.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.Arguments">
- <summary>
- Get or set the command-line arguments used to start the program.
- </summary>
- <remarks>
- Gets or sets the command-line arguments used to start the program.
- </remarks>
- <value>The command-line arguments used to start the program.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapImplementation.Environment">
- <summary>
- Get or set the environment variables available to the program.
- </summary>
- <remarks>
- Get or set the environment variables available to the program.
- </remarks>
- <value>The environment variables.</value>
- </member>
- <member name="T:MailKit.Net.Imap.ImapProtocolException">
- <summary>
- An IMAP protocol exception.
- </summary>
- <remarks>
- The exception that is thrown when there is an error communicating with an IMAP server. An
- <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> is typically fatal and requires the <see cref="T:MailKit.Net.Imap.ImapClient"/>
- to be reconnected.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Imap.ImapProtocolException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">An inner exception.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapProtocolException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapProtocolException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapProtocolException"/>.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Imap.ImapProtocolException.UnexpectedToken">
- <summary>
- Gets or sets whether or not this exception was thrown due to an unexpected token.
- </summary>
- <remarks>
- Gets or sets whether or not this exception was thrown due to an unexpected token.
- </remarks>
- <value><c>true</c> if an unexpected token was encountered; otherwise, <c>false</c>.</value>
- </member>
- <member name="T:MailKit.Net.Imap.ImapStreamMode">
- <summary>
- An enumeration of the possible IMAP streaming modes.
- </summary>
- <remarks>
- Normal operation is done in the <see cref="F:MailKit.Net.Imap.ImapStreamMode.Token"/> mode,
- but when reading literal string data, the
- <see cref="F:MailKit.Net.Imap.ImapStreamMode.Literal"/> mode should be used.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Imap.ImapStreamMode.Token">
- <summary>
- Reads 1 token at a time.
- </summary>
- </member>
- <member name="F:MailKit.Net.Imap.ImapStreamMode.Literal">
- <summary>
- Reads literal string data.
- </summary>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.#ctor(System.IO.Stream,MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapStream"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Imap.ImapStream"/>.
- </remarks>
- <param name="source">The underlying network stream.</param>
- <param name="protocolLogger">The protocol logger.</param>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.Stream">
- <summary>
- Get or sets the underlying network stream.
- </summary>
- <remarks>
- Gets or sets the underlying network stream.
- </remarks>
- <value>The underlying network stream.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.Mode">
- <summary>
- Get or sets the mode used for reading.
- </summary>
- <remarks>
- Gets or sets the mode used for reading.
- </remarks>
- <value>The mode.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.LiteralLength">
- <summary>
- Get the length of the literal.
- </summary>
- <remarks>
- Gets the length of the literal.
- </remarks>
- <value>The length of the literal.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.IsConnected">
- <summary>
- Get whether or not the stream is connected.
- </summary>
- <remarks>
- Gets whether or not the stream is connected.
- </remarks>
- <value><c>true</c> if the stream is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.CanRead">
- <summary>
- Get whether the stream supports reading.
- </summary>
- <remarks>
- Gets whether the stream supports reading.
- </remarks>
- <value><c>true</c> if the stream supports reading; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.CanWrite">
- <summary>
- Get whether the stream supports writing.
- </summary>
- <remarks>
- Gets whether the stream supports writing.
- </remarks>
- <value><c>true</c> if the stream supports writing; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.CanSeek">
- <summary>
- Get whether the stream supports seeking.
- </summary>
- <remarks>
- Gets whether the stream supports seeking.
- </remarks>
- <value><c>true</c> if the stream supports seeking; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.CanTimeout">
- <summary>
- Get whether the stream supports I/O timeouts.
- </summary>
- <remarks>
- Gets whether the stream supports I/O timeouts.
- </remarks>
- <value><c>true</c> if the stream supports I/O timeouts; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.ReadTimeout">
- <summary>
- Get or set a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
- </summary>
- <remarks>
- Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
- </remarks>
- <returns>A value, in milliseconds, that determines how long the stream will attempt to read before timing out.</returns>
- <value>The read timeout.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.WriteTimeout">
- <summary>
- Get or set a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
- </summary>
- <remarks>
- Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
- </remarks>
- <returns>A value, in milliseconds, that determines how long the stream will attempt to write before timing out.</returns>
- <value>The write timeout.</value>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.Position">
- <summary>
- Get or set the position within the current stream.
- </summary>
- <remarks>
- Gets or sets the position within the current stream.
- </remarks>
- <returns>The current position within the stream.</returns>
- <value>The position of the stream.</value>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- </member>
- <member name="P:MailKit.Net.Imap.ImapStream.Length">
- <summary>
- Get the length of the stream, in bytes.
- </summary>
- <remarks>
- Gets the length of the stream, in bytes.
- </remarks>
- <returns>A long value representing the length of the stream in bytes.</returns>
- <value>The length of the stream.</value>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.Read(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The stream is in token mode (see <see cref="F:MailKit.Net.Imap.ImapStreamMode.Token"/>).
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.Read(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The stream is in token mode (see <see cref="F:MailKit.Net.Imap.ImapStreamMode.Token"/>).
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <remarks>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </remarks>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.ReadToken(System.Threading.CancellationToken)">
- <summary>
- Reads the next available token from the stream.
- </summary>
- <returns>The token.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.ReadTokenAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously reads the next available token from the stream.
- </summary>
- <returns>The token.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.UngetToken(MailKit.Net.Imap.ImapToken)">
- <summary>
- Ungets a token.
- </summary>
- <param name="token">The token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.ReadLine(System.IO.Stream,System.Threading.CancellationToken)">
- <summary>
- Reads a single line of input from the stream.
- </summary>
- <remarks>
- This method should be called in a loop until it returns <c>true</c>.
- </remarks>
- <returns><c>true</c>, if reading the line is complete, <c>false</c> otherwise.</returns>
- <param name="ostream">The output stream to write the line data into.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.ReadLineAsync(System.IO.Stream,System.Threading.CancellationToken)">
- <summary>
- Asynchronously reads a single line of input from the stream.
- </summary>
- <remarks>
- This method should be called in a loop until it returns <c>true</c>.
- </remarks>
- <returns><c>true</c>, if reading the line is complete, <c>false</c> otherwise.</returns>
- <param name="ostream">The output stream to write the line data into.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.Write(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <remarks>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </remarks>
- <param name='buffer'>The buffer to write.</param>
- <param name='offset'>The offset of the first byte to write.</param>
- <param name='count'>The number of bytes to write.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.Write(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <remarks>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </remarks>
- <param name='buffer'>The buffer to write.</param>
- <param name='offset'>The offset of the first byte to write.</param>
- <param name='count'>The number of bytes to write.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <remarks>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </remarks>
- <returns>A task that represents the asynchronous write operation.</returns>
- <param name='buffer'>The buffer to write.</param>
- <param name='offset'>The offset of the first byte to write.</param>
- <param name='count'>The number of bytes to write.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.Flush(System.Threading.CancellationToken)">
- <summary>
- Clears all output buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <remarks>
- Clears all output buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.Flush">
- <summary>
- Clears all output buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <remarks>
- Clears all output buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </remarks>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.FlushAsync(System.Threading.CancellationToken)">
- <summary>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <remarks>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </remarks>
- <returns>A task that represents the asynchronous flush operation.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.Seek(System.Int64,System.IO.SeekOrigin)">
- <summary>
- Sets the position within the current stream.
- </summary>
- <remarks>
- It is not possible to seek within a <see cref="T:MailKit.Net.Imap.ImapStream"/>.
- </remarks>
- <returns>The new position within the stream.</returns>
- <param name="offset">The offset into the stream relative to the <paramref name="origin"/>.</param>
- <param name="origin">The origin to seek from.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.SetLength(System.Int64)">
- <summary>
- Sets the length of the stream.
- </summary>
- <remarks>
- It is not possible to set the length of a <see cref="T:MailKit.Net.Imap.ImapStream"/>.
- </remarks>
- <param name="value">The desired length of the stream in bytes.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support setting the length.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapStream.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Imap.ImapStream"/> and
- optionally releases the managed resources.
- </summary>
- <remarks>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Imap.ImapStream"/> and
- optionally releases the managed resources.
- </remarks>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="T:MailKit.Net.Imap.ImapUtils">
- <summary>
- IMAP utility functions.
- </summary>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.FormatInternalDate(System.DateTimeOffset)">
- <summary>
- Formats a date in a format suitable for use with the APPEND command.
- </summary>
- <returns>The formatted date string.</returns>
- <param name="date">The date.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseInternalDate(System.String)">
- <summary>
- Parses the internal date string.
- </summary>
- <returns>The date.</returns>
- <param name="text">The text to parse.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.FormatAnnotations(System.Text.StringBuilder,System.Collections.Generic.IList{MailKit.Annotation},System.Collections.Generic.List{System.Object},System.Boolean)">
- <summary>
- Formats a list of annotations for a STORE or APPEND command.
- </summary>
- <param name="command">The command builder.</param>
- <param name="annotations">The annotations.</param>
- <param name="args">the argument list.</param>
- <param name="throwOnError">Throw an exception if there are any annotations without properties.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.FormatIndexSet(System.Collections.Generic.IList{System.Int32})">
- <summary>
- Formats the array of indexes as a string suitable for use with IMAP commands.
- </summary>
- <returns>The index set.</returns>
- <param name="indexes">The indexes.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- One or more of the indexes has a negative value.
- </exception>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseImplementationAsync(MailKit.Net.Imap.ImapEngine,MailKit.Net.Imap.ImapCommand,System.Int32,System.Boolean)">
- <summary>
- Parses an untagged ID response.
- </summary>
- <param name="engine">The IMAP engine.</param>
- <param name="ic">The IMAP command.</param>
- <param name="index">The index.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.CanonicalizeMailboxName(System.String,System.Char)">
- <summary>
- Canonicalize the name of the mailbox.
- </summary>
- <remarks>
- Canonicalizes the name of the mailbox by replacing various
- capitalizations of "INBOX" with the literal "INBOX" string.
- </remarks>
- <returns>The mailbox name.</returns>
- <param name="mailboxName">The encoded mailbox name.</param>
- <param name="directorySeparator">The directory separator.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.IsInbox(System.String)">
- <summary>
- Determines whether the specified mailbox is the Inbox.
- </summary>
- <returns><c>true</c> if the specified mailbox name is the Inbox; otherwise, <c>false</c>.</returns>
- <param name="mailboxName">The mailbox name.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseFolderListAsync(MailKit.Net.Imap.ImapEngine,System.Collections.Generic.List{MailKit.Net.Imap.ImapFolder},System.Boolean,System.Boolean,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Parses an untagged LIST or LSUB response.
- </summary>
- <param name="engine">The IMAP engine.</param>
- <param name="list">The list of folders to be populated.</param>
- <param name="isLsub"><c>true</c> if it is an LSUB response; otherwise, <c>false</c>.</param>
- <param name="returnsSubscribed"><c>true</c> if the LIST response is expected to return \Subscribed flags; otherwise, <c>false</c>.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseFolderListAsync(MailKit.Net.Imap.ImapEngine,MailKit.Net.Imap.ImapCommand,System.Int32,System.Boolean)">
- <summary>
- Parses an untagged LIST or LSUB response.
- </summary>
- <param name="engine">The IMAP engine.</param>
- <param name="ic">The IMAP command.</param>
- <param name="index">The index.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseMetadataAsync(MailKit.Net.Imap.ImapEngine,MailKit.MetadataCollection,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Parses an untagged METADATA response.
- </summary>
- <returns>The encoded name of the folder that the metadata belongs to.</returns>
- <param name="engine">The IMAP engine.</param>
- <param name="metadata">The metadata collection to be populated.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseMetadataAsync(MailKit.Net.Imap.ImapEngine,MailKit.Net.Imap.ImapCommand,System.Int32,System.Boolean)">
- <summary>
- Parses an untagged METADATA response.
- </summary>
- <param name="engine">The IMAP engine.</param>
- <param name="ic">The IMAP command.</param>
- <param name="index">The index.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseEnvelopeAsync(MailKit.Net.Imap.ImapEngine,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Parses the ENVELOPE parenthesized list.
- </summary>
- <returns>The envelope.</returns>
- <param name="engine">The IMAP engine.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.FormatFlagsList(MailKit.MessageFlags,System.Int32)">
- <summary>
- Formats a flags list suitable for use with the APPEND command.
- </summary>
- <returns>The flags list string.</returns>
- <param name="flags">The message flags.</param>
- <param name="numUserFlags">The number of user-defined flags.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseFlagsListAsync(MailKit.Net.Imap.ImapEngine,System.String,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Parses the flags list.
- </summary>
- <returns>The message flags.</returns>
- <param name="engine">The IMAP engine.</param>
- <param name="name">The name of the flags being parsed.</param>
- <param name="keywords">A hash set of user-defined message flags that will be populated if non-null.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseAnnotationsAsync(MailKit.Net.Imap.ImapEngine,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Parses the ANNOTATION list.
- </summary>
- <returns>The list of annotations.</returns>
- <param name="engine">The IMAP engine.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseLabelsListAsync(MailKit.Net.Imap.ImapEngine,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Parses the X-GM-LABELS list.
- </summary>
- <returns>The message labels.</returns>
- <param name="engine">The IMAP engine.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Imap.ImapUtils.ParseThreadsAsync(MailKit.Net.Imap.ImapEngine,System.UInt32,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Parses the threads.
- </summary>
- <returns>The threads.</returns>
- <param name="engine">The IMAP engine.</param>
- <param name="uidValidity">The UIDVALIDITY of the folder.</param>
- <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3Client">
- <summary>
- A POP3 client that can be used to retrieve messages from a server.
- </summary>
- <remarks>
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> class supports both the "pop" and "pops" protocols. The "pop" protocol
- makes a clear-text connection to the POP3 server and does not use SSL or TLS unless the POP3 server
- supports the <a href="https://tools.ietf.org/html/rfc2595">STLS</a> extension. The "pops" protocol,
- however, connects to the POP3 server using an SSL-wrapped connection.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.AuthenticateAsync(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- An POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.AuthenticateAsync(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticates using the supplied credentials.
- </summary>
- <remarks>
- <para>If the POP3 server supports the APOP authentication mechanism,
- then APOP is used.</para>
- <para>If the APOP authentication mechanism is not supported and the
- server supports one or more SASL authentication mechanisms, then
- the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the <c>USER</c> and <c>PASS</c> commands are used as a
- fallback.</para>
- <note type="tip"><para>To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> hash set
- before calling this method.</para>
- <para>In the case of the APOP authentication mechanism, remove it from the
- <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property instead.</para></note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="encoding">The text encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- An POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.ConnectAsync(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified POP3 or POP3/S server.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified POP3 or POP3/S server.</para>
- <para>If the <paramref name="port"/> has a value of <c>0</c>, then the
- <paramref name="options"/> parameter is used to determine the default port to
- connect to. The default port used with <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>
- is <c>995</c>. All other values will use a default port of <c>110</c>.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>995</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> will be
- populated.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the POP3 server does not support the STLS extension.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.ConnectAsync(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified POP3 or POP3/S server using the provided socket.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified POP3 or POP3/S server using
- the provided socket.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>995</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- <para>The <paramref name="host"/> is a zero-length string.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the POP3 server does not support the STLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.ConnectAsync(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified POP3 or POP3/S server using the provided stream.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified POP3 or POP3/S server using
- the provided stream.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>995</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="stream">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the POP3 server does not support the STLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.DisconnectAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously disconnect the service.
- </summary>
- <remarks>
- If <paramref name="quit"/> is <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="quit">If set to <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageCountAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the message count.
- </summary>
- <remarks>
- Asynchronously gets the message count.
- </remarks>
- <returns>The message count.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.NoOpAsync(System.Threading.CancellationToken)">
- <summary>
- Ping the POP3 server to keep the connection alive.
- </summary>
- <remarks>Mail servers, if left idle for too long, will automatically drop the connection.</remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.EnableUTF8Async(System.Threading.CancellationToken)">
- <summary>
- Asynchronously enable UTF8 mode.
- </summary>
- <remarks>
- The POP3 UTF8 extension allows the client to retrieve messages in the UTF-8 encoding and
- may also allow the user to authenticate using a UTF-8 encoded username or password.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has already been authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UTF8 extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetLanguagesAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the list of languages supported by the POP3 server.
- </summary>
- <remarks>
- If the POP3 server supports the LANG extension, it is possible to
- query the list of languages supported by the POP3 server that can
- be used for error messages.
- </remarks>
- <returns>The supported languages.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the LANG extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.SetLanguageAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the language used by the POP3 server for error messages.
- </summary>
- <remarks>
- If the POP3 server supports the LANG extension, it is possible to
- set the language used by the POP3 server for error messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="lang">The language code.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="lang"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="lang"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the LANG extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageUidAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the UID of the message at the specified index.
- </summary>
- <remarks>
- <para>Gets the UID of the message at the specified index.</para>
- <note type="warning">Not all servers support UIDs, so you should first check the
- <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property for the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.UIDL"/> flag or
- the <see cref="P:MailKit.Net.Pop3.Pop3Client.SupportsUids"/> convenience property.</note>
- </remarks>
- <returns>The message UID.</returns>
- <param name="index">The message index.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageUidsAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the full list of available message UIDs.
- </summary>
- <remarks>
- <para>Gets the full list of available message UIDs.</para>
- <note type="warning">Not all servers support UIDs, so you should first check the
- <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property for the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.UIDL"/> flag or
- the <see cref="P:MailKit.Net.Pop3.Pop3Client.SupportsUids"/> convenience property.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadNewMessages"/>
- </example>
- <returns>The message uids.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageSizeAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the size of the specified message, in bytes.
- </summary>
- <remarks>
- Gets the size of the specified message, in bytes.
- </remarks>
- <returns>The message size, in bytes.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageSizesAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the sizes for all available messages, in bytes.
- </summary>
- <remarks>
- Gets the sizes for all available messages, in bytes.
- </remarks>
- <returns>The message sizes, in bytes.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeadersAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the headers for the message at the specified index.
- </summary>
- <remarks>
- Gets the headers for the message at the specified index.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeadersAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the headers for the messages at the specified indexes.
- </summary>
- <remarks>
- <para>Gets the headers for the messages at the specified indexes.</para>
- <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)"/> for each message because
- it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The headers for the specified messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> are invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeadersAsync(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the headers of the messages within the specified range.
- </summary>
- <remarks>
- <para>Gets the headers of the messages within the specified range.</para>
- <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)"/> for each message because
- it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The headers of the messages within the specified range.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message at the specified index.
- </summary>
- <remarks>
- Gets the message at the specified index.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessagesAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the messages at the specified indexes.
- </summary>
- <remarks>
- <para>Gets the messages at the specified indexes.</para>
- <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
- because it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> are invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessagesAsync(System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the messages within the specified range.
- </summary>
- <remarks>
- <para>Gets the messages within the specified range.</para>
- <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
- because it will batch the commands to reduce latency.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="BatchDownloadMessages"/>
- </example>
- <returns>The messages.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetStreamAsync(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message or header stream at the specified index.
- </summary>
- <remarks>
- Gets the message or header stream at the specified index.
- </remarks>
- <returns>The message or header stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetStreamsAsync(System.Collections.Generic.IList{System.Int32},System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message or header streams at the specified indexes.
- </summary>
- <remarks>
- <para>Get the message or header streams at the specified indexes.</para>
- <para>If the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
- because it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The message or header streams.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> are invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetStreamsAsync(System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message or header streams within the specified range.
- </summary>
- <remarks>
- <para>Gets the message or header streams within the specified range.</para>
- <para>If the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
- because it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The message or header streams.</returns>
- <param name="startIndex">The index of the first stream to get.</param>
- <param name="count">The number of streams to get.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteMessageAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark the specified message for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteMessagesAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark the specified messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> are invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteMessagesAsync(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark the specified range of messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="BatchDownloadMessages"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="startIndex">The index of the first message to mark for deletion.</param>
- <param name="count">The number of messages to mark for deletion.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteAllMessagesAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark all messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.ResetAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously reset the state of all messages marked for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An awaitable task.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.#ctor(MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3Client"/> class.
- </summary>
- <remarks>
- Before you can retrieve messages with the <see cref="T:MailKit.Net.Pop3.Pop3Client"/>, you must first call
- one of the <a href="Overload_MailKit_Net_Pop3_Pop3Client_Connect.htm">Connect</a> methods
- and authenticate using one of the
- <a href="Overload_MailKit_Net_Pop3_Pop3Client_Authenticate.htm">Authenticate</a> methods.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="ProtocolLogger"/>
- </example>
- <param name="protocolLogger">The protocol logger.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="protocolLogger"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3Client"/> class.
- </summary>
- <remarks>
- Before you can retrieve messages with the <see cref="T:MailKit.Net.Pop3.Pop3Client"/>, you must first call
- one of the <a href="Overload_MailKit_Net_Pop3_Pop3Client_Connect.htm">Connect</a> methods
- and authenticate using one of the
- <a href="Overload_MailKit_Net_Pop3_Pop3Client_Authenticate.htm">Authenticate</a> methods.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the POP3 server.
- </summary>
- <remarks>
- <para>Gets an object that can be used to synchronize access to the POP3 server.</para>
- <para>When using the non-Async methods from multiple threads, it is important to lock the
- <see cref="P:MailKit.Net.Pop3.Pop3Client.SyncRoot"/> object for thread safety when using the synchronous methods.</para>
- </remarks>
- <value>The lock object.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.Protocol">
- <summary>
- Gets the protocol supported by the message service.
- </summary>
- <remarks>
- Gets the protocol supported by the message service.
- </remarks>
- <value>The protocol.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.Capabilities">
- <summary>
- Gets the capabilities supported by the POP3 server.
- </summary>
- <remarks>
- The capabilities will not be known until a successful connection has been made
- and may change once the client is authenticated.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
- </example>
- <value>The capabilities.</value>
- <exception cref="T:System.ArgumentException">
- Capabilities cannot be enabled, they may only be disabled.
- </exception>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.ExpirePolicy">
- <summary>
- Gets the expiration policy.
- </summary>
- <remarks>
- <para>If the server supports the EXPIRE capability (<see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Expire"/>), the value
- of the <see cref="P:MailKit.Net.Pop3.Pop3Client.ExpirePolicy"/> property will reflect the value advertized by the server.</para>
- <para>A value of <c>-1</c> indicates that messages will never expire.</para>
- <para>A value of <c>0</c> indicates that messages that have been retrieved during the current session
- will be purged immediately after the connection is closed via the <c>QUIT</c> command.</para>
- <para>Values larger than <c>0</c> indicate the minimum number of days that the server will retain
- messages which have been retrieved.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
- </example>
- <value>The expiration policy.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.Implementation">
- <summary>
- Gets the implementation details of the server.
- </summary>
- <remarks>
- If the server advertizes its implementation details, this value will be set to a string containing the
- information details provided by the server.
- </remarks>
- <value>The implementation details.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.LoginDelay">
- <summary>
- Gets the minimum delay, in milliseconds, between logins.
- </summary>
- <remarks>
- If the server supports the LOGIN-DELAY capability (<see cref="F:MailKit.Net.Pop3.Pop3Capabilities.LoginDelay"/>), this value
- will be set to the minimum number of milliseconds that the client must wait between logins.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
- </example>
- <value>The login delay.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms">
- <summary>
- Gets the authentication mechanisms supported by the POP3 server.
- </summary>
- <remarks>
- <para>The authentication mechanisms are queried as part of the
- connection process.</para>
- <para>Servers that do not support the SASL capability will typically
- support either the <c>APOP</c> authentication mechanism
- (<see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Apop"/>) or the ability to login using the
- <c>USER</c> and <c>PASS</c> commands (<see cref="F:MailKit.Net.Pop3.Pop3Capabilities.User"/>).
- </para>
- <note type="tip"><para>To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> hash set
- before authenticating.</para>
- <para>In the case of the APOP authentication mechanism, remove it from the
- <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property instead.</para></note>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
- </example>
- <value>The authentication mechanisms.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.Timeout">
- <summary>
- Gets or sets the timeout for network streaming operations, in milliseconds.
- </summary>
- <remarks>
- Gets or sets the underlying socket stream's <see cref="P:System.IO.Stream.ReadTimeout"/>
- and <see cref="P:System.IO.Stream.WriteTimeout"/> values.
- </remarks>
- <value>The timeout in milliseconds.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.IsConnected">
- <summary>
- Gets whether or not the client is currently connected to an POP3 server.
- </summary>
- <remarks>
- <para>The <see cref="P:MailKit.Net.Pop3.Pop3Client.IsConnected"/> state is set to <c>true</c> immediately after
- one of the <a href="Overload_MailKit_Net_Pop3_Pop3Client_Connect.htm">Connect</a>
- methods succeeds and is not set back to <c>false</c> until either the client
- is disconnected via <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> or until a
- <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> is thrown while attempting to read or write to
- the underlying network socket.</para>
- <para>When an <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> is caught, the connection state of the
- <see cref="T:MailKit.Net.Pop3.Pop3Client"/> should be checked before continuing.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="ExceptionHandling"/>
- </example>
- <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.IsSecure">
- <summary>
- Get whether or not the connection is secure (typically via SSL or TLS).
- </summary>
- <remarks>
- Gets whether or not the connection is secure (typically via SSL or TLS).
- </remarks>
- <value><c>true</c> if the connection is secure; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.IsAuthenticated">
- <summary>
- Get whether or not the client is currently authenticated with the POP3 server.
- </summary>
- <remarks>
- <para>Gets whether or not the client is currently authenticated with the POP3 server.</para>
- <para>To authenticate with the POP3 server, use one of the
- <a href="Overload_MailKit_Net_Pop3_Pop3Client_Authenticate.htm">Authenticate</a> methods.</para>
- </remarks>
- <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.Authenticate(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- An POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.Authenticate(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>If the POP3 server supports the APOP authentication mechanism,
- then APOP is used.</para>
- <para>If the APOP authentication mechanism is not supported and the
- server supports one or more SASL authentication mechanisms, then
- the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the <c>USER</c> and <c>PASS</c> commands are used as a
- fallback.</para>
- <note type="tip"><para>To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> hash set
- before calling this method.</para>
- <para>In the case of the APOP authentication mechanism, remove it from the
- <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property instead.</para></note>
- </remarks>
- <param name="encoding">The text encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- An POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.Connect(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified POP3 or POP3/S server.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified POP3 or POP3/S server.</para>
- <para>If the <paramref name="port"/> has a value of <c>0</c>, then the
- <paramref name="options"/> parameter is used to determine the default port to
- connect to. The default port used with <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>
- is <c>995</c>. All other values will use a default port of <c>110</c>.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>995</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> will be
- populated.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the POP3 server does not support the STLS extension.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.Connect(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified POP3 or POP3/S server using the provided socket.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified POP3 or POP3/S server using
- the provided socket.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>995</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- <para>The <paramref name="host"/> is a zero-length string.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the POP3 server does not support the STLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.Connect(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified POP3 or POP3/S server using the provided stream.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified POP3 or POP3/S server using
- the provided stream.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>995</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <param name="stream">The stream to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the POP3 server does not support the STLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Disconnect the service.
- </summary>
- <remarks>
- If <paramref name="quit"/> is <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <param name="quit">If set to <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageCount(System.Threading.CancellationToken)">
- <summary>
- Get the message count.
- </summary>
- <remarks>
- Gets the message count.
- </remarks>
- <returns>The message count.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.NoOp(System.Threading.CancellationToken)">
- <summary>
- Ping the POP3 server to keep the connection alive.
- </summary>
- <remarks>Mail servers, if left idle for too long, will automatically drop the connection.</remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.EnableUTF8(System.Threading.CancellationToken)">
- <summary>
- Enable UTF8 mode.
- </summary>
- <remarks>
- The POP3 UTF8 extension allows the client to retrieve messages in the UTF-8 encoding and
- may also allow the user to authenticate using a UTF-8 encoded username or password.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has already been authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UTF8 extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetLanguages(System.Threading.CancellationToken)">
- <summary>
- Get the list of languages supported by the POP3 server.
- </summary>
- <remarks>
- If the POP3 server supports the LANG extension, it is possible to
- query the list of languages supported by the POP3 server that can
- be used for error messages.
- </remarks>
- <returns>The supported languages.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the LANG extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.SetLanguage(System.String,System.Threading.CancellationToken)">
- <summary>
- Set the language used by the POP3 server for error messages.
- </summary>
- <remarks>
- If the POP3 server supports the LANG extension, it is possible to
- set the language used by the POP3 server for error messages.
- </remarks>
- <param name="lang">The language code.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="lang"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="lang"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the LANG extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.Count">
- <summary>
- Get the number of messages available in the message spool.
- </summary>
- <remarks>
- <para>Gets the number of messages available on the POP3 server.</para>
- <para>Once authenticated, the <see cref="P:MailKit.Net.Pop3.Pop3Client.Count"/> property will be set
- to the number of available messages on the POP3 server.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <value>The message count.</value>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Client.SupportsUids">
- <summary>
- Gets whether or not the <see cref="T:MailKit.Net.Pop3.Pop3Client"/> supports referencing messages by UIDs.
- </summary>
- <remarks>
- <para>Not all servers support referencing messages by UID, so this property should
- be checked before using <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageUid(System.Int32,System.Threading.CancellationToken)"/>
- and <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageUids(System.Threading.CancellationToken)"/>.</para>
- <para>If the server does not support UIDs, then all methods that take UID arguments
- along with <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageUid(System.Int32,System.Threading.CancellationToken)"/> and
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageUids(System.Threading.CancellationToken)"/> will fail.</para>
- </remarks>
- <value><c>true</c> if supports UIDs; otherwise, <c>false</c>.</value>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageUid(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the UID of the message at the specified index.
- </summary>
- <remarks>
- <para>Gets the UID of the message at the specified index.</para>
- <note type="warning">Not all servers support UIDs, so you should first check the
- <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property for the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.UIDL"/> flag or
- the <see cref="P:MailKit.Net.Pop3.Pop3Client.SupportsUids"/> convenience property.</note>
- </remarks>
- <returns>The message UID.</returns>
- <param name="index">The message index.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageUids(System.Threading.CancellationToken)">
- <summary>
- Get the full list of available message UIDs.
- </summary>
- <remarks>
- <para>Gets the full list of available message UIDs.</para>
- <note type="warning">Not all servers support UIDs, so you should first check the
- <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property for the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.UIDL"/> flag or
- the <see cref="P:MailKit.Net.Pop3.Pop3Client.SupportsUids"/> convenience property.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadNewMessages"/>
- </example>
- <returns>The message uids.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageSize(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the size of the specified message, in bytes.
- </summary>
- <remarks>
- Gets the size of the specified message, in bytes.
- </remarks>
- <returns>The message size, in bytes.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageSizes(System.Threading.CancellationToken)">
- <summary>
- Get the sizes for all available messages, in bytes.
- </summary>
- <remarks>
- Gets the sizes for all available messages, in bytes.
- </remarks>
- <returns>The message sizes, in bytes.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the headers for the message at the specified index.
- </summary>
- <remarks>
- Gets the headers for the message at the specified index.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Get the headers for the messages at the specified indexes.
- </summary>
- <remarks>
- <para>Gets the headers for the messages at the specified indexes.</para>
- <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)"/> for each message because
- it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The headers for the specified messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> are invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the headers of the messages within the specified range.
- </summary>
- <remarks>
- <para>Gets the headers of the messages within the specified range.</para>
- <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)"/> for each message because
- it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The headers of the messages within the specified range.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message at the specified index.
- </summary>
- <remarks>
- Gets the message at the specified index.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessages(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the messages at the specified indexes.
- </summary>
- <remarks>
- <para>Gets the messages at the specified indexes.</para>
- <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
- because it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> are invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessages(System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the messages within the specified range.
- </summary>
- <remarks>
- <para>Gets the messages within the specified range.</para>
- <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
- because it will batch the commands to reduce latency.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="BatchDownloadMessages"/>
- </example>
- <returns>The messages.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message or header stream at the specified index.
- </summary>
- <remarks>
- Gets the message or header stream at the specified index.
- </remarks>
- <returns>The message or header stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetStreams(System.Collections.Generic.IList{System.Int32},System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message or header streams at the specified indexes.
- </summary>
- <remarks>
- <para>Get the message or header streams at the specified indexes.</para>
- <para>If the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
- because it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The message or header streams.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> are invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetStreams(System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message or header streams within the specified range.
- </summary>
- <remarks>
- <para>Gets the message or header streams within the specified range.</para>
- <para>If the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
- extension, this method will likely be more efficient than using
- <see cref="M:MailKit.Net.Pop3.Pop3Client.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
- because it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The message or header streams.</returns>
- <param name="startIndex">The index of the first stream to get.</param>
- <param name="count">The number of streams to get.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UIDL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteMessage(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Mark the specified message for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteMessages(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Mark the specified messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> are invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteMessages(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Mark the specified range of messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="BatchDownloadMessages"/>
- </example>
- <param name="startIndex">The index of the first message to mark for deletion.</param>
- <param name="count">The number of messages to mark for deletion.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteAllMessages(System.Threading.CancellationToken)">
- <summary>
- Mark all messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.Reset(System.Threading.CancellationToken)">
- <summary>
- Reset the state of all messages marked for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.GetEnumerator">
- <summary>
- Get an enumerator for the messages in the folder.
- </summary>
- <remarks>
- Gets an enumerator for the messages in the folder.
- </remarks>
- <returns>The enumerator.</returns>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- A POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Client.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Pop3.Pop3Client"/> and
- optionally releases the managed resources.
- </summary>
- <remarks>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Pop3.Pop3Client"/> and
- optionally releases the managed resources.
- </remarks>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="T:MailKit.Net.Pop3.IPop3Client">
- <summary>
- An interface for a POP3 client.
- </summary>
- <remarks>
- Implemented by <see cref="T:MailKit.Net.Pop3.Pop3Client"/>.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Pop3.IPop3Client.Capabilities">
- <summary>
- Gets the capabilities supported by the POP3 server.
- </summary>
- <remarks>
- The capabilities will not be known until a successful connection has been made
- and may change once the client is authenticated.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
- </example>
- <value>The capabilities.</value>
- <exception cref="T:System.ArgumentException">
- Capabilities cannot be enabled, they may only be disabled.
- </exception>
- </member>
- <member name="P:MailKit.Net.Pop3.IPop3Client.ExpirePolicy">
- <summary>
- Gets the expiration policy.
- </summary>
- <remarks>
- <para>If the server supports the EXPIRE capability (<see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Expire"/>), the value
- of the <see cref="P:MailKit.Net.Pop3.IPop3Client.ExpirePolicy"/> property will reflect the value advertized by the server.</para>
- <para>A value of <c>-1</c> indicates that messages will never expire.</para>
- <para>A value of <c>0</c> indicates that messages that have been retrieved during the current session
- will be purged immediately after the connection is closed via the <c>QUIT</c> command.</para>
- <para>Values larger than <c>0</c> indicate the minimum number of days that the server will retain
- messages which have been retrieved.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
- </example>
- <value>The expiration policy.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.IPop3Client.Implementation">
- <summary>
- Gets the implementation details of the server.
- </summary>
- <remarks>
- If the server advertizes its implementation details, this value will be set to a string containing the
- information details provided by the server.
- </remarks>
- <value>The implementation details.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.IPop3Client.LoginDelay">
- <summary>
- Gets the minimum delay, in milliseconds, between logins.
- </summary>
- <remarks>
- If the server supports the LOGIN-DELAY capability (<see cref="F:MailKit.Net.Pop3.Pop3Capabilities.LoginDelay"/>), this value
- will be set to the minimum number of milliseconds that the client must wait between logins.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
- </example>
- <value>The login delay.</value>
- </member>
- <member name="M:MailKit.Net.Pop3.IPop3Client.EnableUTF8(System.Threading.CancellationToken)">
- <summary>
- Enable UTF8 mode.
- </summary>
- <remarks>
- The POP3 UTF8 extension allows the client to retrieve messages in the UTF-8 encoding and
- may also allow the user to authenticate using a UTF-8 encoded username or password.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has already been authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UTF8 extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.IPop3Client.EnableUTF8Async(System.Threading.CancellationToken)">
- <summary>
- Asynchronously enable UTF8 mode.
- </summary>
- <remarks>
- The POP3 UTF8 extension allows the client to retrieve messages in the UTF-8 encoding and
- may also allow the user to authenticate using a UTF-8 encoded username or password.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has already been authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the UTF8 extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.IPop3Client.GetLanguages(System.Threading.CancellationToken)">
- <summary>
- Get the list of languages supported by the POP3 server.
- </summary>
- <remarks>
- If the POP3 server supports the LANG extension, it is possible to
- query the list of languages supported by the POP3 server that can
- be used for error messages.
- </remarks>
- <returns>The supported languages.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the LANG extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.IPop3Client.GetLanguagesAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the list of languages supported by the POP3 server.
- </summary>
- <remarks>
- If the POP3 server supports the LANG extension, it is possible to
- query the list of languages supported by the POP3 server that can
- be used for error messages.
- </remarks>
- <returns>The supported languages.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the LANG extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.IPop3Client.SetLanguage(System.String,System.Threading.CancellationToken)">
- <summary>
- Set the language used by the POP3 server for error messages.
- </summary>
- <remarks>
- If the POP3 server supports the LANG extension, it is possible to
- set the language used by the POP3 server for error messages.
- </remarks>
- <param name="lang">The language code.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="lang"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="lang"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the LANG extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.IPop3Client.SetLanguageAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the language used by the POP3 server for error messages.
- </summary>
- <remarks>
- If the POP3 server supports the LANG extension, it is possible to
- set the language used by the POP3 server for error messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="lang">The language code.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="lang"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="lang"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The POP3 server does not support the LANG extension.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
- The POP3 command failed.
- </exception>
- <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
- A POP3 protocol error occurred.
- </exception>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3Capabilities">
- <summary>
- Capabilities supported by a POP3 server.
- </summary>
- <remarks>
- Capabilities are read as part of the response to the <c>CAPA</c> command that
- is issued during the connection and authentication phases of the
- <see cref="T:MailKit.Net.Pop3.Pop3Client"/>.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
- </example>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.None">
- <summary>
- The server does not support any additional extensions.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.Apop">
- <summary>
- The server supports <a href="https://tools.ietf.org/html/rfc1939#page-15">APOP</a>
- authentication.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.Expire">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2449">EXPIRE</a> extension
- and defines the expiration policy for messages (see <see cref="P:MailKit.Net.Pop3.Pop3Client.ExpirePolicy"/>).
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.LoginDelay">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2449">LOGIN-DELAY</a> extension,
- allowing the server to specify to the client a minimum number of seconds between login attempts
- (see <see cref="P:MailKit.Net.Pop3.Pop3Client.LoginDelay"/>).
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2449">PIPELINING</a> extension,
- allowing the client to batch multiple requests to the server at at time.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.ResponseCodes">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2449">RESP-CODES</a> extension,
- allowing the server to provide clients with extended information in error responses.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.Sasl">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2449">SASL</a> authentication
- extension, allowing the client to authenticate using the advertized authentication mechanisms
- (see <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/>).
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.StartTLS">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2595">STLS</a> extension,
- allowing clients to switch to an encrypted SSL/TLS connection after connecting.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.Top">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc1939#page-11">TOP</a> command,
- allowing clients to fetch the headers plus an arbitrary number of lines.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.UIDL">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc1939#page-12">UIDL</a> command,
- allowing the client to refer to messages via a UID as opposed to a sequence ID.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.User">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc1939#page-13">USER</a>
- authentication command, allowing the client to authenticate via a plain-text username
- and password command (not recommended unless no other authentication mechanisms exist).
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.UTF8">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6856">UTF8</a> extension,
- allowing clients to retrieve messages in the UTF-8 encoding.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.UTF8User">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6856">UTF8=USER</a> extension,
- allowing clients to authenticate using UTF-8 encoded usernames and passwords.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3Capabilities.Lang">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6856">LANG</a> extension,
- allowing clients to specify which language the server should use for error strings.
- </summary>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3CommandHandler">
- <summary>
- POP3 command handler.
- </summary>
- <remarks>
- All exceptions thrown by the handler are considered fatal and will
- force-disconnect the connection. If a non-fatal error occurs, set
- it on the <see cref="P:MailKit.Net.Pop3.Pop3Command.Exception"/> property.
- </remarks>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3CommandException">
- <summary>
- A POP3 command exception.
- </summary>
- <remarks>
- The exception that is thrown when a POP3 command fails. Unlike a <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/>,
- a <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> does not require the <see cref="T:MailKit.Net.Pop3.Pop3Client"/> to be reconnected.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="ExceptionHandling"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3CommandException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">An inner exception.</param>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3CommandException.#ctor(System.String,System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="statusText">The response status text.</param>
- <param name="innerException">An inner exception.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="statusText"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3CommandException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3CommandException.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="statusText">The response status text.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="statusText"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3CommandException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/>.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3CommandException.StatusText">
- <summary>
- Get the response status text.
- </summary>
- <remarks>
- Gets the response status text.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="ExceptionHandling"/>
- </example>
- <value>The response status text.</value>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3EngineState">
- <summary>
- The state of the <see cref="T:MailKit.Net.Pop3.Pop3Engine"/>.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3EngineState.Disconnected">
- <summary>
- The Pop3Engine is in the disconnected state.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3EngineState.Connected">
- <summary>
- The Pop3Engine is in the connected state.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3EngineState.Transaction">
- <summary>
- The Pop3Engine is in the transaction state, indicating that it is
- authenticated and may retrieve messages from the server.
- </summary>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3Engine">
- <summary>
- A POP3 command engine.
- </summary>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Engine.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3Engine"/> class.
- </summary>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.Uri">
- <summary>
- Gets the URI of the POP3 server.
- </summary>
- <remarks>
- Gets the URI of the POP3 server.
- </remarks>
- <value>The URI of the POP3 server.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.AuthenticationMechanisms">
- <summary>
- Gets the authentication mechanisms supported by the POP3 server.
- </summary>
- <remarks>
- The authentication mechanisms are queried durring the
- <see cref="M:MailKit.Net.Pop3.Pop3Engine.ConnectAsync(MailKit.Net.Pop3.Pop3Stream,System.Threading.CancellationToken)"/> method.
- </remarks>
- <value>The authentication mechanisms.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.Capabilities">
- <summary>
- Gets the capabilities supported by the POP3 server.
- </summary>
- <remarks>
- The capabilities will not be known until a successful connection
- has been made via the <see cref="M:MailKit.Net.Pop3.Pop3Engine.ConnectAsync(MailKit.Net.Pop3.Pop3Stream,System.Threading.CancellationToken)"/> method.
- </remarks>
- <value>The capabilities.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.Stream">
- <summary>
- Gets the underlying POP3 stream.
- </summary>
- <remarks>
- Gets the underlying POP3 stream.
- </remarks>
- <value>The pop3 stream.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.State">
- <summary>
- Gets or sets the state of the engine.
- </summary>
- <remarks>
- Gets or sets the state of the engine.
- </remarks>
- <value>The engine state.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.IsConnected">
- <summary>
- Gets whether or not the engine is currently connected to a POP3 server.
- </summary>
- <remarks>
- Gets whether or not the engine is currently connected to a POP3 server.
- </remarks>
- <value><c>true</c> if the engine is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.ApopToken">
- <summary>
- Gets the APOP authentication token.
- </summary>
- <remarks>
- Gets the APOP authentication token.
- </remarks>
- <value>The APOP authentication token.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.ExpirePolicy">
- <summary>
- Gets the EXPIRE extension policy value.
- </summary>
- <remarks>
- Gets the EXPIRE extension policy value.
- </remarks>
- <value>The EXPIRE policy.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.Implementation">
- <summary>
- Gets the implementation details of the server.
- </summary>
- <remarks>
- Gets the implementation details of the server.
- </remarks>
- <value>The implementation details.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Engine.LoginDelay">
- <summary>
- Gets the login delay.
- </summary>
- <remarks>
- Gets the login delay.
- </remarks>
- <value>The login delay.</value>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Engine.Connect(MailKit.Net.Pop3.Pop3Stream,System.Threading.CancellationToken)">
- <summary>
- Takes posession of the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/> and reads the greeting.
- </summary>
- <remarks>
- Takes posession of the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/> and reads the greeting.
- </remarks>
- <param name="pop3">The pop3 stream.</param>
- <param name="cancellationToken">The cancellation token</param>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Engine.ConnectAsync(MailKit.Net.Pop3.Pop3Stream,System.Threading.CancellationToken)">
- <summary>
- Takes posession of the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/> and reads the greeting.
- </summary>
- <remarks>
- Takes posession of the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/> and reads the greeting.
- </remarks>
- <param name="pop3">The pop3 stream.</param>
- <param name="cancellationToken">The cancellation token</param>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Engine.Disconnect">
- <summary>
- Disconnects the <see cref="T:MailKit.Net.Pop3.Pop3Engine"/>.
- </summary>
- <remarks>
- Disconnects the <see cref="T:MailKit.Net.Pop3.Pop3Engine"/>.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Engine.ReadLine(System.Threading.CancellationToken)">
- <summary>
- Reads a single line from the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/>.
- </summary>
- <returns>The line.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.InvalidOperationException">
- The engine is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Engine.ReadLineAsync(System.Threading.CancellationToken)">
- <summary>
- Reads a single line from the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/>.
- </summary>
- <returns>The line.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.InvalidOperationException">
- The engine is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Engine.Iterate">
- <summary>
- Iterate the command pipeline.
- </summary>
- <returns>The ID of the command that just completed.</returns>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Engine.IterateAsync">
- <summary>
- Iterate the command pipeline.
- </summary>
- <returns>The ID of the command that just completed.</returns>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3Language">
- <summary>
- A POP3 language.
- </summary>
- <remarks>
- A POP3 language.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Language.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3Language"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3Language"/>.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Language.Language">
- <summary>
- Get the language code.
- </summary>
- <remarks>
- Gets the language code. This is the value that should be given to
- <see cref="M:MailKit.Net.Pop3.Pop3Client.SetLanguage(System.String,System.Threading.CancellationToken)"/>.
- </remarks>
- <value>The language.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Language.Description">
- <summary>
- Get the description.
- </summary>
- <remarks>
- Gets the description.
- </remarks>
- <value>The description.</value>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3ProtocolException">
- <summary>
- A POP3 protocol exception.
- </summary>
- <remarks>
- The exception that is thrown when there is an error communicating with a POP3 server. A
- <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> is typically fatal and requires the <see cref="T:MailKit.Net.Pop3.Pop3Client"/>
- to be reconnected.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="ExceptionHandling"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3ProtocolException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">An inner exception.</param>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3ProtocolException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3ProtocolException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/>.
- </remarks>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3StreamMode">
- <summary>
- An enumeration of the possible POP3 streaming modes.
- </summary>
- <remarks>
- Normal operation is done in the <see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Line"/> mode,
- but when retrieving messages (via RETR) or headers (via TOP), the
- <see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Data"/> mode should be used.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3StreamMode.Line">
- <summary>
- Reads 1 line at a time.
- </summary>
- </member>
- <member name="F:MailKit.Net.Pop3.Pop3StreamMode.Data">
- <summary>
- Reads data in chunks, ignoring line state.
- </summary>
- </member>
- <member name="T:MailKit.Net.Pop3.Pop3Stream">
- <summary>
- A stream for communicating with a POP3 server.
- </summary>
- <remarks>
- A stream capable of reading data line-by-line (<see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Line"/>)
- or by raw byte streams (<see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Data"/>).
- </remarks>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.#ctor(System.IO.Stream,MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Pop3.Pop3Stream"/>.
- </remarks>
- <param name="source">The underlying network stream.</param>
- <param name="protocolLogger">The protocol logger.</param>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.Stream">
- <summary>
- Get or sets the underlying network stream.
- </summary>
- <remarks>
- Gets or sets the underlying network stream.
- </remarks>
- <value>The underlying network stream.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.Mode">
- <summary>
- Gets or sets the mode used for reading.
- </summary>
- <value>The mode.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.IsConnected">
- <summary>
- Get whether or not the stream is connected.
- </summary>
- <remarks>
- Gets whether or not the stream is connected.
- </remarks>
- <value><c>true</c> if the stream is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.IsEndOfData">
- <summary>
- Get whether or not the end of the raw data has been reached in <see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Data"/> mode.
- </summary>
- <remarks>
- When reading the resonse to a command such as RETR, the end of the data is marked by line matching ".\r\n".
- </remarks>
- <value><c>true</c> if the end of the data has been reached; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.CanRead">
- <summary>
- Get whether the stream supports reading.
- </summary>
- <remarks>
- Gets whether the stream supports reading.
- </remarks>
- <value><c>true</c> if the stream supports reading; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.CanWrite">
- <summary>
- Get whether the stream supports writing.
- </summary>
- <remarks>
- Gets whether the stream supports writing.
- </remarks>
- <value><c>true</c> if the stream supports writing; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.CanSeek">
- <summary>
- Get whether the stream supports seeking.
- </summary>
- <remarks>
- Gets whether the stream supports seeking.
- </remarks>
- <value><c>true</c> if the stream supports seeking; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.CanTimeout">
- <summary>
- Get whether the stream supports I/O timeouts.
- </summary>
- <remarks>
- Gets whether the stream supports I/O timeouts.
- </remarks>
- <value><c>true</c> if the stream supports I/O timeouts; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.ReadTimeout">
- <summary>
- Get or set a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
- </summary>
- <remarks>
- Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
- </remarks>
- <returns>A value, in milliseconds, that determines how long the stream will attempt to read before timing out.</returns>
- <value>The read timeout.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.WriteTimeout">
- <summary>
- Get or set a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
- </summary>
- <remarks>
- Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
- </remarks>
- <returns>A value, in milliseconds, that determines how long the stream will attempt to write before timing out.</returns>
- <value>The write timeout.</value>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.Position">
- <summary>
- Get or set the position within the current stream.
- </summary>
- <remarks>
- Gets or sets the position within the current stream.
- </remarks>
- <returns>The current position within the stream.</returns>
- <value>The position of the stream.</value>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- </member>
- <member name="P:MailKit.Net.Pop3.Pop3Stream.Length">
- <summary>
- Get the length of the stream, in bytes.
- </summary>
- <remarks>
- Gets the length of the stream, in bytes.
- </remarks>
- <returns>A long value representing the length of the stream in bytes.</returns>
- <value>The length of the stream.</value>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.Read(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <remarks>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </remarks>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The stream is in line mode (see <see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Line"/>).
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.Read(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <remarks>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </remarks>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The stream is in line mode (see <see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Line"/>).
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <remarks>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </remarks>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The stream is in line mode (see <see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Line"/>).
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.ReadLine(System.IO.Stream,System.Threading.CancellationToken)">
- <summary>
- Reads a single line of input from the stream.
- </summary>
- <remarks>
- This method should be called in a loop until it returns <c>true</c>.
- </remarks>
- <returns><c>true</c>, if reading the line is complete, <c>false</c> otherwise.</returns>
- <param name="ostream">The output stream to write the line data into.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.ReadLineAsync(System.IO.Stream,System.Threading.CancellationToken)">
- <summary>
- Asynchronously reads a single line of input from the stream.
- </summary>
- <remarks>
- This method should be called in a loop until it returns <c>true</c>.
- </remarks>
- <returns><c>true</c>, if reading the line is complete, <c>false</c> otherwise.</returns>
- <param name="ostream">The output stream to write the line data into.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.Write(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <remarks>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </remarks>
- <param name='buffer'>The buffer to write.</param>
- <param name='offset'>The offset of the first byte to write.</param>
- <param name='count'>The number of bytes to write.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.Write(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <remarks>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </remarks>
- <param name='buffer'>The buffer to write.</param>
- <param name='offset'>The offset of the first byte to write.</param>
- <param name='count'>The number of bytes to write.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <remarks>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </remarks>
- <returns>A task that represents the asynchronous write operation.</returns>
- <param name='buffer'>The buffer to write.</param>
- <param name='offset'>The offset of the first byte to write.</param>
- <param name='count'>The number of bytes to write.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.Flush(System.Threading.CancellationToken)">
- <summary>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <remarks>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.Flush">
- <summary>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <remarks>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </remarks>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.FlushAsync(System.Threading.CancellationToken)">
- <summary>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <remarks>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </remarks>
- <returns>A task that represents the asynchronous flush operation.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.Seek(System.Int64,System.IO.SeekOrigin)">
- <summary>
- Sets the position within the current stream.
- </summary>
- <returns>The new position within the stream.</returns>
- <param name="offset">The offset into the stream relative to the <paramref name="origin"/>.</param>
- <param name="origin">The origin to seek from.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.SetLength(System.Int64)">
- <summary>
- Sets the length of the stream.
- </summary>
- <param name="value">The desired length of the stream in bytes.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support setting the length.
- </exception>
- </member>
- <member name="M:MailKit.Net.Pop3.Pop3Stream.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/> and
- optionally releases the managed resources.
- </summary>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="T:MailKit.Net.Proxy.HttpProxyClient">
- <summary>
- An HTTP proxy client.
- </summary>
- <remarkas>
- An HTTP proxy client.
- </remarkas>
- </member>
- <member name="M:MailKit.Net.Proxy.HttpProxyClient.#ctor(System.String,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.HttpProxyClient"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.HttpProxyClient"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The <paramref name="host"/> is a zero-length string.</para>
- <para>-or-</para>
- <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.HttpProxyClient.#ctor(System.String,System.Int32,System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.HttpProxyClient"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.HttpProxyClient"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="credentials">The credentials to use to authenticate with the proxy server.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="host"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/>is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The <paramref name="host"/> is a zero-length string.</para>
- <para>-or-</para>
- <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.HttpProxyClient.Connect(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Connect to the target host.
- </summary>
- <remarks>
- Connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.HttpProxyClient.ConnectAsync(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously connect to the target host.
- </summary>
- <remarks>
- Asynchronously connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="T:MailKit.Net.Proxy.IProxyClient">
- <summary>
- An interface for connecting to services via a proxy.
- </summary>
- <remarks>
- Implemented by <see cref="T:MailKit.Net.Smtp.SmtpClient"/>
- and <see cref="T:MailKit.Net.Pop3.Pop3Client"/>.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Proxy.IProxyClient.ProxyCredentials">
- <summary>
- Gets the proxy credentials.
- </summary>
- <remarks>
- Gets the credentials to use when authenticating with the proxy server.
- </remarks>
- <value>The proxy credentials.</value>
- </member>
- <member name="P:MailKit.Net.Proxy.IProxyClient.ProxyHost">
- <summary>
- Get the proxy host.
- </summary>
- <remarks>
- Gets the host name of the proxy server.
- </remarks>
- <value>The host name of the proxy server.</value>
- </member>
- <member name="P:MailKit.Net.Proxy.IProxyClient.ProxyPort">
- <summary>
- Get the proxy port.
- </summary>
- <remarks>
- Gets the port to use when connecting to the proxy server.
- </remarks>
- <value>The proxy port.</value>
- </member>
- <member name="P:MailKit.Net.Proxy.IProxyClient.LocalEndPoint">
- <summary>
- Get or set the local IP end point to use when connecting to a remote host.
- </summary>
- <remarks>
- Gets or sets the local IP end point to use when connecting to a remote host.
- </remarks>
- <value>The local IP end point or <c>null</c> to use the default end point.</value>
- </member>
- <member name="M:MailKit.Net.Proxy.IProxyClient.Connect(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Connect to the target host.
- </summary>
- <remarks>
- Connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.IProxyClient.ConnectAsync(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously connect to the target host.
- </summary>
- <remarks>
- Asynchronously connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.IProxyClient.Connect(System.String,System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Connect to the target host.
- </summary>
- <remarks>
- Connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="timeout">The timeout, in milliseconds.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.TimeoutException">
- The operation timed out.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.IProxyClient.ConnectAsync(System.String,System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously connect to the target host.
- </summary>
- <remarks>
- Asynchronously connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="timeout">The timeout, in milliseconds.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.TimeoutException">
- The operation timed out.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="T:MailKit.Net.Proxy.ProxyClient">
- <summary>
- An abstract proxy client base class.
- </summary>
- <remarks>
- A proxy client can be used to connect to a service through a firewall that
- would otherwise be blocked.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyClient.#ctor(System.String,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyClient"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyClient"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The <paramref name="host"/> is a zero-length string.</para>
- <para>-or-</para>
- <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyClient.#ctor(System.String,System.Int32,System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyClient"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyClient"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="credentials">The credentials to use to authenticate with the proxy server.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="host"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/>is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The <paramref name="host"/> is a zero-length string.</para>
- <para>-or-</para>
- <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
- </exception>
- </member>
- <member name="P:MailKit.Net.Proxy.ProxyClient.ProxyCredentials">
- <summary>
- Gets the proxy credentials.
- </summary>
- <remarks>
- Gets the credentials to use when authenticating with the proxy server.
- </remarks>
- <value>The proxy credentials.</value>
- </member>
- <member name="P:MailKit.Net.Proxy.ProxyClient.ProxyHost">
- <summary>
- Get the proxy host.
- </summary>
- <remarks>
- Gets the host name of the proxy server.
- </remarks>
- <value>The host name of the proxy server.</value>
- </member>
- <member name="P:MailKit.Net.Proxy.ProxyClient.ProxyPort">
- <summary>
- Get the proxy port.
- </summary>
- <remarks>
- Gets the port to use when connecting to the proxy server.
- </remarks>
- <value>The proxy port.</value>
- </member>
- <member name="P:MailKit.Net.Proxy.ProxyClient.LocalEndPoint">
- <summary>
- Get or set the local IP end point to use when connecting to a remote host.
- </summary>
- <remarks>
- Gets or sets the local IP end point to use when connecting to a remote host.
- </remarks>
- <value>The local IP end point or <c>null</c> to use the default end point.</value>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyClient.Connect(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Connect to the target host.
- </summary>
- <remarks>
- Connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyClient.ConnectAsync(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously connect to the target host.
- </summary>
- <remarks>
- Asynchronously connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyClient.Connect(System.String,System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Connect to the target host.
- </summary>
- <remarks>
- Connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="timeout">The timeout, in milliseconds.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="port"/> is not between <c>1</c> and <c>65535</c>.</para>
- <para>-or-</para>
- <para><paramref name="timeout"/> is less than <c>-1</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.TimeoutException">
- The operation timed out.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyClient.ConnectAsync(System.String,System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously connect to the target host.
- </summary>
- <remarks>
- Asynchronously connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="timeout">The timeout, in milliseconds.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="port"/> is not between <c>1</c> and <c>65535</c>.</para>
- <para>-or-</para>
- <para><paramref name="timeout"/> is less than <c>-1</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.TimeoutException">
- The operation timed out.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="T:MailKit.Net.Proxy.ProxyProtocolException">
- <summary>
- A proxy protocol exception.
- </summary>
- <remarks>
- The exception that is thrown when there is an error communicating with a proxy server.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyProtocolException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">An inner exception.</param>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyProtocolException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Net.Proxy.ProxyProtocolException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/>.
- </remarks>
- </member>
- <member name="T:MailKit.Net.Proxy.Socks4aClient">
- <summary>
- A SOCKS4a proxy client.
- </summary>
- <remarkas>
- A SOCKS4a proxy client.
- </remarkas>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks4aClient.#ctor(System.String,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4aClient"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4aClient"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The <paramref name="host"/> is a zero-length string.</para>
- <para>-or-</para>
- <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks4aClient.#ctor(System.String,System.Int32,System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4Client"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4Client"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="credentials">The credentials to use to authenticate with the proxy server.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="host"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/>is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- </member>
- <member name="T:MailKit.Net.Proxy.Socks4Client">
- <summary>
- A SOCKS4 proxy client.
- </summary>
- <remarkas>
- A SOCKS4 proxy client.
- </remarkas>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks4Client.#ctor(System.String,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4Client"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4Client"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The <paramref name="host"/> is a zero-length string.</para>
- <para>-or-</para>
- <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks4Client.#ctor(System.String,System.Int32,System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4Client"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4Client"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="credentials">The credentials to use to authenticate with the proxy server.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="host"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/>is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- </member>
- <member name="P:MailKit.Net.Proxy.Socks4Client.IsSocks4a">
- <summary>
- Get or set whether this <see cref="T:MailKit.Net.Proxy.Socks4Client"/> is a Socks4a client.
- </summary>
- <remarks>
- Gets or sets whether this <see cref="T:MailKit.Net.Proxy.Socks4Client"/> is a Socks4a client.
- </remarks>
- <value><c>true</c> if is is a Socks4a client; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks4Client.Connect(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Connect to the target host.
- </summary>
- <remarks>
- Connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks4Client.ConnectAsync(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously connect to the target host.
- </summary>
- <remarks>
- Asynchronously connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="T:MailKit.Net.Proxy.Socks5Client">
- <summary>
- A SOCKS5 proxy client.
- </summary>
- <remarkas>
- A SOCKS5 proxy client.
- </remarkas>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks5Client.#ctor(System.String,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks5Client"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks5Client"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The <paramref name="host"/> is a zero-length string.</para>
- <para>-or-</para>
- <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks5Client.#ctor(System.String,System.Int32,System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks5Client"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks5Client"/> class.
- </remarks>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="credentials">The credentials to use to authenticate with the proxy server.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="host"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/>is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>The <paramref name="host"/> is a zero-length string.</para>
- <para>-or-</para>
- <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks5Client.Connect(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Connect to the target host.
- </summary>
- <remarks>
- Connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.Socks5Client.ConnectAsync(System.String,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously connect to the target host.
- </summary>
- <remarks>
- Asynchronously connects to the target host and port through the proxy server.
- </remarks>
- <returns>The connected socket.</returns>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="T:MailKit.Net.Proxy.SocksClient">
- <summary>
- An abstract SOCKS proxy client.
- </summary>
- <remarks>
- An abstract SOCKS proxy client.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Proxy.SocksClient.#ctor(System.Int32,System.String,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.SocksClient"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.SocksClient"/> class.
- </remarks>
- <param name="version">The SOCKS protocol version.</param>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- </member>
- <member name="M:MailKit.Net.Proxy.SocksClient.#ctor(System.Int32,System.String,System.Int32,System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.SocksClient"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.SocksClient"/> class.
- </remarks>
- <param name="version">The SOCKS protocol version.</param>
- <param name="host">The host name of the proxy server.</param>
- <param name="port">The proxy server port.</param>
- <param name="credentials">The credentials to use to authenticate with the proxy server.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="host"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/>is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- </member>
- <member name="P:MailKit.Net.Proxy.SocksClient.SocksVersion">
- <summary>
- Get the SOCKS protocol version.
- </summary>
- <remarks>
- Gets the SOCKS protocol version.
- </remarks>
- <value>The SOCKS protocol version.</value>
- </member>
- <member name="T:MailKit.Net.Smtp.SmtpClient">
- <summary>
- An SMTP client that can be used to send email messages.
- </summary>
- <remarks>
- <para>The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> class supports both the "smtp" and "smtps" protocols. The "smtp"
- protocol makes a clear-text connection to the SMTP server and does not use SSL or TLS unless the SMTP
- server supports the <a href="https://tools.ietf.org/html/rfc3207">STARTTLS</a> extension. The "smtps"
- protocol, however, connects to the SMTP server using an SSL-wrapped connection.</para>
- <para>The connection established by any of the
- <a href="Overload_MailKit_Net_Smtp_SmtpClient_Connect.htm">Connect</a> methods may be re-used if an
- application wishes to send multiple messages to the same SMTP server. Since connecting and authenticating
- can be expensive operations, re-using a connection can significantly improve performance when sending a
- large number of messages to the same SMTP server over a short period of time.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessages" />
- </example>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.SendCommandAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously send a custom command to the SMTP server.
- </summary>
- <remarks>
- <para>Asynchronously sends a custom command to the SMTP server.</para>
- <note type="note">The command string should not include the terminating <c>\r\n</c> sequence.</note>
- </remarks>
- <returns>The command response.</returns>
- <param name="command">The command.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="command"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.AuthenticateAsync(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The SMTP server does not support authentication.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.AuthenticateAsync(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>If the SMTP server supports authentication, then the SASL mechanisms
- that both the client and server support are tried in order of greatest
- security to weakest security. Once a SASL authentication mechanism is
- found that both client and server support, the credentials are used to
- authenticate.</para>
- <para>If, on the other hand, authentication is not supported by the SMTP
- server, then this method will throw <see cref="T:System.NotSupportedException"/>.
- The <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> property can be checked for the
- <see cref="F:MailKit.Net.Smtp.SmtpCapabilities.Authentication"/> flag to make sure the
- SMTP server supports authentication before calling this method.</para>
- <note type="tip"> To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="encoding">The text encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The SMTP server does not support authentication.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.ConnectAsync(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified SMTP or SMTP/S server.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified SMTP or SMTP/S server.</para>
- <para>If the <paramref name="port"/> has a value of <c>0</c>, then the
- <paramref name="options"/> parameter is used to determine the default port to
- connect to. The default port used with <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>
- is <c>465</c>. All other values will use a default port of <c>25</c>.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>465</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> will be
- populated.</para>
- <note type="note">The connection established by any of the
- <a href="Overload_MailKit_Net_Smtp_SmtpClient_ConnectAsync.htm">Connect</a>
- methods may be re-used if an application wishes to send multiple messages
- to the same SMTP server. Since connecting and authenticating can be expensive
- operations, re-using a connection can significantly improve performance when
- sending a large number of messages to the same SMTP server over a short
- period of time.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the SMTP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- An SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.ConnectAsync(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified SMTP or SMTP/S server using the provided socket.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified SMTP or SMTP/S server using the provided socket.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>465</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- <para>The <paramref name="host"/> is a zero-length string.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the SMTP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- An SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.ConnectAsync(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified SMTP or SMTP/S server using the provided socket.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified SMTP or SMTP/S server using the provided socket.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>465</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="stream">The stream to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the SMTP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- An SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.DisconnectAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously disconnect the service.
- </summary>
- <remarks>
- If <paramref name="quit"/> is <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="quit">If set to <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.NoOpAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously ping the SMTP server to keep the connection alive.
- </summary>
- <remarks>Mail servers, if left idle for too long, will automatically drop the connection.</remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.SendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message.
- </summary>
- <remarks>
- <para>Sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessageWithOptions"/>
- </example>
- <returns>An asynchronous task context.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.SendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Sends the message by uploading it to an SMTP server using the supplied sender and recipients.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="sender"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="recipients"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.ExpandAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously expand a mailing address alias.
- </summary>
- <remarks>
- Expands a mailing address alias.
- </remarks>
- <returns>The expanded list of mailbox addresses.</returns>
- <param name="alias">The mailing address alias.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="alias"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="alias"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before verifying the existence of an address.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.VerifyAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously verify the existence of a mailbox address.
- </summary>
- <remarks>
- Verifies the existence a mailbox address with the SMTP server, returning the expanded
- mailbox address if it exists.
- </remarks>
- <returns>The expanded mailbox address.</returns>
- <param name="address">The mailbox address.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="address"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="address"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before verifying the existence of an address.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpClient"/> class.
- </summary>
- <remarks>
- Before you can send messages with the <see cref="T:MailKit.Net.Smtp.SmtpClient"/>, you must first call one of
- the <a href="Overload_MailKit_Net_Smtp_SmtpClient_Connect.htm">Connect</a> methods.
- Depending on whether the SMTP server requires authenticating or not, you may also need to
- authenticate using one of the
- <a href="Overload_MailKit_Net_Smtp_SmtpClient_Authenticate.htm">Authenticate</a> methods.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessages" />
- </example>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.#ctor(MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpClient"/> class.
- </summary>
- <remarks>
- Before you can send messages with the <see cref="T:MailKit.Net.Smtp.SmtpClient"/>, you must first call one of
- the <a href="Overload_MailKit_Net_Smtp_SmtpClient_Connect.htm">Connect</a> methods.
- Depending on whether the SMTP server requires authenticating or not, you may also need to
- authenticate using one of the
- <a href="Overload_MailKit_Net_Smtp_SmtpClient_Authenticate.htm">Authenticate</a> methods.
- </remarks>
- <param name="protocolLogger">The protocol logger.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="protocolLogger"/> is <c>null</c>.
- </exception>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ProtocolLogger"/>
- </example>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.Stream">
- <summary>
- Get the underlying SMTP stream.
- </summary>
- <remarks>
- Gets the underlying SMTP stream.
- </remarks>
- <value>The SMTP stream.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the SMTP server.
- </summary>
- <remarks>
- <para>Gets an object that can be used to synchronize access to the SMTP server between multiple threads.</para>
- <para>When using <see cref="T:MailKit.Net.Smtp.SmtpClient"/> methods from multiple threads, it is important to lock the
- <see cref="P:MailKit.Net.Smtp.SmtpClient.SyncRoot"/> object for thread safety.</para>
- </remarks>
- <value>The lock object.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.Protocol">
- <summary>
- Get the protocol supported by the message service.
- </summary>
- <remarks>
- Gets the protocol supported by the message service.
- </remarks>
- <value>The protocol.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.Capabilities">
- <summary>
- Get the capabilities supported by the SMTP server.
- </summary>
- <remarks>
- The capabilities will not be known until a successful connection has been made
- and may change once the client is authenticated.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="Capabilities"/>
- </example>
- <value>The capabilities.</value>
- <exception cref="T:System.ArgumentException">
- Capabilities cannot be enabled, they may only be disabled.
- </exception>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.LocalDomain">
- <summary>
- Get or set the local domain.
- </summary>
- <remarks>
- The local domain is used in the HELO or EHLO commands sent to
- the SMTP server. If left unset, the local IP address will be
- used instead.
- </remarks>
- <value>The local domain.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.PreferSendAsBinaryData">
- <summary>
- Get whether or not the BDAT command is preferred over the DATA command.
- </summary>
- <remarks>
- <para>Gets whether or not the <c>BDAT</c> command is preferred over the standard <c>DATA</c>
- command.</para>
- <para>The <c>BDAT</c> command is normally only used when the message being sent contains binary data
- (e.g. one mor more MIME parts contains a <c>Content-Transfer-Encoding: binary</c> header). This
- option provides a way to override this behavior, forcing the <see cref="T:MailKit.Net.Smtp.SmtpClient"/> to send
- messages using the <c>BDAT</c> command instead of the <c>DATA</c> command even when it is not
- necessary to do so.</para>
- </remarks>
- <value><c>true</c> if the <c>BDAT</c> command is preferred over the <c>DATA</c> command; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.MaxSize">
- <summary>
- Get the maximum message size supported by the server.
- </summary>
- <remarks>
- <para>The maximum message size will not be known until a successful connection has
- been made and may change once the client is authenticated.</para>
- <note type="note">This value is only relevant if the <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> includes
- the <see cref="F:MailKit.Net.Smtp.SmtpCapabilities.Size"/> flag.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="Capabilities"/>
- </example>
- <value>The maximum message size supported by the server.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms">
- <summary>
- Get the authentication mechanisms supported by the SMTP server.
- </summary>
- <remarks>
- <para>The authentication mechanisms are queried as part of the connection
- process.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> hash set
- before authenticating.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="Capabilities"/>
- </example>
- <value>The authentication mechanisms.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.Timeout">
- <summary>
- Get or set the timeout for network streaming operations, in milliseconds.
- </summary>
- <remarks>
- Gets or sets the underlying socket stream's <see cref="P:System.IO.Stream.ReadTimeout"/>
- and <see cref="P:System.IO.Stream.WriteTimeout"/> values.
- </remarks>
- <value>The timeout in milliseconds.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.IsConnected">
- <summary>
- Get whether or not the client is currently connected to an SMTP server.
- </summary>
- <remarks>
- <para>The <see cref="P:MailKit.Net.Smtp.SmtpClient.IsConnected"/> state is set to <c>true</c> immediately after
- one of the <a href="Overload_MailKit_Net_Smtp_SmtpClient_Connect.htm">Connect</a>
- methods succeeds and is not set back to <c>false</c> until either the client
- is disconnected via <see cref="M:MailKit.Net.Smtp.SmtpClient.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> or until an
- <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> is thrown while attempting to read or write to
- the underlying network socket.</para>
- <para>When an <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> is caught, the connection state of the
- <see cref="T:MailKit.Net.Smtp.SmtpClient"/> should be checked before continuing.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
- </example>
- <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.IsSecure">
- <summary>
- Get whether or not the connection is secure (typically via SSL or TLS).
- </summary>
- <remarks>
- Gets whether or not the connection is secure (typically via SSL or TLS).
- </remarks>
- <value><c>true</c> if the connection is secure; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.IsAuthenticated">
- <summary>
- Get whether or not the client is currently authenticated with the SMTP server.
- </summary>
- <remarks>
- <para>Gets whether or not the client is currently authenticated with the SMTP server.</para>
- <para>To authenticate with the SMTP server, use one of the
- <a href="Overload_MailKit_Net_Smtp_SmtpClient_Authenticate.htm">Authenticate</a>
- methods.</para>
- </remarks>
- <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.OnNoRecipientsAccepted(MimeKit.MimeMessage)">
- <summary>
- Invoked only when no recipients were accepted by the SMTP server.
- </summary>
- <remarks>
- If <see cref="M:MailKit.Net.Smtp.SmtpClient.OnRecipientNotAccepted(MimeKit.MimeMessage,MimeKit.MailboxAddress,MailKit.Net.Smtp.SmtpResponse)"/> is overridden to not throw
- an exception, this method should be overridden to throw an appropriate
- exception instead.
- </remarks>
- <param name="message">The message being sent.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.SendCommand(System.String,System.Threading.CancellationToken)">
- <summary>
- Send a custom command to the SMTP server.
- </summary>
- <remarks>
- <para>Sends a custom command to the SMTP server.</para>
- <note type="note">The command string should not include the terminating <c>\r\n</c> sequence.</note>
- </remarks>
- <returns>The command response.</returns>
- <param name="command">The command.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="command"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Authenticate(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The SMTP server does not support authentication.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Authenticate(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>If the SMTP server supports authentication, then the SASL mechanisms
- that both the client and server support are tried in order of greatest
- security to weakest security. Once a SASL authentication mechanism is
- found that both client and server support, the credentials are used to
- authenticate.</para>
- <para>If, on the other hand, authentication is not supported by the SMTP
- server, then this method will throw <see cref="T:System.NotSupportedException"/>.
- The <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> property can be checked for the
- <see cref="F:MailKit.Net.Smtp.SmtpCapabilities.Authentication"/> flag to make sure the
- SMTP server supports authentication before calling this method.</para>
- <note type="tip"> To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <param name="encoding">The text encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The SMTP server does not support authentication.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Connect(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified SMTP or SMTP/S server.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified SMTP or SMTP/S server.</para>
- <para>If the <paramref name="port"/> has a value of <c>0</c>, then the
- <paramref name="options"/> parameter is used to determine the default port to
- connect to. The default port used with <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>
- is <c>465</c>. All other values will use a default port of <c>25</c>.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>465</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> will be
- populated.</para>
- <note type="note">The connection established by any of the
- <a href="Overload_MailKit_Net_Smtp_SmtpClient_Connect.htm">Connect</a>
- methods may be re-used if an application wishes to send multiple messages
- to the same SMTP server. Since connecting and authenticating can be expensive
- operations, re-using a connection can significantly improve performance when
- sending a large number of messages to the same SMTP server over a short
- period of time.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
- </example>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the SMTP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- An SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Connect(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified SMTP or SMTP/S server using the provided socket.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified SMTP or SMTP/S server using the provided socket.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>465</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- <para>The <paramref name="host"/> is a zero-length string.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the SMTP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- An SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Connect(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified SMTP or SMTP/S server using the provided stream.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified SMTP or SMTP/S server using the provided stream.</para>
- <para>If the <paramref name="options"/> has a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
- to determine the default security options. If the <paramref name="port"/> has a value
- of <c>465</c>, then the default options used will be
- <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
- <para>Once a connection is established, properties such as
- <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> will be
- populated.</para>
- <note type="info">With the exception of using the <paramref name="port"/> to determine the
- default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
- is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
- <paramref name="port"/> parameters are only used for logging purposes.</note>
- </remarks>
- <param name="stream">The stream to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already connected.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <paramref name="options"/> was set to
- <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
- and the SMTP server does not support the STARTTLS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled.
- </exception>
- <exception cref="T:MailKit.Security.SslHandshakeException">
- An error occurred during the SSL/TLS negotiations.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- An SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Disconnect(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Disconnect the service.
- </summary>
- <remarks>
- If <paramref name="quit"/> is <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
- </example>
- <param name="quit">If set to <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.NoOp(System.Threading.CancellationToken)">
- <summary>
- Ping the SMTP server to keep the connection alive.
- </summary>
- <remarks>Mail servers, if left idle for too long, will automatically drop the connection.</remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.OnSenderAccepted(MimeKit.MimeMessage,MimeKit.MailboxAddress,MailKit.Net.Smtp.SmtpResponse)">
- <summary>
- Invoked when the sender is accepted by the SMTP server.
- </summary>
- <remarks>
- The default implementation does nothing.
- </remarks>
- <param name="message">The message being sent.</param>
- <param name="mailbox">The mailbox used in the <c>MAIL FROM</c> command.</param>
- <param name="response">The response to the <c>MAIL FROM</c> command.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.OnSenderNotAccepted(MimeKit.MimeMessage,MimeKit.MailboxAddress,MailKit.Net.Smtp.SmtpResponse)">
- <summary>
- Invoked when a recipient is not accepted by the SMTP server.
- </summary>
- <remarks>
- The default implementation throws an appropriate <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
- </remarks>
- <param name="message">The message being sent.</param>
- <param name="mailbox">The mailbox used in the <c>MAIL FROM</c> command.</param>
- <param name="response">The response to the <c>MAIL FROM</c> command.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.GetEnvelopeId(MimeKit.MimeMessage)">
- <summary>
- Get the envelope identifier to be used with delivery status notifications.
- </summary>
- <remarks>
- <para>The envelope identifier, if non-empty, is useful in determining which message a delivery
- status notification was issued for.</para>
- <para>The envelope identifier should be unique and may be up to 100 characters in length, but
- must consist only of printable ASCII characters and no white space.</para>
- <para>For more information, see
- <a href="https://tools.ietf.org/html/rfc3461#section-4.4">rfc3461, section 4.4</a>.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="DeliveryStatusNotification"/>
- </example>
- <returns>The envelope identifier.</returns>
- <param name="message">The message.</param>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpClient.DeliveryStatusNotificationType">
- <summary>
- Get or set how much of the message to include in any failed delivery status notifications.
- </summary>
- <remarks>
- Gets or sets how much of the message to include in any failed delivery status notifications.
- </remarks>
- <value>A value indicating how much of the message to include in a failure delivery status notification.</value>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.OnRecipientAccepted(MimeKit.MimeMessage,MimeKit.MailboxAddress,MailKit.Net.Smtp.SmtpResponse)">
- <summary>
- Invoked when a recipient is accepted by the SMTP server.
- </summary>
- <remarks>
- The default implementation does nothing.
- </remarks>
- <param name="message">The message being sent.</param>
- <param name="mailbox">The mailbox used in the <c>RCPT TO</c> command.</param>
- <param name="response">The response to the <c>RCPT TO</c> command.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.OnRecipientNotAccepted(MimeKit.MimeMessage,MimeKit.MailboxAddress,MailKit.Net.Smtp.SmtpResponse)">
- <summary>
- Invoked when a recipient is not accepted by the SMTP server.
- </summary>
- <remarks>
- The default implementation throws an appropriate <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
- </remarks>
- <param name="message">The message being sent.</param>
- <param name="mailbox">The mailbox used in the <c>RCPT TO</c> command.</param>
- <param name="response">The response to the <c>RCPT TO</c> command.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.GetDeliveryStatusNotifications(MimeKit.MimeMessage,MimeKit.MailboxAddress)">
- <summary>
- Get the types of delivery status notification desired for the specified recipient mailbox.
- </summary>
- <remarks>
- Gets the types of delivery status notification desired for the specified recipient mailbox.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="DeliveryStatusNotification"/>
- </example>
- <returns>The desired delivery status notification type.</returns>
- <param name="message">The message being sent.</param>
- <param name="mailbox">The mailbox.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Prepare(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.EncodingConstraint,System.Int32)">
- <summary>
- Prepare the message for transport with the specified constraints.
- </summary>
- <remarks>
- <para>Prepares the message for transport with the specified constraints.</para>
- <para>Typically, this involves calling <see cref="M:MimeKit.MimeMessage.Prepare(MimeKit.EncodingConstraint,System.Int32)"/> on
- the message with the provided constraints.</para>
- </remarks>
- <param name="options">The format options.</param>
- <param name="message">The message.</param>
- <param name="constraint">The encoding constraint.</param>
- <param name="maxLineLength">The max line length supported by the server.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.GetSize(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken)">
- <summary>
- Get the size of the message.
- </summary>
- <remarks>
- <para>Calculates the size of the message in bytes.</para>
- <para>This method is called by <a href="Overload_MailKit_MailTransport_Send.htm">Send</a>
- methods in the following conditions:</para>
- <list type="bullet">
- <item>The SMTP server supports the <c>SIZE=</c> parameter in the <c>MAIL FROM</c> command.</item>
- <item>The <see cref="T:MailKit.ITransferProgress"/> parameter is non-null.</item>
- <item>The SMTP server supports the <c>CHUNKING</c> extension.</item>
- </list>
- </remarks>
- <returns>The size of the message, in bytes.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.GetSizeAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the size of the message.
- </summary>
- <remarks>
- <para>Asynchronously calculates the size of the message in bytes.</para>
- <para>This method is called by <a href="Overload_MailKit_MailTransport_SendAsync.htm">SendAsync</a>
- methods in the following conditions:</para>
- <list type="bullet">
- <item>The SMTP server supports the <c>SIZE=</c> parameter in the <c>MAIL FROM</c> command.</item>
- <item>The <see cref="T:MailKit.ITransferProgress"/> parameter is non-null.</item>
- <item>The SMTP server supports the <c>CHUNKING</c> extension.</item>
- </list>
- </remarks>
- <returns>The size of the message, in bytes.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Send(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message.
- </summary>
- <remarks>
- <para>Sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessageWithOptions"/>
- </example>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Send(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Sends the message by uploading it to an SMTP server using the supplied sender and recipients.
- </remarks>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="sender"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="recipients"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Expand(System.String,System.Threading.CancellationToken)">
- <summary>
- Expand a mailing address alias.
- </summary>
- <remarks>
- Expands a mailing address alias.
- </remarks>
- <returns>The expanded list of mailbox addresses.</returns>
- <param name="alias">The mailing address alias.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="alias"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="alias"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before verifying the existence of an address.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Verify(System.String,System.Threading.CancellationToken)">
- <summary>
- Verify the existence of a mailbox address.
- </summary>
- <remarks>
- Verifies the existence a mailbox address with the SMTP server, returning the expanded
- mailbox address if it exists.
- </remarks>
- <returns>The expanded mailbox address.</returns>
- <param name="address">The mailbox address.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="address"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="address"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before verifying the existence of an address.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpClient.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Smtp.SmtpClient"/> and
- optionally releases the managed resources.
- </summary>
- <remarks>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Smtp.SmtpClient"/> and
- optionally releases the managed resources.
- </remarks>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="T:MailKit.Net.Smtp.ISmtpClient">
- <summary>
- An interface for an SMTP client.
- </summary>
- <remarks>
- Implemented by <see cref="T:MailKit.Net.Smtp.SmtpClient"/>.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Smtp.ISmtpClient.Capabilities">
- <summary>
- Get the capabilities supported by the SMTP server.
- </summary>
- <remarks>
- The capabilities will not be known until a successful connection has been made
- and may change once the client is authenticated.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="Capabilities"/>
- </example>
- <value>The capabilities.</value>
- <exception cref="T:System.ArgumentException">
- Capabilities cannot be enabled, they may only be disabled.
- </exception>
- </member>
- <member name="P:MailKit.Net.Smtp.ISmtpClient.LocalDomain">
- <summary>
- Get or set the local domain.
- </summary>
- <remarks>
- The local domain is used in the HELO or EHLO commands sent to
- the SMTP server. If left unset, the local IP address will be
- used instead.
- </remarks>
- <value>The local domain.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.ISmtpClient.MaxSize">
- <summary>
- Get the maximum message size supported by the server.
- </summary>
- <remarks>
- <para>The maximum message size will not be known until a successful connection has
- been made and may change once the client is authenticated.</para>
- <note type="note">This value is only relevant if the <see cref="P:MailKit.Net.Smtp.ISmtpClient.Capabilities"/> includes
- the <see cref="F:MailKit.Net.Smtp.SmtpCapabilities.Size"/> flag.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="Capabilities"/>
- </example>
- <value>The maximum message size supported by the server.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.ISmtpClient.DeliveryStatusNotificationType">
- <summary>
- Get or set how much of the message to include in any failed delivery status notifications.
- </summary>
- <remarks>
- Gets or sets how much of the message to include in any failed delivery status notifications.
- </remarks>
- <value>A value indicating how much of the message to include in a failure delivery status notification.</value>
- </member>
- <member name="M:MailKit.Net.Smtp.ISmtpClient.Expand(System.String,System.Threading.CancellationToken)">
- <summary>
- Expand a mailing address alias.
- </summary>
- <remarks>
- Expands a mailing address alias.
- </remarks>
- <returns>The expanded list of mailbox addresses.</returns>
- <param name="alias">The mailing address alias.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="alias"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="alias"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before verifying the existence of an address.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.ISmtpClient.ExpandAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously expand a mailing address alias.
- </summary>
- <remarks>
- Expands a mailing address alias.
- </remarks>
- <returns>The expanded list of mailbox addresses.</returns>
- <param name="alias">The mailing address alias.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="alias"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="alias"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before verifying the existence of an address.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.ISmtpClient.Verify(System.String,System.Threading.CancellationToken)">
- <summary>
- Verify the existence of a mailbox address.
- </summary>
- <remarks>
- Verifies the existence a mailbox address with the SMTP server, returning the expanded
- mailbox address if it exists.
- </remarks>
- <returns>The expanded mailbox address.</returns>
- <param name="address">The mailbox address.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="address"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="address"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before verifying the existence of an address.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.ISmtpClient.VerifyAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously verify the existence of a mailbox address.
- </summary>
- <remarks>
- Verifies the existence a mailbox address with the SMTP server, returning the expanded
- mailbox address if it exists.
- </remarks>
- <returns>The expanded mailbox address.</returns>
- <param name="address">The mailbox address.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="address"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="address"/> is an empty string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before verifying the existence of an address.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
- The SMTP command failed.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol exception occurred.
- </exception>
- </member>
- <member name="T:MailKit.Net.Smtp.SmtpCapabilities">
- <summary>
- Capabilities supported by an SMTP server.
- </summary>
- <remarks>
- Capabilities are read as part of the response to the EHLO command that
- is issued during the connection phase of the <see cref="T:MailKit.Net.Smtp.SmtpClient"/>.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="Capabilities"/>
- </example>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.None">
- <summary>
- The server does not support any additional extensions.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.Size">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc1870">SIZE</a> extension
- and may have a maximum message size limitation (see <see cref="P:MailKit.Net.Smtp.SmtpClient.MaxSize"/>).
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.Dsn">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc1891">DSN</a> extension,
- allowing clients to specify which (if any) recipients they would like to receive delivery
- notifications for.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.EnhancedStatusCodes">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2034">ENHANCEDSTATUSCODES</a>
- extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.Authentication">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2554">AUTH</a> extension,
- allowing clients to authenticate via supported SASL mechanisms.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.EightBitMime">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2821">8BITMIME</a> extension,
- allowing clients to send messages using the "8bit" Content-Transfer-Encoding.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.Pipelining">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc2920">PIPELINING</a> extension,
- allowing clients to send multiple commands at once in order to reduce round-trip latency.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.BinaryMime">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc3030">BINARYMIME</a> extension.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.Chunking">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc3030">CHUNKING</a> extension,
- allowing clients to upload messages in chunks.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.StartTLS">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc3207">STARTTLS</a> extension,
- allowing clients to switch to an encrypted SSL/TLS connection after connecting.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpCapabilities.UTF8">
- <summary>
- The server supports the <a href="https://tools.ietf.org/html/rfc6531">SMTPUTF8</a> extension.
- </summary>
- </member>
- <member name="T:MailKit.Net.Smtp.SmtpErrorCode">
- <summary>
- An enumeration of the possible error codes that may be reported by a <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
- </summary>
- <remarks>
- An enumeration of the possible error codes that may be reported by a <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
- </example>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpErrorCode.MessageNotAccepted">
- <summary>
- The message was not accepted for delivery. This may happen if
- the server runs out of available disk space.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpErrorCode.SenderNotAccepted">
- <summary>
- The sender's mailbox address was not accepted. Check the
- <see cref="P:MailKit.Net.Smtp.SmtpCommandException.Mailbox"/> property for the
- mailbox used as the sender's mailbox address.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpErrorCode.RecipientNotAccepted">
- <summary>
- A recipient's mailbox address was not accepted. Check the
- <see cref="P:MailKit.Net.Smtp.SmtpCommandException.Mailbox"/> property for the
- particular recipient mailbox that was not acccepted.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpErrorCode.UnexpectedStatusCode">
- <summary>
- An unexpected status code was returned by the server.
- For more details, the <see cref="P:System.Exception.Message"/>
- property may provide some additional hints.
- </summary>
- </member>
- <member name="T:MailKit.Net.Smtp.SmtpCommandException">
- <summary>
- An SMTP protocol exception.
- </summary>
- <remarks>
- The exception that is thrown when an SMTP command fails. Unlike a <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/>,
- a <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> does not require the <see cref="T:MailKit.Net.Smtp.SmtpClient"/> to be reconnected.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpCommandException.#ctor(MailKit.Net.Smtp.SmtpErrorCode,MailKit.Net.Smtp.SmtpStatusCode,MimeKit.MailboxAddress,System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
- </remarks>
- <param name="code">The error code.</param>
- <param name="status">The status code.</param>
- <param name="mailbox">The rejected mailbox.</param>
- <param name="message">The error message.</param>
- <param name="innerException">The inner exception.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpCommandException.#ctor(MailKit.Net.Smtp.SmtpErrorCode,MailKit.Net.Smtp.SmtpStatusCode,MimeKit.MailboxAddress,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
- </remarks>
- <param name="code">The error code.</param>
- <param name="status">The status code.</param>
- <param name="mailbox">The rejected mailbox.</param>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpCommandException.#ctor(MailKit.Net.Smtp.SmtpErrorCode,MailKit.Net.Smtp.SmtpStatusCode,System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
- </remarks>
- <param name="code">The error code.</param>
- <param name="status">The status code.</param>>
- <param name="message">The error message.</param>
- <param name="innerException">The inner exception.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpCommandException.#ctor(MailKit.Net.Smtp.SmtpErrorCode,MailKit.Net.Smtp.SmtpStatusCode,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
- </remarks>
- <param name="code">The error code.</param>
- <param name="status">The status code.</param>>
- <param name="message">The error message.</param>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpCommandException.ErrorCode">
- <summary>
- Gets the error code which may provide additional information.
- </summary>
- <remarks>
- The error code can be used to programatically deal with the
- exception without necessarily needing to display the raw
- exception message to the user.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
- </example>
- <value>The status code.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpCommandException.Mailbox">
- <summary>
- Gets the mailbox that the error occurred on.
- </summary>
- <remarks>
- This property will only be available when the <see cref="P:MailKit.Net.Smtp.SmtpCommandException.ErrorCode"/>
- value is either <see cref="F:MailKit.Net.Smtp.SmtpErrorCode.SenderNotAccepted"/> or
- <see cref="F:MailKit.Net.Smtp.SmtpErrorCode.RecipientNotAccepted"/> and may be used
- to help the user decide how to proceed.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
- </example>
- <value>The mailbox.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpCommandException.StatusCode">
- <summary>
- Gets the status code returned by the SMTP server.
- </summary>
- <remarks>
- The raw SMTP status code that resulted in the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>
- being thrown.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
- </example>
- <value>The status code.</value>
- </member>
- <member name="T:MailKit.Net.Smtp.SmtpDataFilter">
- <summary>
- An SMTP filter designed to format a message stream for the DATA command.
- </summary>
- <remarks>
- A special stream filter that escapes lines beginning with a '.' as needed when
- sending a message via the SMTP protocol or when saving a message to an IIS
- message pickup directory.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SaveToPickupDirectory" />
- </example>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpDataFilter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpDataFilter"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpDataFilter"/>.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SaveToPickupDirectory" />
- </example>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpDataFilter.Filter(System.Byte[],System.Int32,System.Int32,System.Int32@,System.Int32@,System.Boolean)">
- <summary>
- Filter the specified input.
- </summary>
- <remarks>
- Filters the specified input buffer starting at the given index,
- spanning across the specified number of bytes.
- </remarks>
- <returns>The filtered output.</returns>
- <param name="input">The input buffer.</param>
- <param name="startIndex">The starting index of the input buffer.</param>
- <param name="length">The length of the input buffer, starting at <paramref name="startIndex"/>.</param>
- <param name="outputIndex">The output index.</param>
- <param name="outputLength">The output length.</param>
- <param name="flush">If set to <c>true</c>, all internally buffered data should be flushed to the output buffer.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpDataFilter.Reset">
- <summary>
- Reset the filter.
- </summary>
- <remarks>
- Resets the filter.
- </remarks>
- </member>
- <member name="T:MailKit.Net.Smtp.SmtpProtocolException">
- <summary>
- An SMTP protocol exception.
- </summary>
- <remarks>
- The exception that is thrown when there is an error communicating with an SMTP server. An
- <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> is typically fatal and requires the <see cref="T:MailKit.Net.Smtp.SmtpClient"/>
- to be reconnected.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
- </example>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpProtocolException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">The inner exception.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpProtocolException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpProtocolException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/>.
- </remarks>
- </member>
- <member name="T:MailKit.Net.Smtp.SmtpResponse">
- <summary>
- An SMTP command response.
- </summary>
- <remarks>
- An SMTP command response.
- </remarks>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpResponse.StatusCode">
- <summary>
- Get the status code.
- </summary>
- <remarks>
- Gets the status code.
- </remarks>
- <value>The status code.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpResponse.Response">
- <summary>
- Get the response text.
- </summary>
- <remarks>
- Gets the response text.
- </remarks>
- <value>The response text.</value>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpResponse.#ctor(MailKit.Net.Smtp.SmtpStatusCode,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpResponse"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpResponse"/>.
- </remarks>
- <param name="code">The status code.</param>
- <param name="response">The response text.</param>
- </member>
- <member name="T:MailKit.Net.Smtp.SmtpStatusCode">
- <summary>
- An enumeration of possible SMTP status codes.
- </summary>
- <remarks>
- An enumeration of possible SMTP status codes.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.SystemStatus">
- <summary>
- The "system status" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.HelpMessage">
- <summary>
- The "help" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.ServiceReady">
- <summary>
- The "service ready" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.ServiceClosingTransmissionChannel">
- <summary>
- The "service closing transmission channel" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.AuthenticationSuccessful">
- <summary>
- The "authentication successful" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.Ok">
- <summary>
- The general purpose "OK" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.UserNotLocalWillForward">
- <summary>
- The "User not local; will forward" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.CannotVerifyUserWillAttemptDelivery">
- <summary>
- The "cannot verify user; will attempt delivery" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.AuthenticationChallenge">
- <summary>
- The "authentication challenge" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.StartMailInput">
- <summary>
- The "start mail input" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.ServiceNotAvailable">
- <summary>
- The "service not available" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.PasswordTransitionNeeded">
- <summary>
- The "password transition needed" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.MailboxBusy">
- <summary>
- The "mailbox busy" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.ErrorInProcessing">
- <summary>
- The "error in processing" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.InsufficientStorage">
- <summary>
- The "insufficient storage" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.TemporaryAuthenticationFailure">
- <summary>
- The "temporary authentication failure" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.CommandUnrecognized">
- <summary>
- The "command unrecognized" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.SyntaxError">
- <summary>
- The "syntax error" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.CommandNotImplemented">
- <summary>
- The "command not implemented" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.BadCommandSequence">
- <summary>
- The "bad command sequence" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.CommandParameterNotImplemented">
- <summary>
- The "command parameter not implemented" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.AuthenticationRequired">
- <summary>
- The "authentication required" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.AuthenticationMechanismTooWeak">
- <summary>
- The "authentication mechanism too weak" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.AuthenticationInvalidCredentials">
- <summary>
- The "authentication invalid credentials" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.EncryptionRequiredForAuthenticationMechanism">
- <summary>
- The "encryption required for authentication mechanism" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.MailboxUnavailable">
- <summary>
- The "mailbox unavailable" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.UserNotLocalTryAlternatePath">
- <summary>
- The "user not local try alternate path" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.ExceededStorageAllocation">
- <summary>
- The "exceeded storage allocation" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.MailboxNameNotAllowed">
- <summary>
- The "mailbox name not allowed" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.TransactionFailed">
- <summary>
- The "transaction failed" status code.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.SmtpStatusCode.MailFromOrRcptToParametersNotRecognizedOrNotImplemented">
- <summary>
- The "mail from/rcpt to parameters not recognized or not implemented" status code.
- </summary>
- </member>
- <member name="T:MailKit.Net.Smtp.SmtpStream">
- <summary>
- A stream for communicating with an SMTP server.
- </summary>
- <remarks>
- A stream capable of reading SMTP server responses.
- </remarks>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.#ctor(System.IO.Stream,MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpStream"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Net.Smtp.SmtpStream"/>.
- </remarks>
- <param name="source">The underlying network stream.</param>
- <param name="protocolLogger">The protocol logger.</param>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.Stream">
- <summary>
- Get or sets the underlying network stream.
- </summary>
- <remarks>
- Gets or sets the underlying network stream.
- </remarks>
- <value>The underlying network stream.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.IsConnected">
- <summary>
- Get whether or not the stream is connected.
- </summary>
- <remarks>
- Gets whether or not the stream is connected.
- </remarks>
- <value><c>true</c> if the stream is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.CanRead">
- <summary>
- Get whether the stream supports reading.
- </summary>
- <remarks>
- Gets whether the stream supports reading.
- </remarks>
- <value><c>true</c> if the stream supports reading; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.CanWrite">
- <summary>
- Get whether the stream supports writing.
- </summary>
- <remarks>
- Gets whether the stream supports writing.
- </remarks>
- <value><c>true</c> if the stream supports writing; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.CanSeek">
- <summary>
- Get whether the stream supports seeking.
- </summary>
- <remarks>
- Gets whether the stream supports seeking.
- </remarks>
- <value><c>true</c> if the stream supports seeking; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.CanTimeout">
- <summary>
- Get whether the stream supports I/O timeouts.
- </summary>
- <remarks>
- Gets whether the stream supports I/O timeouts.
- </remarks>
- <value><c>true</c> if the stream supports I/O timeouts; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.ReadTimeout">
- <summary>
- Get or set a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
- </summary>
- <remarks>
- Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
- </remarks>
- <returns>A value, in milliseconds, that determines how long the stream will attempt to read before timing out.</returns>
- <value>The read timeout.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.WriteTimeout">
- <summary>
- Get or set a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
- </summary>
- <remarks>
- Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
- </remarks>
- <returns>A value, in milliseconds, that determines how long the stream will attempt to write before timing out.</returns>
- <value>The write timeout.</value>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.Position">
- <summary>
- Get or set the position within the current stream.
- </summary>
- <remarks>
- Gets or sets the position within the current stream.
- </remarks>
- <returns>The current position within the stream.</returns>
- <value>The position of the stream.</value>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- </member>
- <member name="P:MailKit.Net.Smtp.SmtpStream.Length">
- <summary>
- Get the length of the stream, in bytes.
- </summary>
- <remarks>
- Gets the length of the stream, in bytes.
- </remarks>
- <returns>A long value representing the length of the stream in bytes.</returns>
- <value>The length of the stream.</value>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.Read(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <remarks>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </remarks>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.Read(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <remarks>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </remarks>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <remarks>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </remarks>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.ReadResponse(System.Threading.CancellationToken)">
- <summary>
- Read an SMTP server response.
- </summary>
- <remarks>
- Reads a full command response from the SMTP server.
- </remarks>
- <returns>The response.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.ReadResponseAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously read an SMTP server response.
- </summary>
- <remarks>
- Reads a full command response from the SMTP server.
- </remarks>
- <returns>The response.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
- An SMTP protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.Write(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <remarks>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </remarks>
- <param name='buffer'>The buffer to write.</param>
- <param name='offset'>The offset of the first byte to write.</param>
- <param name='count'>The number of bytes to write.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.Write(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <remarks>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </remarks>
- <param name='buffer'>The buffer to write.</param>
- <param name='offset'>The offset of the first byte to write.</param>
- <param name='count'>The number of bytes to write.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <remarks>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </remarks>
- <returns>A task that represents the asynchronous write operation.</returns>
- <param name='buffer'>The buffer to write.</param>
- <param name='offset'>The offset of the first byte to write.</param>
- <param name='count'>The number of bytes to write.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.Flush(System.Threading.CancellationToken)">
- <summary>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <remarks>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.Flush">
- <summary>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <remarks>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </remarks>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.FlushAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <remarks>
- Clears all buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </remarks>
- <returns>A task that represents the asynchronous flush operation.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.Seek(System.Int64,System.IO.SeekOrigin)">
- <summary>
- Sets the position within the current stream.
- </summary>
- <returns>The new position within the stream.</returns>
- <param name="offset">The offset into the stream relative to the <paramref name="origin"/>.</param>
- <param name="origin">The origin to seek from.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.SetLength(System.Int64)">
- <summary>
- Sets the length of the stream.
- </summary>
- <param name="value">The desired length of the stream in bytes.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support setting the length.
- </exception>
- </member>
- <member name="M:MailKit.Net.Smtp.SmtpStream.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Smtp.SmtpStream"/> and
- optionally releases the managed resources.
- </summary>
- <remarks>
- Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Smtp.SmtpStream"/> and
- optionally releases the managed resources.
- </remarks>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="T:MailKit.Net.Smtp.DeliveryStatusNotificationType">
- <summary>
- Delivery status notification type.
- </summary>
- <remarks>
- The delivery status notification type specifies whether or not
- the full message should be included in any failed DSN issued for
- a message transmission as opposed to just the headers.
- </remarks>
- </member>
- <member name="F:MailKit.Net.Smtp.DeliveryStatusNotificationType.Unspecified">
- <summary>
- The return type is unspecified, allowing the server to choose.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.DeliveryStatusNotificationType.Full">
- <summary>
- The full message should be included in any failed delivery status notification issued by the server.
- </summary>
- </member>
- <member name="F:MailKit.Net.Smtp.DeliveryStatusNotificationType.HeadersOnly">
- <summary>
- Only the headers should be included in any failed delivery status notification issued by the server.
- </summary>
- </member>
- <member name="T:MailKit.Search.AnnotationSearchQuery">
- <summary>
- An annotation-based search query.
- </summary>
- <remarks>
- An annotation-based search query.
- </remarks>
- </member>
- <member name="M:MailKit.Search.AnnotationSearchQuery.#ctor(MailKit.AnnotationEntry,MailKit.AnnotationAttribute,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.AnnotationSearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new annotation-based search query.
- </remarks>
- <param name="entry">The annotation entry.</param>
- <param name="attribute">The annotation attribute.</param>
- <param name="value">The annotation attribute value.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="entry"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="attribute"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="attribute"/> is not a valid attribute for searching.
- </exception>
- </member>
- <member name="P:MailKit.Search.AnnotationSearchQuery.Entry">
- <summary>
- Get the annotation entry.
- </summary>
- <remarks>
- Gets the annotation entry.
- </remarks>
- <value>The annotation entry.</value>
- </member>
- <member name="P:MailKit.Search.AnnotationSearchQuery.Attribute">
- <summary>
- Get the annotation attribute.
- </summary>
- <remarks>
- Gets the annotation attribute.
- </remarks>
- <value>The annotation attribute.</value>
- </member>
- <member name="P:MailKit.Search.AnnotationSearchQuery.Value">
- <summary>
- Get the annotation attribute value.
- </summary>
- <remarks>
- Gets the annotation attribute value.
- </remarks>
- <value>The annotation attribute value.</value>
- </member>
- <member name="T:MailKit.Search.BinarySearchQuery">
- <summary>
- A binary search query such as an AND or OR expression.
- </summary>
- <remarks>
- A binary search query such as an AND or OR expression.
- </remarks>
- </member>
- <member name="M:MailKit.Search.BinarySearchQuery.#ctor(MailKit.Search.SearchTerm,MailKit.Search.SearchQuery,MailKit.Search.SearchQuery)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.BinarySearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new binary search query.
- </remarks>
- <param name="term">THe search term.</param>
- <param name="left">The left expression.</param>
- <param name="right">The right expression.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="left"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="right"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Search.BinarySearchQuery.Left">
- <summary>
- Gets the left operand of the expression.
- </summary>
- <remarks>
- Gets the left operand of the expression.
- </remarks>
- <value>The left operand.</value>
- </member>
- <member name="P:MailKit.Search.BinarySearchQuery.Right">
- <summary>
- Gets the right operand of the expression.
- </summary>
- <remarks>
- Gets the right operand of the expression.
- </remarks>
- <value>The right operand.</value>
- </member>
- <member name="T:MailKit.Search.DateSearchQuery">
- <summary>
- A date-based search query.
- </summary>
- <remarks>
- A date-based search query.
- </remarks>
- </member>
- <member name="M:MailKit.Search.DateSearchQuery.#ctor(MailKit.Search.SearchTerm,System.DateTime)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.DateSearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new date-based search query.
- </remarks>
- <param name="term">The search term.</param>
- <param name="date">The date.</param>
- </member>
- <member name="P:MailKit.Search.DateSearchQuery.Date">
- <summary>
- Gets the date value of the search query.
- </summary>
- <remarks>
- Gets the date value of the search query.
- </remarks>
- <value>The date.</value>
- </member>
- <member name="T:MailKit.Search.FilterSearchQuery">
- <summary>
- A filter-based search query.
- </summary>
- <remarks>
- A filter-based search query.
- </remarks>
- </member>
- <member name="M:MailKit.Search.FilterSearchQuery.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.FilterSearchQuery"/> class.
- </summary>
- <remarks>
- A search query that references a predefined filter.
- </remarks>
- <param name="name">The name of the filter.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.FilterSearchQuery.#ctor(MailKit.MetadataTag)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.FilterSearchQuery"/> class.
- </summary>
- <remarks>
- A search query that references a predefined filter.
- </remarks>
- <param name="filter">The metadata tag representing the filter.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="filter"/> does not reference a valid filter.
- </exception>
- </member>
- <member name="P:MailKit.Search.FilterSearchQuery.Name">
- <summary>
- Get the name of the filter.
- </summary>
- <remarks>
- Gets the name of the filter.
- </remarks>
- <value>The name of the filter.</value>
- </member>
- <member name="T:MailKit.Search.HeaderSearchQuery">
- <summary>
- A header-based search query.
- </summary>
- <remarks>
- A header-based search query.
- </remarks>
- </member>
- <member name="M:MailKit.Search.HeaderSearchQuery.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.HeaderSearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new header search query.
- </remarks>
- <param name="field">The header field name.</param>
- <param name="value">The value to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="field"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="value"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="field"/> is empty.
- </exception>
- </member>
- <member name="P:MailKit.Search.HeaderSearchQuery.Field">
- <summary>
- Gets the header field name.
- </summary>
- <remarks>
- Gets the header field name.
- </remarks>
- <value>The header field.</value>
- </member>
- <member name="P:MailKit.Search.HeaderSearchQuery.Value">
- <summary>
- Gets the value to match against.
- </summary>
- <remarks>
- Gets the value to match against.
- </remarks>
- <value>The value.</value>
- </member>
- <member name="T:MailKit.Search.NumericSearchQuery">
- <summary>
- A numeric search query.
- </summary>
- <remarks>
- A numeric search query.
- </remarks>
- </member>
- <member name="M:MailKit.Search.NumericSearchQuery.#ctor(MailKit.Search.SearchTerm,System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.NumericSearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new numeric search query.
- </remarks>
- <param name="term">The search term.</param>
- <param name="value">The numeric value.</param>
- </member>
- <member name="P:MailKit.Search.NumericSearchQuery.Value">
- <summary>
- Gets the numeric value to match against.
- </summary>
- <remarks>
- Gets the numeric value to match against.
- </remarks>
- <value>The numeric value.</value>
- </member>
- <member name="T:MailKit.Search.OrderBy">
- <summary>
- Specifies a sort order for search results.
- </summary>
- <remarks>
- You can combine multiple <see cref="T:MailKit.Search.OrderBy"/> rules to specify the sort
- order that <see cref="M:MailKit.IMailFolder.Sort(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)"/>
- should return the results in.
- </remarks>
- </member>
- <member name="M:MailKit.Search.OrderBy.#ctor(MailKit.Search.OrderByType,MailKit.Search.SortOrder)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.OrderBy"/> class.
- </summary>
- <param name="type">The field to sort by.</param>
- <param name="order">The sort order.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="order"/> cannot be <see cref="F:MailKit.Search.SortOrder.None"/>.
- </exception>
- </member>
- <member name="P:MailKit.Search.OrderBy.Type">
- <summary>
- Gets the field used for sorting.
- </summary>
- <remarks>
- Gets the field used for sorting.
- </remarks>
- <value>The field used for sorting.</value>
- </member>
- <member name="P:MailKit.Search.OrderBy.Order">
- <summary>
- Gets the sort order.
- </summary>
- <remarks>
- Gets the sort order.
- </remarks>
- <value>The sort order.</value>
- </member>
- <member name="F:MailKit.Search.OrderBy.Arrival">
- <summary>
- Sort results by arrival date in ascending order.
- </summary>
- <remarks>
- Sort results by arrival date in ascending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.ReverseArrival">
- <summary>
- Sort results by arrival date in desending order.
- </summary>
- <remarks>
- Sort results by arrival date in desending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.Cc">
- <summary>
- Sort results by the first email address in the Cc header in ascending order.
- </summary>
- <remarks>
- Sort results by the first email address in the Cc header in ascending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.ReverseCc">
- <summary>
- Sort results by the first email address in the Cc header in descending order.
- </summary>
- <remarks>
- Sort results by the first email address in the Cc header in descending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.Date">
- <summary>
- Sort results by the sent date in ascending order.
- </summary>
- <remarks>
- Sort results by the sent date in ascending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.ReverseDate">
- <summary>
- Sort results by the sent date in descending order.
- </summary>
- <remarks>
- Sort results by the sent date in descending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.From">
- <summary>
- Sort results by the first email address in the From header in ascending order.
- </summary>
- <remarks>
- Sort results by the first email address in the From header in ascending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.ReverseFrom">
- <summary>
- Sort results by the first email address in the From header in descending order.
- </summary>
- <remarks>
- Sort results by the first email address in the From header in descending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.DisplayFrom">
- <summary>
- Sort results by the first display name in the From header in ascending order.
- </summary>
- <remarks>
- Sort results by the first display name in the From header in ascending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.ReverseDisplayFrom">
- <summary>
- Sort results by the first display name in the From header in descending order.
- </summary>
- <remarks>
- Sort results by the first display name in the From header in descending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.Size">
- <summary>
- Sort results by the message size in ascending order.
- </summary>
- <remarks>
- Sort results by the message size in ascending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.ReverseSize">
- <summary>
- Sort results by the message size in descending order.
- </summary>
- <remarks>
- Sort results by the message size in descending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.Subject">
- <summary>
- Sort results by the Subject header in ascending order.
- </summary>
- <remarks>
- Sort results by the Subject header in ascending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.ReverseSubject">
- <summary>
- Sort results by the Subject header in descending order.
- </summary>
- <remarks>
- Sort results by the Subject header in descending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.To">
- <summary>
- Sort results by the first email address in the To header in ascending order.
- </summary>
- <remarks>
- Sort results by the first email address in the To header in ascending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.ReverseTo">
- <summary>
- Sort results by the first email address in the To header in descending order.
- </summary>
- <remarks>
- Sort results by the first email address in the To header in descending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.DisplayTo">
- <summary>
- Sort results by the first display name in the To header in ascending order.
- </summary>
- <remarks>
- Sort results by the first display name in the To header in ascending order.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderBy.ReverseDisplayTo">
- <summary>
- Sort results by the first display name in the To header in descending order.
- </summary>
- <remarks>
- Sort results by the first display name in the To header in descending order.
- </remarks>
- </member>
- <member name="T:MailKit.Search.OrderByAnnotation">
- <summary>
- Specifies an annotation-based sort order for search results.
- </summary>
- <remarks>
- You can combine multiple <see cref="T:MailKit.Search.OrderBy"/> rules to specify the sort
- order that <see cref="M:MailKit.IMailFolder.Sort(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)"/>
- should return the results in.
- </remarks>
- </member>
- <member name="M:MailKit.Search.OrderByAnnotation.#ctor(MailKit.AnnotationEntry,MailKit.AnnotationAttribute,MailKit.Search.SortOrder)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.OrderByAnnotation"/> class.
- </summary>
- <param name="entry">The annotation entry to sort by.</param>
- <param name="attribute">The annotation attribute to use for sorting.</param>
- <param name="order">The sort order.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="entry"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="attribute"/>is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="attribute"/> is not a valid attribute for sorting.
- </exception>
- </member>
- <member name="P:MailKit.Search.OrderByAnnotation.Entry">
- <summary>
- Get the annotation entry.
- </summary>
- <remarks>
- Gets the annotation entry.
- </remarks>
- <value>The annotation entry.</value>
- </member>
- <member name="P:MailKit.Search.OrderByAnnotation.Attribute">
- <summary>
- Get the annotation attribute.
- </summary>
- <remarks>
- Gets the annotation attribute.
- </remarks>
- <value>The annotation attribute.</value>
- </member>
- <member name="T:MailKit.Search.OrderByType">
- <summary>
- The field to sort by.
- </summary>
- <remarks>
- The field to sort by.
- </remarks>
- </member>
- <member name="F:MailKit.Search.OrderByType.Annotation">
- <summary>
- Sort by an annotation value.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.Arrival">
- <summary>
- Sort by the arrival date.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.Cc">
- <summary>
- Sort by the Cc header.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.Date">
- <summary>
- Sort by the Date header.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.DisplayFrom">
- <summary>
- Sort by the Display Name of the From header.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.DisplayTo">
- <summary>
- Sort by the Display Name of the To header.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.From">
- <summary>
- Sort by the From header.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.ModSeq">
- <summary>
- Sort by the mod-sequence.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.Size">
- <summary>
- Sort by the message size.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.Subject">
- <summary>
- Sort by the message subject.
- </summary>
- </member>
- <member name="F:MailKit.Search.OrderByType.To">
- <summary>
- Sort by the To header.
- </summary>
- </member>
- <member name="T:MailKit.Search.SearchOptions">
- <summary>
- Advanced search options.
- </summary>
- <remarks>
- Advanced search options.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SearchOptions.None">
- <summary>
- No options specified.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchOptions.All">
- <summary>
- Returns all of the matching unique identifiers.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchOptions.Count">
- <summary>
- Returns the number of messages that match the search query.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchOptions.Min">
- <summary>
- Returns the minimum unique identifier of the messages that match the search query.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchOptions.Max">
- <summary>
- Returns the maximum unique identifier of the messages that match the search query.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchOptions.Relevancy">
- <summary>
- Returns the relevancy scores of the messages that match the query. Can only be used
- when using FUZZY search.
- </summary>
- </member>
- <member name="T:MailKit.Search.SearchQuery">
- <summary>
- A specialized query for searching messages in a <see cref="T:MailKit.IMailFolder"/>.
- </summary>
- <remarks>
- A specialized query for searching messages in a <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.SearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Search.SearchQuery"/> that matches all messages.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.#ctor(MailKit.Search.SearchTerm)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.SearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Search.SearchQuery"/> with the specified search term.
- </remarks>
- <param name="term">The search term.</param>
- </member>
- <member name="P:MailKit.Search.SearchQuery.Term">
- <summary>
- Get the search term used by the search query.
- </summary>
- <remarks>
- Gets the search term used by the search query.
- </remarks>
- <value>The term.</value>
- </member>
- <member name="F:MailKit.Search.SearchQuery.All">
- <summary>
- Match all messages in the folder.
- </summary>
- <remarks>
- Matches all messages in the folder.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.And(MailKit.Search.SearchQuery,MailKit.Search.SearchQuery)">
- <summary>
- Create a conditional AND operation.
- </summary>
- <remarks>
- A conditional AND operation only evaluates the second operand if the first operand evaluates to true.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.BinarySearchQuery"/> representing the conditional AND operation.</returns>
- <param name="left">The first operand.</param>
- <param name="right">The second operand.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="left"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="right"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.And(MailKit.Search.SearchQuery)">
- <summary>
- Create a conditional AND operation.
- </summary>
- <remarks>
- A conditional AND operation only evaluates the second operand if the first operand evaluates to true.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.BinarySearchQuery"/> representing the conditional AND operation.</returns>
- <param name="expr">An additional query to execute.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="expr"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.AnnotationsContain(MailKit.AnnotationEntry,MailKit.AnnotationAttribute,System.String)">
- <summary>
- Match messages with the specified annotation.
- </summary>
- <remarks>
- <para>Matches messages with the specified annotation.</para>
- <note type="warning">This feature is not supported by all IMAP servers.</note>
- </remarks>
- <param name="entry">The annotation entry.</param>
- <param name="attribute">The annotation attribute.</param>
- <param name="value">The annotation attribute value.</param>
- <returns>A <see cref="T:MailKit.Search.AnnotationSearchQuery"/>.</returns>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="entry"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="attribute"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="attribute"/> is not a valid attribute for searching.
- </exception>
- </member>
- <member name="F:MailKit.Search.SearchQuery.Answered">
- <summary>
- Match messages with the <see cref="F:MailKit.MessageFlags.Answered"/> flag set.
- </summary>
- <remarks>
- Matches messages with the <see cref="F:MailKit.MessageFlags.Answered"/> flag set.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.BccContains(System.String)">
- <summary>
- Match messages where the Bcc header contains the specified text.
- </summary>
- <remarks>
- Matches messages where the Bcc header contains the specified text.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="text">The text to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="text"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.BodyContains(System.String)">
- <summary>
- Match messages where the message body contains the specified text.
- </summary>
- <remarks>
- Matches messages where the message body contains the specified text.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="text">The text to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="text"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.CcContains(System.String)">
- <summary>
- Match messages where the Cc header contains the specified text.
- </summary>
- <remarks>
- Matches messages where the Cc header contains the specified text.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="text">The text to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="text"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.ChangedSince(System.UInt64)">
- <summary>
- Match messages that have mod-sequence values greater than or equal to the specified mod-sequence value.
- </summary>
- <remarks>
- Matches messages that have mod-sequence values greater than or equal to the specified mod-sequence value.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
- <param name="modseq">The mod-sequence value.</param>
- </member>
- <member name="F:MailKit.Search.SearchQuery.Deleted">
- <summary>
- Match messages with the <see cref="F:MailKit.MessageFlags.Deleted"/> flag set.
- </summary>
- <remarks>
- Matches messages with the <see cref="F:MailKit.MessageFlags.Deleted"/> flag set.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.DeliveredAfter(System.DateTime)">
- <summary>
- Match messages that were delivered after the specified date.
- </summary>
- <remarks>
- <para>Matches messages that were delivered after the specified date.</para>
- <para>The resolution of this search query does not include the time.</para>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
- <param name="date">The date.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.DeliveredBefore(System.DateTime)">
- <summary>
- Match messages that were delivered before the specified date.
- </summary>
- <remarks>
- <para>Matches messages that were delivered before the specified date.</para>
- <para>The resolution of this search query does not include the time.</para>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
- <param name="date">The date.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.DeliveredOn(System.DateTime)">
- <summary>
- Match messages that were delivered on the specified date.
- </summary>
- <remarks>
- <para>Matches messages that were delivered on the specified date.</para>
- <para>The resolution of this search query does not include the time.</para>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
- <param name="date">The date.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.DoesNotHaveCustomFlag(System.String)">
- <summary>
- Match messages that do not have the specified custom flag set.
- </summary>
- <remarks>
- Matches messages that do not have the specified custom flag set.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="flag">The custom flag.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="flag"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="flag"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.DoesNotHaveCustomFlags(System.Collections.Generic.IEnumerable{System.String})">
- <summary>
- Match messages that do not have any of the specified custom flags set.
- </summary>
- <remarks>
- Matches messages that do not have any of the specified custom flags set.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
- <param name="flags">The custom flags.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="flags"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="flags"/> is <c>null</c> or empty.</para>
- <para>-or-</para>
- <para>No custom flags were given.</para>
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.DoesNotHaveFlags(MailKit.MessageFlags)">
- <summary>
- Match messages that do not have any of the specified flags set.
- </summary>
- <remarks>
- Matches messages that do not have any of the specified flags set.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
- <param name="flags">The message flags.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="flags"/> does not specify any valid message flags.
- </exception>
- </member>
- <member name="F:MailKit.Search.SearchQuery.Draft">
- <summary>
- Match messages with the <see cref="F:MailKit.MessageFlags.Draft"/> flag set.
- </summary>
- <remarks>
- Matches messages with the <see cref="F:MailKit.MessageFlags.Draft"/> flag set.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.Filter(System.String)">
- <summary>
- Match messages using a saved search filter.
- </summary>
- <remarks>
- Matches messages using a saved search filter.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.FilterSearchQuery"/>.</returns>
- <param name="name">The name of the saved search.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.Filter(MailKit.MetadataTag)">
- <summary>
- Match messages using a saved search filter.
- </summary>
- <remarks>
- Matches messages using a saved search filter.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.FilterSearchQuery"/>.</returns>
- <param name="filter">The name of the saved search.</param>
- </member>
- <member name="F:MailKit.Search.SearchQuery.Flagged">
- <summary>
- Match messages with the <see cref="F:MailKit.MessageFlags.Flagged"/> flag set.
- </summary>
- <remarks>
- Matches messages with the <see cref="F:MailKit.MessageFlags.Flagged"/> flag set.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.FromContains(System.String)">
- <summary>
- Match messages where the From header contains the specified text.
- </summary>
- <remarks>
- Matches messages where the From header contains the specified text.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="text">The text to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="text"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.Fuzzy(MailKit.Search.SearchQuery)">
- <summary>
- Apply a fuzzy matching algorithm to the specified expression.
- </summary>
- <remarks>
- <para>Applies a fuzzy matching algorithm to the specified expression.</para>
- <note type="warning">This feature is not supported by all IMAP servers.</note>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.UnarySearchQuery"/>.</returns>
- <param name="expr">The expression</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="expr"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.HasCustomFlag(System.String)">
- <summary>
- Match messages that have the specified custom flag set.
- </summary>
- <remarks>
- Matches messages that have the specified custom flag set.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="flag">The custom flag.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="flag"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="flag"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.HasCustomFlags(System.Collections.Generic.IEnumerable{System.String})">
- <summary>
- Match messages that have the specified custom flags set.
- </summary>
- <remarks>
- Matches messages that have the specified custom flags set.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
- <param name="flags">The custom flags.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="flags"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="flags"/> is <c>null</c> or empty.</para>
- <para>-or-</para>
- <para>No custom flags were given.</para>
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.HasFlags(MailKit.MessageFlags)">
- <summary>
- Match messages that have the specified flags set.
- </summary>
- <remarks>
- Matches messages that have the specified flags set.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
- <param name="flags">The message flags.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="flags"/> does not specify any valid message flags.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.NotFlags(MailKit.MessageFlags)">
- <summary>
- Match messages that do not have any of the specified flags set.
- </summary>
- <remarks>
- Matches messages that do not have any of the specified flags set.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
- <param name="flags">The message flags.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="flags"/> does not specify any valid message flags.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.HasKeyword(System.String)">
- <summary>
- Match messages that have the specified keyword set.
- </summary>
- <remarks>
- <para>Matches messages that have the specified keyword set.</para>
- <note type="info">A keyword is a user-defined message flag.</note>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="keyword">The keyword.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="keyword"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="keyword"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.HasKeywords(System.Collections.Generic.IEnumerable{System.String})">
- <summary>
- Match messages that have all of the specified keywords set.
- </summary>
- <remarks>
- <para>Matches messages that have all of the specified keywords set.</para>
- <note type="info">A keyword is a user-defined message flag.</note>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
- <param name="keywords">The keywords.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="keywords"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="keywords"/> is <c>null</c> or empty.</para>
- <para>-or-</para>
- <para>No keywords were given.</para>
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.NotKeyword(System.String)">
- <summary>
- Match messages that do not have the specified keyword set.
- </summary>
- <remarks>
- <para>Matches messages that do not have the specified keyword set.</para>
- <note type="info">A keyword is a user-defined message flag.</note>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="keyword">The keyword.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="keyword"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="keyword"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.NotKeywords(System.Collections.Generic.IEnumerable{System.String})">
- <summary>
- Match messages that do not have any of the specified keywords set.
- </summary>
- <remarks>
- <para>Matches messages that do not have any of the specified keywords set.</para>
- <note type="info">A keyword is a user-defined message flag.</note>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
- <param name="keywords">The keywords.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="keywords"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="keywords"/> is <c>null</c> or empty.</para>
- <para>-or-</para>
- <para>No keywords were given.</para>
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.HeaderContains(System.String,System.String)">
- <summary>
- Match messages where the specified header contains the specified text.
- </summary>
- <remarks>
- Matches messages where the specified header contains the specified text.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.HeaderSearchQuery"/>.</returns>
- <param name="field">The header field to match against.</param>
- <param name="text">The text to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="field"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="text"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="field"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.LargerThan(System.Int32)">
- <summary>
- Match messages that are larger than the specified number of octets.
- </summary>
- <remarks>
- Matches messages that are larger than the specified number of octets.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.NumericSearchQuery"/>.</returns>
- <param name="octets">The number of octets.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="octets"/> is a negative value.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.MessageContains(System.String)">
- <summary>
- Match messages where the raw message contains the specified text.
- </summary>
- <remarks>
- Matches messages where the raw message contains the specified text.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="text">The text to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="text"/> is empty.
- </exception>
- </member>
- <member name="F:MailKit.Search.SearchQuery.New">
- <summary>
- Match messages with the <see cref="F:MailKit.MessageFlags.Recent"/> flag set but not the <see cref="F:MailKit.MessageFlags.Seen"/>.
- </summary>
- <remarks>
- Matches messages with the <see cref="F:MailKit.MessageFlags.Recent"/> flag set but not the <see cref="F:MailKit.MessageFlags.Seen"/>.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.Not(MailKit.Search.SearchQuery)">
- <summary>
- Create a logical negation of the specified expression.
- </summary>
- <remarks>
- Creates a logical negation of the specified expression.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.UnarySearchQuery"/>.</returns>
- <param name="expr">The expression</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="expr"/> is <c>null</c>.
- </exception>
- </member>
- <member name="F:MailKit.Search.SearchQuery.NotAnswered">
- <summary>
- Match messages that do not have the <see cref="F:MailKit.MessageFlags.Answered"/> flag set.
- </summary>
- <remarks>
- Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Answered"/> flag set.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SearchQuery.NotDeleted">
- <summary>
- Match messages that do not have the <see cref="F:MailKit.MessageFlags.Deleted"/> flag set.
- </summary>
- <remarks>
- Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Deleted"/> flag set.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SearchQuery.NotDraft">
- <summary>
- Match messages that do not have the <see cref="F:MailKit.MessageFlags.Draft"/> flag set.
- </summary>
- <remarks>
- Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Draft"/> flag set.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SearchQuery.NotFlagged">
- <summary>
- Match messages that do not have the <see cref="F:MailKit.MessageFlags.Flagged"/> flag set.
- </summary>
- <remarks>
- Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Flagged"/> flag set.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SearchQuery.NotRecent">
- <summary>
- Match messages that do not have the <see cref="F:MailKit.MessageFlags.Recent"/> flag set.
- </summary>
- <remarks>
- Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Recent"/> flag set.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SearchQuery.NotSeen">
- <summary>
- Match messages that do not have the <see cref="F:MailKit.MessageFlags.Seen"/> flag set.
- </summary>
- <remarks>
- Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Seen"/> flag set.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SearchQuery.Old">
- <summary>
- Match messages that do not have the <see cref="F:MailKit.MessageFlags.Recent"/> flag set.
- </summary>
- <remarks>
- Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Recent"/> flag set.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.OlderThan(System.Int32)">
- <summary>
- Match messages older than the specified number of seconds.
- </summary>
- <remarks>
- Matches messages older than the specified number of seconds.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.NumericSearchQuery"/>.</returns>
- <param name="seconds">The number of seconds.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The number of seconds cannot be less than <c>1</c>.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.Or(MailKit.Search.SearchQuery,MailKit.Search.SearchQuery)">
- <summary>
- Create a conditional OR operation.
- </summary>
- <remarks>
- A conditional OR operation only evaluates the second operand if the first operand evaluates to false.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.BinarySearchQuery"/> representing the conditional OR operation.</returns>
- <param name="left">The first operand.</param>
- <param name="right">The second operand.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="left"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="right"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.Or(MailKit.Search.SearchQuery)">
- <summary>
- Create a conditional OR operation.
- </summary>
- <remarks>
- A conditional OR operation only evaluates the second operand if the first operand evaluates to true.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.BinarySearchQuery"/> representing the conditional AND operation.</returns>
- <param name="expr">An additional query to execute.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="expr"/> is <c>null</c>.
- </exception>
- </member>
- <member name="F:MailKit.Search.SearchQuery.Recent">
- <summary>
- Match messages with the <see cref="F:MailKit.MessageFlags.Recent"/> flag set.
- </summary>
- <remarks>
- Matches messages with the <see cref="F:MailKit.MessageFlags.Recent"/> flag set.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SearchQuery.Seen">
- <summary>
- Match messages with the <see cref="F:MailKit.MessageFlags.Seen"/> flag set.
- </summary>
- <remarks>
- Matches messages with the <see cref="F:MailKit.MessageFlags.Seen"/> flag set.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchQuery.SentAfter(System.DateTime)">
- <summary>
- Match messages that were sent on or after the specified date.
- </summary>
- <remarks>
- <para>Matches messages that were sent on or after the specified date.</para>
- <para>The resolution of this search query does not include the time.</para>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
- <param name="date">The date.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.SentBefore(System.DateTime)">
- <summary>
- Match messages that were sent before the specified date.
- </summary>
- <remarks>
- <para>Matches messages that were sent before the specified date.</para>
- <note type="note">The resolution of this search query does not include the time.</note>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
- <param name="date">The date.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.SentOn(System.DateTime)">
- <summary>
- Match messages that were sent on the specified date.
- </summary>
- <remarks>
- <para>Matches messages that were sent on the specified date.</para>
- <note type="note">The resolution of this search query does not include the time.</note>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
- <param name="date">The date.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.SentSince(System.DateTime)">
- <summary>
- Match messages that were sent since the specified date.
- </summary>
- <remarks>
- <para>Matches messages that were sent since the specified date.</para>
- <note type="note">The resolution of this search query does not include the time.</note>
- </remarks>
- <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
- <param name="date">The date.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.SmallerThan(System.Int32)">
- <summary>
- Match messages that are smaller than the specified number of octets.
- </summary>
- <remarks>
- Matches messages that are smaller than the specified number of octets.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.NumericSearchQuery"/>.</returns>
- <param name="octets">The number of octets.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="octets"/> is a negative value.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.SubjectContains(System.String)">
- <summary>
- Match messages where the Subject header contains the specified text.
- </summary>
- <remarks>
- Matches messages where the Subject header contains the specified text.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="text">The text to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="text"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.ToContains(System.String)">
- <summary>
- Match messages where the To header contains the specified text.
- </summary>
- <remarks>
- Matches messages where the To header contains the specified text.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="text">The text to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="text"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.Uids(System.Collections.Generic.IList{MailKit.UniqueId})">
- <summary>
- Limit the search query to messages with the specified unique identifiers.
- </summary>
- <remarks>
- Limits the search query to messages with the specified unique identifiers.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.UidSearchQuery"/>.</returns>
- <param name="uids">The unique identifiers.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uids"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.YoungerThan(System.Int32)">
- <summary>
- Match messages younger than the specified number of seconds.
- </summary>
- <remarks>
- Matches messages younger than the specified number of seconds.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.NumericSearchQuery"/>.</returns>
- <param name="seconds">The number of seconds.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The number of seconds cannot be less than <c>1</c>.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.GMailMessageId(System.UInt64)">
- <summary>
- Match messages that have the specified GMail message identifier.
- </summary>
- <remarks>
- This search term can only be used with GMail.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.NumericSearchQuery"/>.</returns>
- <param name="id">The GMail message identifier.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.GMailThreadId(System.UInt64)">
- <summary>
- Match messages belonging to the specified GMail thread.
- </summary>
- <remarks>
- This search term can only be used with GMail.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.NumericSearchQuery"/>.</returns>
- <param name="thread">The GMail thread.</param>
- </member>
- <member name="M:MailKit.Search.SearchQuery.HasGMailLabel(System.String)">
- <summary>
- Match messages that have the specified GMail label.
- </summary>
- <remarks>
- This search term can only be used with GMail.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="label">The GMail label.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="label"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="label"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.SearchQuery.GMailRawSearch(System.String)">
- <summary>
- Match messages using the GMail search expression.
- </summary>
- <remarks>
- This search term can only be used with GMail.
- </remarks>
- <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
- <param name="expression">The raw GMail search text.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="expression"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="expression"/> is empty.
- </exception>
- </member>
- <member name="T:MailKit.Search.SearchResults">
- <summary>
- The results of a search.
- </summary>
- <remarks>
- The results of a search.
- </remarks>
- </member>
- <member name="M:MailKit.Search.SearchResults.#ctor(MailKit.Search.SortOrder)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.SearchResults"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Search.SearchResults"/>.
- </remarks>
- <param name="order">The sort-order to use for the unique identifiers.</param>
- </member>
- <member name="P:MailKit.Search.SearchResults.UniqueIds">
- <summary>
- Get or set the unique identifiers of the messages that matched the search query.
- </summary>
- <remarks>
- Gets or sets the unique identifiers of the messages that matched the search query.
- </remarks>
- <value>The unique identifiers.</value>
- </member>
- <member name="P:MailKit.Search.SearchResults.Count">
- <summary>
- Get or set the number of messages that matched the search query.
- </summary>
- <remarks>
- Gets or sets the number of messages that matched the search query.
- </remarks>
- <value>The count.</value>
- </member>
- <member name="P:MailKit.Search.SearchResults.Min">
- <summary>
- Get or set the minimum unique identifier that matched the search query.
- </summary>
- <remarks>
- Gets or sets the minimum unique identifier that matched the search query.
- </remarks>
- <value>The minimum unique identifier.</value>
- </member>
- <member name="P:MailKit.Search.SearchResults.Max">
- <summary>
- Get or set the maximum unique identifier that matched the search query.
- </summary>
- <remarks>
- Gets or sets the maximum unique identifier that matched the search query.
- </remarks>
- <value>The maximum unique identifier.</value>
- </member>
- <member name="P:MailKit.Search.SearchResults.ModSeq">
- <summary>
- Gets or sets the mod-sequence identifier of the messages that matched the search query.
- </summary>
- <remarks>
- Gets or sets the mod-sequence identifier of the messages that matched the search query.
- </remarks>
- <value>The mod-sequence identifier.</value>
- </member>
- <member name="P:MailKit.Search.SearchResults.Relevancy">
- <summary>
- Gets or sets the relevancy scores of the messages that matched the search query.
- </summary>
- <remarks>
- Gets or sets the relevancy scores of the messages that matched the search query.
- </remarks>
- <value>The relevancy scores.</value>
- </member>
- <member name="T:MailKit.Search.SearchTerm">
- <summary>
- A search term.
- </summary>
- <remarks>
- The search term as used by <see cref="T:MailKit.Search.SearchQuery"/>.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SearchTerm.All">
- <summary>
- A search term that matches all messages.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.And">
- <summary>
- A search term that logically combines 2 or more other
- search expressions such that messages must match both
- expressions.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Annotation">
- <summary>
- A search term that matches messages that have the specified annotation.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Answered">
- <summary>
- A search term that matches answered messages.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.BccContains">
- <summary>
- A search term that matches messages that contain a specified
- string within the <c>Bcc</c> header.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.BodyContains">
- <summary>
- A search term that matches messages that contain a specified
- string within the body of the message.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.CcContains">
- <summary>
- A search term that matches messages that contain a specified
- string within the <c>Cc</c> header.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Deleted">
- <summary>
- A search term that matches deleted messages.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.DeliveredAfter">
- <summary>
- A search term that matches messages delivered after a specified date.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.DeliveredBefore">
- <summary>
- A search term that matches messages delivered before a specified date.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.DeliveredOn">
- <summary>
- A search term that matches messages delivered on a specified date.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Draft">
- <summary>
- A search term that matches draft messages.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Filter">
- <summary>
- A search term that makes use of a predefined filter.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Flagged">
- <summary>
- A search term that matches flagged messages.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.FromContains">
- <summary>
- A search term that matches messages that contain a specified
- string within the <c>From</c> header.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Fuzzy">
- <summary>
- A search term that modifies another search expression to allow
- fuzzy matching.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.HeaderContains">
- <summary>
- A search term that matches messages that contain a specified
- string within a particular header.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Keyword">
- <summary>
- A search term that matches messages that contain a specified
- keyword.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.LargerThan">
- <summary>
- A search term that matches messages that are larger than a
- specified number of bytes.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.MessageContains">
- <summary>
- A search term that matches messages that contain a specified
- string anywhere within the message.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.ModSeq">
- <summary>
- A search term that matches messages that have the specified
- modification sequence value.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.New">
- <summary>
- A search term that matches new messages.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Not">
- <summary>
- A search term that modifies another search expression such that
- messages must match the logical inverse of the expression.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.NotAnswered">
- <summary>
- A search term that matches messages that have not been answered.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.NotDeleted">
- <summary>
- A search term that matches messages that have not been deleted.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.NotDraft">
- <summary>
- A search term that matches messages that are not drafts.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.NotFlagged">
- <summary>
- A search term that matches messages that have not been flagged.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.NotKeyword">
- <summary>
- A search term that matches messages that do not contain a specified
- keyword.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.NotRecent">
- <summary>
- A search term that matches messages that are not recent.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.NotSeen">
- <summary>
- A search term that matches messages that have not been seen.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Older">
- <summary>
- A search term that matches messages that are older than a specified date.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Or">
- <summary>
- A search term that logically combines 2 or more other
- search expressions such that messages only need to match
- one of the expressions.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Recent">
- <summary>
- A search term that matches messages that are recent.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Seen">
- <summary>
- A search term that matches messages that have been seen.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.SentBefore">
- <summary>
- A search term that matches messages that were sent before a specified date.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.SentOn">
- <summary>
- A search term that matches messages that were sent on a specified date.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.SentSince">
- <summary>
- A search term that matches messages that were sent since a specified date.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.SmallerThan">
- <summary>
- A search term that matches messages that are smaller than a
- specified number of bytes.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.SubjectContains">
- <summary>
- A search term that matches messages that contain a specified
- string within the <c>Subject</c> header.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.ToContains">
- <summary>
- A search term that matches messages that contain a specified
- string within the <c>To</c> header.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Uid">
- <summary>
- A search term that matches messages included within a specified
- set of unique identifiers.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.Younger">
- <summary>
- A search term that matches messages that are younger than a specified date.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.GMailMessageId">
- <summary>
- A search term that matches messages with a specified GMail message identifier.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.GMailThreadId">
- <summary>
- A search term that matches messages with a specified GMail thread (conversation)
- identifier.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.GMailLabels">
- <summary>
- A search term that matches messages with the specified GMail labels.
- </summary>
- </member>
- <member name="F:MailKit.Search.SearchTerm.GMailRaw">
- <summary>
- A search term that uses the GMail search syntax.
- </summary>
- </member>
- <member name="T:MailKit.Search.SortOrder">
- <summary>
- An enumeration of sort orders.
- </summary>
- <remarks>
- An enumeration of sort orders.
- </remarks>
- </member>
- <member name="F:MailKit.Search.SortOrder.None">
- <summary>
- No sorting order.
- </summary>
- </member>
- <member name="F:MailKit.Search.SortOrder.Ascending">
- <summary>
- Sort in ascending order.
- </summary>
- </member>
- <member name="F:MailKit.Search.SortOrder.Descending">
- <summary>
- Sort in descending order.
- </summary>
- </member>
- <member name="T:MailKit.Search.TextSearchQuery">
- <summary>
- A text-based search query.
- </summary>
- <remarks>
- A text-based search query.
- </remarks>
- </member>
- <member name="M:MailKit.Search.TextSearchQuery.#ctor(MailKit.Search.SearchTerm,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.TextSearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new text-based search query.
- </remarks>
- <param name="term">The search term.</param>
- <param name="text">The text to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="text"/> is empty.
- </exception>
- </member>
- <member name="P:MailKit.Search.TextSearchQuery.Text">
- <summary>
- Gets the text to match against.
- </summary>
- <remarks>
- Gets the text to match against.
- </remarks>
- <value>The text.</value>
- </member>
- <member name="T:MailKit.Search.UidSearchQuery">
- <summary>
- A unique identifier-based search query.
- </summary>
- <remarks>
- A unique identifier-based search query.
- </remarks>
- </member>
- <member name="M:MailKit.Search.UidSearchQuery.#ctor(System.Collections.Generic.IList{MailKit.UniqueId})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.UidSearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new unique identifier-based search query.
- </remarks>
- <param name="uids">The unique identifiers to match against.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uids"/> is empty.
- </exception>
- </member>
- <member name="M:MailKit.Search.UidSearchQuery.#ctor(MailKit.UniqueId)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.UidSearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new unique identifier-based search query.
- </remarks>
- <param name="uid">The unique identifier to match against.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is an invalid unique identifier.
- </exception>
- </member>
- <member name="P:MailKit.Search.UidSearchQuery.Uids">
- <summary>
- Gets the unique identifiers to match against.
- </summary>
- <remarks>
- Gets the unique identifiers to match against.
- </remarks>
- <value>The unique identifiers.</value>
- </member>
- <member name="T:MailKit.Search.UnarySearchQuery">
- <summary>
- A unary search query such as a NOT expression.
- </summary>
- <remarks>
- A unary search query such as a NOT expression.
- </remarks>
- </member>
- <member name="M:MailKit.Search.UnarySearchQuery.#ctor(MailKit.Search.SearchTerm,MailKit.Search.SearchQuery)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Search.UnarySearchQuery"/> class.
- </summary>
- <remarks>
- Creates a new unary search query.
- </remarks>
- <param name="term">The search term.</param>
- <param name="operand">The operand.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="operand"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.Search.UnarySearchQuery.Operand">
- <summary>
- Gets the inner operand.
- </summary>
- <remarks>
- Gets the inner operand.
- </remarks>
- <value>The operand.</value>
- </member>
- <member name="T:MailKit.Security.Ntlm.NtlmFlags">
- <summary>
- The NTLM message header flags.
- </summary>
- <remarks>
- More details here: http://davenport.sourceforge.net/ntlm.html#theNtlmMessageHeaderLayout
- and at https://msdn.microsoft.com/en-us/library/cc236650.aspx
- </remarks>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateUnicode">
- <summary>
- Indicates that Unicode strings are supported for use in security buffer data.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateOem">
- <summary>
- Indicates that OEM strings are supported for use in security buffer data.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.RequestTarget">
- <summary>
- Requests that the server's authentication realm be included in the Type 2 message.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.R10">
- <summary>
- This flag's usage has not been identified.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateSign">
- <summary>
- Specifies that authenticated communication between the client and server should carry a digital signature (message integrity).
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateSeal">
- <summary>
- Specifies that authenticated communication between the client and server should be encrypted (message confidentiality).
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateDatagramStyle">
- <summary>
- Indicates that datagram authentication is being used.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateLanManagerKey">
- <summary>
- Indicates that the Lan Manager Session Key should be used for signing
- and sealing authenticated communications.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.R9">
- <summary>
- This flag is unused and MUST be zero. (r8)
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateNtlm">
- <summary>
- Indicates that NTLM authentication is being used.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.R8">
- <summary>
- This flag is unused and MUST be zero. (r8)
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateAnonymous">
- <summary>
- Sent by the client in the Type 3 message to indicate that an anonymous
- context has been established. This also affects the response fields.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateDomainSupplied">
- <summary>
- Sent by the client in the Type 1 message to indicate that the name of the
- domain in which the client workstation has membership is included in the
- message. This is used by the server to determine whether the client is
- eligible for local authentication.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateWorkstationSupplied">
- <summary>
- Sent by the client in the Type 1 message to indicate that the client
- workstation's name is included in the message. This is used by the server
- to determine whether the client is eligible for local authentication.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateLocalCall">
- <summary>
- Sent by the server to indicate that the server and client are on the same
- machine. Implies that the client may use the established local credentials
- for authentication instead of calculating a response to the challenge.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateAlwaysSign">
- <summary>
- Indicates that authenticated communication between the client and server
- should be signed with a "dummy" signature.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.TargetTypeDomain">
- <summary>
- Sent by the server in the Type 2 message to indicate that the target
- authentication realm is a domain.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.TargetTypeServer">
- <summary>
- Sent by the server in the Type 2 message to indicate that the target
- authentication realm is a server.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.TargetTypeShare">
- <summary>
- Sent by the server in the Type 2 message to indicate that the target
- authentication realm is a share. Presumably, this is for share-level
- authentication. Usage is unclear.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateNtlm2Key">
- <summary>
- Indicates that the NTLM2 signing and sealing scheme should be used for
- protecting authenticated communications. Note that this refers to a
- particular session security scheme, and is not related to the use of
- NTLMv2 authentication. This flag can, however, have an effect on the
- response calculations.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateIdentify">
- <summary>
- This flag's usage has not been identified.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.R5">
- <summary>
- This flag is unused and MUST be zero. (r5)
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.RequestNonNTSessionKey">
- <summary>
- Indicates that the LMOWF function should be used to generate a session key.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateTargetInfo">
- <summary>
- Sent by the server in the Type 2 message to indicate that it is including
- a Target Information block in the message. The Target Information block
- is used in the calculation of the NTLMv2 response.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.R4">
- <summary>
- This flag is unused and MUST be zero. (r4)
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateVersion">
- <summary>
- Indicates that the version field is present.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.R3">
- <summary>
- This flag is unused and MUST be zero. (r3)
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.R2">
- <summary>
- This flag is unused and MUST be zero. (r2)
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.R1">
- <summary>
- This flag is unused and MUST be zero. (r1)
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.Negotiate128">
- <summary>
- Indicates that 128-bit encryption is supported.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateKeyExchange">
- <summary>
- Indicates that the client will provide an encrypted master key in the
- "Session Key" field of the Type 3 message.
- </summary>
- </member>
- <member name="F:MailKit.Security.Ntlm.NtlmFlags.Negotiate56">
- <summary>
- Indicates that 56-bit encryption is supported.
- </summary>
- </member>
- <member name="T:MailKit.Security.AuthenticationException">
- <summary>
- The exception that is thrown when there is an authentication error.
- </summary>
- <remarks>
- The exception that is thrown when there is an authentication error.
- </remarks>
- </member>
- <member name="M:MailKit.Security.AuthenticationException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.AuthenticationException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Security.AuthenticationException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">An inner exception.</param>
- </member>
- <member name="M:MailKit.Security.AuthenticationException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.AuthenticationException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Security.AuthenticationException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Security.AuthenticationException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.AuthenticationException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Security.AuthenticationException"/>.
- </remarks>
- </member>
- <member name="T:MailKit.Security.SaslErrorCode">
- <summary>
- An enumeration of the possible error codes that may be reported by a <see cref="T:MailKit.Security.SaslException"/>.
- </summary>
- <remarks>
- An enumeration of the possible error codes that may be reported by a <see cref="T:MailKit.Security.SaslException"/>.
- </remarks>
- </member>
- <member name="F:MailKit.Security.SaslErrorCode.ChallengeTooLong">
- <summary>
- The server's challenge was too long.
- </summary>
- </member>
- <member name="F:MailKit.Security.SaslErrorCode.IncompleteChallenge">
- <summary>
- The server's response contained an incomplete challenge.
- </summary>
- </member>
- <member name="F:MailKit.Security.SaslErrorCode.InvalidChallenge">
- <summary>
- The server's challenge was invalid.
- </summary>
- </member>
- <member name="F:MailKit.Security.SaslErrorCode.MissingChallenge">
- <summary>
- The server's response did not contain a challenge.
- </summary>
- </member>
- <member name="F:MailKit.Security.SaslErrorCode.IncorrectHash">
- <summary>
- The server's challenge contained an incorrect hash.
- </summary>
- </member>
- <member name="T:MailKit.Security.SaslException">
- <summary>
- A SASL authentication exception.
- </summary>
- <remarks>
- Typically indicates an error while parsing a server's challenge token.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslException.#ctor(System.String,MailKit.Security.SaslErrorCode,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Security.SaslException"/>.
- </remarks>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="code">The error code.</param>
- <param name="message">The error message.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslException.ErrorCode">
- <summary>
- Gets the error code.
- </summary>
- <remarks>
- Gets the error code.
- </remarks>
- <value>The error code.</value>
- </member>
- <member name="P:MailKit.Security.SaslException.Mechanism">
- <summary>
- Gets the name of the SASL mechanism that had the error.
- </summary>
- <remarks>
- Gets the name of the SASL mechanism that had the error.
- </remarks>
- <value>The name of the SASL mechanism.</value>
- </member>
- <member name="T:MailKit.Security.SaslMechanism">
- <summary>
- A SASL authentication mechanism.
- </summary>
- <remarks>
- Authenticating via a SASL mechanism may be a multi-step process.
- To determine if the mechanism has completed the necessary steps
- to authentication, check the <see cref="P:MailKit.Security.SaslMechanism.IsAuthenticated"/> after
- each call to <see cref="M:MailKit.Security.SaslMechanism.Challenge(System.String)"/>.
- </remarks>
- </member>
- <member name="F:MailKit.Security.SaslMechanism.AuthMechanismRank">
- <summary>
- The supported authentication mechanisms in order of strongest to weakest.
- </summary>
- <remarks>
- Used by the various clients when authenticating via SASL to determine
- which order the SASL mechanisms supported by the server should be tried.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanism"/> class.
- </summary>
- <remarks>
- Creates a new SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanism"/> class.
- </summary>
- <remarks>
- Creates a new SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanism"/> class.
- </summary>
- <remarks>
- Creates a new SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanism"/> class.
- </summary>
- <remarks>
- Creates a new SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanism.MechanismName">
- <summary>
- Gets the name of the mechanism.
- </summary>
- <remarks>
- Gets the name of the mechanism.
- </remarks>
- <value>The name of the mechanism.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanism.Credentials">
- <summary>
- Gets the user's credentials.
- </summary>
- <remarks>
- Gets the user's credentials.
- </remarks>
- <value>The user's credentials.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanism.SupportsInitialResponse">
- <summary>
- Gets whether or not the mechanism supports an initial response (SASL-IR).
- </summary>
- <remarks>
- SASL mechanisms that support sending an initial client response to the server
- should return <value>true</value>.
- </remarks>
- <value><c>true</c> if the mechanism supports an initial response; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanism.IsAuthenticated">
- <summary>
- Gets or sets whether the SASL mechanism has finished authenticating.
- </summary>
- <remarks>
- Gets or sets whether the SASL mechanism has finished authenticating.
- </remarks>
- <value><c>true</c> if the SASL mechanism has finished authenticating; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanism.NegotiatedSecurityLayer">
- <summary>
- Gets whether or not a security layer was negotiated.
- </summary>
- <remarks>
- <para>Gets whether or not a security layer has been negotiated by the SASL mechanism.</para>
- <note type="note">Some SASL mechanisms, such as GSSAPI, are able to negotiate security layers
- such as integrity and confidentiality protection.</note>
- </remarks>
- <value><c>true</c> if a security layer was negotiated; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanism.Uri">
- <summary>
- Gets or sets the URI of the service.
- </summary>
- <remarks>
- Gets or sets the URI of the service.
- </remarks>
- <value>The URI of the service.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.Challenge(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Parses the server's challenge token and returns the next challenge response.
- </summary>
- <remarks>
- Parses the server's challenge token and returns the next challenge response.
- </remarks>
- <returns>The next challenge response.</returns>
- <param name="token">The server's challenge token.</param>
- <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
- <param name="length">The length of the server's challenge.</param>
- <exception cref="T:System.InvalidOperationException">
- The SASL mechanism is already authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- THe SASL mechanism does not support SASL-IR.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- An error has occurred while parsing the server's challenge token.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.Challenge(System.String)">
- <summary>
- Decodes the base64-encoded server challenge and returns the next challenge response encoded in base64.
- </summary>
- <remarks>
- Decodes the base64-encoded server challenge and returns the next challenge response encoded in base64.
- </remarks>
- <returns>The next base64-encoded challenge response.</returns>
- <param name="token">The server's base64-encoded challenge token.</param>
- <exception cref="T:System.InvalidOperationException">
- The SASL mechanism is already authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- THe SASL mechanism does not support SASL-IR.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- An error has occurred while parsing the server's challenge token.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.Reset">
- <summary>
- Resets the state of the SASL mechanism.
- </summary>
- <remarks>
- Resets the state of the SASL mechanism.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.IsSupported(System.String)">
- <summary>
- Determines if the specified SASL mechanism is supported by MailKit.
- </summary>
- <remarks>
- Use this method to make sure that a SASL mechanism is supported before calling
- <see cref="M:MailKit.Security.SaslMechanism.Create(System.String,System.Uri,System.Net.ICredentials)"/>.
- </remarks>
- <returns><c>true</c> if the specified SASL mechanism is supported; otherwise, <c>false</c>.</returns>
- <param name="mechanism">The name of the SASL mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.Create(System.String,System.Uri,System.Text.Encoding,System.Net.ICredentials)">
- <summary>
- Create an instance of the specified SASL mechanism using the uri and credentials.
- </summary>
- <remarks>
- If unsure that a particular SASL mechanism is supported, you should first call
- <see cref="M:MailKit.Security.SaslMechanism.IsSupported(System.String)"/>.
- </remarks>
- <returns>An instance of the requested SASL mechanism if supported; otherwise <c>null</c>.</returns>
- <param name="mechanism">The name of the SASL mechanism.</param>
- <param name="uri">The URI of the service to authenticate against.</param>
- <param name="encoding">The text encoding to use for the credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="mechanism"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.Create(System.String,System.Uri,System.Net.ICredentials)">
- <summary>
- Create an instance of the specified SASL mechanism using the uri and credentials.
- </summary>
- <remarks>
- If unsure that a particular SASL mechanism is supported, you should first call
- <see cref="M:MailKit.Security.SaslMechanism.IsSupported(System.String)"/>.
- </remarks>
- <returns>An instance of the requested SASL mechanism if supported; otherwise <c>null</c>.</returns>
- <param name="mechanism">The name of the SASL mechanism.</param>
- <param name="uri">The URI of the service to authenticate against.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="mechanism"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.IsNonAsciiSpace(System.Char)">
- <summary>
- Determines if the character is a non-ASCII space.
- </summary>
- <remarks>
- This list was obtained from http://tools.ietf.org/html/rfc3454#appendix-C.1.2
- </remarks>
- <returns><c>true</c> if the character is a non-ASCII space; otherwise, <c>false</c>.</returns>
- <param name="c">The character.</param>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.IsCommonlyMappedToNothing(System.Char)">
- <summary>
- Determines if the character is commonly mapped to nothing.
- </summary>
- <remarks>
- This list was obtained from http://tools.ietf.org/html/rfc3454#appendix-B.1
- </remarks>
- <returns><c>true</c> if the character is commonly mapped to nothing; otherwise, <c>false</c>.</returns>
- <param name="c">The character.</param>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.IsProhibited(System.String,System.Int32)">
- <summary>
- Determines if the character is prohibited.
- </summary>
- <remarks>
- This list was obtained from http://tools.ietf.org/html/rfc3454#appendix-C.3
- </remarks>
- <returns><c>true</c> if the character is prohibited; otherwise, <c>false</c>.</returns>
- <param name="s">The string.</param>
- <param name="index">The character index.</param>
- </member>
- <member name="M:MailKit.Security.SaslMechanism.SaslPrep(System.String)">
- <summary>
- Prepares the user name or password string.
- </summary>
- <remarks>
- Prepares a user name or password string according to the rules of rfc4013.
- </remarks>
- <returns>The prepared string.</returns>
- <param name="s">The string to prepare.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="s"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="s"/> contains prohibited characters.
- </exception>
- </member>
- <member name="T:MailKit.Security.SaslMechanismCramMd5">
- <summary>
- The CRAM-MD5 SASL mechanism.
- </summary>
- <remarks>
- A SASL mechanism based on HMAC-MD5.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanismCramMd5.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismCramMd5"/> class.
- </summary>
- <remarks>
- Creates a new CRAM-MD5 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismCramMd5.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismCramMd5"/> class.
- </summary>
- <remarks>
- Creates a new CRAM-MD5 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismCramMd5.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismCramMd5"/> class.
- </summary>
- <remarks>
- Creates a new CRAM-MD5 SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismCramMd5.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismCramMd5"/> class.
- </summary>
- <remarks>
- Creates a new CRAM-MD5 SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanismCramMd5.MechanismName">
- <summary>
- Gets the name of the mechanism.
- </summary>
- <remarks>
- Gets the name of the mechanism.
- </remarks>
- <value>The name of the mechanism.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanismCramMd5.Challenge(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Parses the server's challenge token and returns the next challenge response.
- </summary>
- <remarks>
- Parses the server's challenge token and returns the next challenge response.
- </remarks>
- <returns>The next challenge response.</returns>
- <param name="token">The server's challenge token.</param>
- <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
- <param name="length">The length of the server's challenge.</param>
- <exception cref="T:System.InvalidOperationException">
- The SASL mechanism is already authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The SASL mechanism does not support SASL-IR.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- An error has occurred while parsing the server's challenge token.
- </exception>
- </member>
- <member name="T:MailKit.Security.SaslMechanismDigestMd5">
- <summary>
- The DIGEST-MD5 SASL mechanism.
- </summary>
- <remarks>
- Unlike the PLAIN and LOGIN SASL mechanisms, the DIGEST-MD5 mechanism
- provides some level of protection and should be relatively safe to
- use even with a clear-text connection.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanismDigestMd5.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismDigestMd5"/> class.
- </summary>
- <remarks>
- Creates a new DIGEST-MD5 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismDigestMd5.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismDigestMd5"/> class.
- </summary>
- <remarks>
- Creates a new DIGEST-MD5 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismDigestMd5.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismDigestMd5"/> class.
- </summary>
- <remarks>
- Creates a new DIGEST-MD5 SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismDigestMd5.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismDigestMd5"/> class.
- </summary>
- <remarks>
- Creates a new DIGEST-MD5 SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanismDigestMd5.AuthorizationId">
- <summary>
- Gets or sets the authorization identifier.
- </summary>
- <remarks>
- The authorization identifier is the desired user account that the server should use
- for all accesses. This is separate from the user name used for authentication.
- </remarks>
- <value>The authorization identifier.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanismDigestMd5.MechanismName">
- <summary>
- Gets the name of the mechanism.
- </summary>
- <remarks>
- Gets the name of the mechanism.
- </remarks>
- <value>The name of the mechanism.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanismDigestMd5.Challenge(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Parses the server's challenge token and returns the next challenge response.
- </summary>
- <remarks>
- Parses the server's challenge token and returns the next challenge response.
- </remarks>
- <returns>The next challenge response.</returns>
- <param name="token">The server's challenge token.</param>
- <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
- <param name="length">The length of the server's challenge.</param>
- <exception cref="T:System.InvalidOperationException">
- The SASL mechanism is already authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- THe SASL mechanism does not support SASL-IR.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- An error has occurred while parsing the server's challenge token.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismDigestMd5.Reset">
- <summary>
- Resets the state of the SASL mechanism.
- </summary>
- <remarks>
- Resets the state of the SASL mechanism.
- </remarks>
- </member>
- <member name="T:MailKit.Security.SaslMechanismLogin">
- <summary>
- The LOGIN SASL mechanism.
- </summary>
- <remarks>
- The LOGIN SASL mechanism provides little protection over the use
- of plain-text passwords by obscuring the user name and password within
- individual base64-encoded blobs and should be avoided unless used in
- combination with an SSL or TLS connection.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Uri,System.Text.Encoding,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
- </summary>
- <remarks>
- Creates a new LOGIN SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Uri,System.Text.Encoding,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
- </summary>
- <remarks>
- Creates a new LOGIN SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
- </summary>
- <remarks>
- Creates a new LOGIN SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
- </summary>
- <remarks>
- Creates a new LOGIN SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Text.Encoding,System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
- </summary>
- <remarks>
- Creates a new LOGIN SASL context.
- </remarks>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Text.Encoding,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
- </summary>
- <remarks>
- Creates a new LOGIN SASL context.
- </remarks>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
- </summary>
- <remarks>
- Creates a new LOGIN SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
- </summary>
- <remarks>
- Creates a new LOGIN SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanismLogin.MechanismName">
- <summary>
- Gets the name of the mechanism.
- </summary>
- <remarks>
- Gets the name of the mechanism.
- </remarks>
- <value>The name of the mechanism.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanismLogin.SupportsInitialResponse">
- <summary>
- Gets whether or not the mechanism supports an initial response (SASL-IR).
- </summary>
- <remarks>
- SASL mechanisms that support sending an initial client response to the server
- should return <value>true</value>.
- </remarks>
- <value><c>true</c> if the mechanism supports an initial response; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.Challenge(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Parses the server's challenge token and returns the next challenge response.
- </summary>
- <remarks>
- Parses the server's challenge token and returns the next challenge response.
- </remarks>
- <returns>The next challenge response.</returns>
- <param name="token">The server's challenge token.</param>
- <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
- <param name="length">The length of the server's challenge.</param>
- <exception cref="T:System.InvalidOperationException">
- The SASL mechanism is already authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The SASL mechanism does not support SASL-IR.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- An error has occurred while parsing the server's challenge token.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismLogin.Reset">
- <summary>
- Resets the state of the SASL mechanism.
- </summary>
- <remarks>
- Resets the state of the SASL mechanism.
- </remarks>
- </member>
- <member name="T:MailKit.Security.SaslMechanismNtlm">
- <summary>
- The NTLM SASL mechanism.
- </summary>
- <remarks>
- A SASL mechanism based on NTLM.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanismNtlm.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismNtlm"/> class.
- </summary>
- <remarks>
- Creates a new NTLM SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismNtlm.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismNtlm"/> class.
- </summary>
- <remarks>
- Creates a new NTLM SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismNtlm.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismNtlm"/> class.
- </summary>
- <remarks>
- Creates a new NTLM SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismNtlm.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismNtlm"/> class.
- </summary>
- <remarks>
- Creates a new NTLM SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanismNtlm.MechanismName">
- <summary>
- Gets the name of the mechanism.
- </summary>
- <remarks>
- Gets the name of the mechanism.
- </remarks>
- <value>The name of the mechanism.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanismNtlm.SupportsInitialResponse">
- <summary>
- Gets whether or not the mechanism supports an initial response (SASL-IR).
- </summary>
- <remarks>
- SASL mechanisms that support sending an initial client response to the server
- should return <value>true</value>.
- </remarks>
- <value><c>true</c> if the mechanism supports an initial response; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanismNtlm.Workstation">
- <summary>
- Gets or sets the workstation name to use for authentication.
- </summary>
- <remarks>
- Gets or sets the workstation name to use for authentication.
- </remarks>
- <value>The workstation name.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanismNtlm.Challenge(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Parses the server's challenge token and returns the next challenge response.
- </summary>
- <remarks>
- Parses the server's challenge token and returns the next challenge response.
- </remarks>
- <returns>The next challenge response.</returns>
- <param name="token">The server's challenge token.</param>
- <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
- <param name="length">The length of the server's challenge.</param>
- <exception cref="T:System.InvalidOperationException">
- The SASL mechanism is already authenticated.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- An error has occurred while parsing the server's challenge token.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismNtlm.Reset">
- <summary>
- Resets the state of the SASL mechanism.
- </summary>
- <remarks>
- Resets the state of the SASL mechanism.
- </remarks>
- </member>
- <member name="T:MailKit.Security.SaslMechanismOAuth2">
- <summary>
- The OAuth2 SASL mechanism.
- </summary>
- <remarks>
- A SASL mechanism used by Google that makes use of a short-lived
- OAuth 2.0 access token.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanismOAuth2.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismOAuth2"/> class.
- </summary>
- <remarks>
- Creates a new XOAUTH2 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismOAuth2.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismOAuth2"/> class.
- </summary>
- <remarks>
- Creates a new XOAUTH2 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="auth_token">The auth token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="auth_token"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismOAuth2.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismOAuth2"/> class.
- </summary>
- <remarks>
- Creates a new XOAUTH2 SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismOAuth2.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismOAuth2"/> class.
- </summary>
- <remarks>
- Creates a new XOAUTH2 SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="auth_token">The auth token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="auth_token"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanismOAuth2.MechanismName">
- <summary>
- Gets the name of the mechanism.
- </summary>
- <remarks>
- Gets the name of the mechanism.
- </remarks>
- <value>The name of the mechanism.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanismOAuth2.SupportsInitialResponse">
- <summary>
- Gets whether or not the mechanism supports an initial response (SASL-IR).
- </summary>
- <remarks>
- SASL mechanisms that support sending an initial client response to the server
- should return <value>true</value>.
- </remarks>
- <value><c>true</c> if the mechanism supports an initial response; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanismOAuth2.Challenge(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Parses the server's challenge token and returns the next challenge response.
- </summary>
- <remarks>
- Parses the server's challenge token and returns the next challenge response.
- </remarks>
- <returns>The next challenge response.</returns>
- <param name="token">The server's challenge token.</param>
- <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
- <param name="length">The length of the server's challenge.</param>
- <exception cref="T:System.InvalidOperationException">
- The SASL mechanism is already authenticated.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- An error has occurred while parsing the server's challenge token.
- </exception>
- </member>
- <member name="T:MailKit.Security.SaslMechanismPlain">
- <summary>
- The PLAIN SASL mechanism.
- </summary>
- <remarks>
- The PLAIN SASL mechanism provides little protection over the use
- of plain-text passwords by combining the user name and password and
- obscuring them within a base64-encoded blob and should be avoided
- unless used in combination with an SSL or TLS connection.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Uri,System.Text.Encoding,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
- </summary>
- <remarks>
- Creates a new PLAIN SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Uri,System.Text.Encoding,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
- </summary>
- <remarks>
- Creates a new PLAIN SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
- </summary>
- <remarks>
- Creates a new PLAIN SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
- </summary>
- <remarks>
- Creates a new PLAIN SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Text.Encoding,System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
- </summary>
- <remarks>
- Creates a new PLAIN SASL context.
- </remarks>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Text.Encoding,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
- </summary>
- <remarks>
- Creates a new PLAIN SASL context.
- </remarks>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
- </summary>
- <remarks>
- Creates a new PLAIN SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
- </summary>
- <remarks>
- Creates a new PLAIN SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanismPlain.AuthorizationId">
- <summary>
- Gets or sets the authorization identifier.
- </summary>
- <remarks>
- The authorization identifier is the desired user account that the server should use
- for all accesses. This is separate from the user name used for authentication.
- </remarks>
- <value>The authorization identifier.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanismPlain.MechanismName">
- <summary>
- Gets the name of the mechanism.
- </summary>
- <remarks>
- Gets the name of the mechanism.
- </remarks>
- <value>The name of the mechanism.</value>
- </member>
- <member name="P:MailKit.Security.SaslMechanismPlain.SupportsInitialResponse">
- <summary>
- Gets whether or not the mechanism supports an initial response (SASL-IR).
- </summary>
- <remarks>
- SASL mechanisms that support sending an initial client response to the server
- should return <value>true</value>.
- </remarks>
- <value><c>true</c> if the mechanism supports an initial response; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanismPlain.Challenge(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Parses the server's challenge token and returns the next challenge response.
- </summary>
- <remarks>
- Parses the server's challenge token and returns the next challenge response.
- </remarks>
- <returns>The next challenge response.</returns>
- <param name="token">The server's challenge token.</param>
- <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
- <param name="length">The length of the server's challenge.</param>
- <exception cref="T:System.InvalidOperationException">
- The SASL mechanism is already authenticated.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- An error has occurred while parsing the server's challenge token.
- </exception>
- </member>
- <member name="T:MailKit.Security.SaslMechanismScramBase">
- <summary>
- The base class for SCRAM-based SASL mechanisms.
- </summary>
- <remarks>
- SCRAM-based SASL mechanisms are salted challenge/response authentication mechanisms.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramBase"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-based SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramBase"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-based SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramBase"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-based SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramBase"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-based SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanismScramBase.SupportsInitialResponse">
- <summary>
- Gets whether or not the mechanism supports an initial response (SASL-IR).
- </summary>
- <remarks>
- SASL mechanisms that support sending an initial client response to the server
- should return <value>true</value>.
- </remarks>
- <value><c>true</c> if the mechanism supports an initial response; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.CreateHMAC(System.Byte[])">
- <summary>
- Create the HMAC context.
- </summary>
- <remarks>
- Creates the HMAC context using the secret key.
- </remarks>
- <returns>The HMAC context.</returns>
- <param name="key">The secret key.</param>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.HMAC(System.Byte[],System.Byte[])">
- <summary>
- Apply the HMAC keyed algorithm.
- </summary>
- <remarks>
- HMAC(key, str): Apply the HMAC keyed hash algorithm (defined in
- [RFC2104]) using the octet string represented by "key" as the key
- and the octet string "str" as the input string. The size of the
- result is the hash result size for the hash function in use. For
- example, it is 20 octets for SHA-1 (see [RFC3174]).
- </remarks>
- <returns>The results of the HMAC keyed algorithm.</returns>
- <param name="key">The key.</param>
- <param name="str">The string.</param>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.Hash(System.Byte[])">
- <summary>
- Apply the cryptographic hash function.
- </summary>
- <remarks>
- H(str): Apply the cryptographic hash function to the octet string
- "str", producing an octet string as a result. The size of the
- result depends on the hash result size for the hash function in
- use.
- </remarks>
- <returns>The results of the hash.</returns>
- <param name="str">The string.</param>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.Xor(System.Byte[],System.Byte[])">
- <summary>
- Apply the exclusive-or operation to combine two octet strings.
- </summary>
- <remarks>
- Apply the exclusive-or operation to combine the octet string
- on the left of this operator with the octet string on the right of
- this operator. The length of the output and each of the two
- inputs will be the same for this use.
- </remarks>
- <param name="a">The alpha component.</param>
- <param name="b">The blue component.</param>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.Challenge(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Parses the server's challenge token and returns the next challenge response.
- </summary>
- <remarks>
- Parses the server's challenge token and returns the next challenge response.
- </remarks>
- <returns>The next challenge response.</returns>
- <param name="token">The server's challenge token.</param>
- <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
- <param name="length">The length of the server's challenge.</param>
- <exception cref="T:System.InvalidOperationException">
- The SASL mechanism is already authenticated.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- An error has occurred while parsing the server's challenge token.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramBase.Reset">
- <summary>
- Resets the state of the SASL mechanism.
- </summary>
- <remarks>
- Resets the state of the SASL mechanism.
- </remarks>
- </member>
- <member name="T:MailKit.Security.SaslMechanismScramSha1">
- <summary>
- The SCRAM-SHA-1 SASL mechanism.
- </summary>
- <remarks>
- A salted challenge/response SASL mechanism that uses the HMAC SHA-1 algorithm.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha1.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha1"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-SHA-1 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha1.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha1"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-SHA-1 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha1.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha1"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-SHA-1 SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha1.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha1"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-SHA-1 SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanismScramSha1.MechanismName">
- <summary>
- Gets the name of the mechanism.
- </summary>
- <remarks>
- Gets the name of the mechanism.
- </remarks>
- <value>The name of the mechanism.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha1.CreateHMAC(System.Byte[])">
- <summary>
- Create the HMAC context.
- </summary>
- <remarks>
- Creates the HMAC context using the secret key.
- </remarks>
- <returns>The HMAC context.</returns>
- <param name="key">The secret key.</param>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha1.Hash(System.Byte[])">
- <summary>
- Apply the cryptographic hash function.
- </summary>
- <remarks>
- H(str): Apply the cryptographic hash function to the octet string
- "str", producing an octet string as a result. The size of the
- result depends on the hash result size for the hash function in
- use.
- </remarks>
- <returns>The results of the hash.</returns>
- <param name="str">The string.</param>
- </member>
- <member name="T:MailKit.Security.SaslMechanismScramSha256">
- <summary>
- The SCRAM-SHA-256 SASL mechanism.
- </summary>
- <remarks>
- A salted challenge/response SASL mechanism that uses the HMAC SHA-256 algorithm.
- </remarks>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha256.#ctor(System.Uri,System.Net.ICredentials)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha256"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-SHA-256 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha256.#ctor(System.Uri,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha256"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-SHA-256 SASL context.
- </remarks>
- <param name="uri">The URI of the service.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uri"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha256.#ctor(System.Net.NetworkCredential)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha256"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-SHA-256 SASL context.
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha256.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha256"/> class.
- </summary>
- <remarks>
- Creates a new SCRAM-SHA-256 SASL context.
- </remarks>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.Security.SaslMechanismScramSha256.MechanismName">
- <summary>
- Gets the name of the mechanism.
- </summary>
- <remarks>
- Gets the name of the mechanism.
- </remarks>
- <value>The name of the mechanism.</value>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha256.CreateHMAC(System.Byte[])">
- <summary>
- Create the HMAC context.
- </summary>
- <remarks>
- Creates the HMAC context using the secret key.
- </remarks>
- <returns>The HMAC context.</returns>
- <param name="key">The secret key.</param>
- </member>
- <member name="M:MailKit.Security.SaslMechanismScramSha256.Hash(System.Byte[])">
- <summary>
- Apply the cryptographic hash function.
- </summary>
- <remarks>
- H(str): Apply the cryptographic hash function to the octet string
- "str", producing an octet string as a result. The size of the
- result depends on the hash result size for the hash function in
- use.
- </remarks>
- <returns>The results of the hash.</returns>
- <param name="str">The string.</param>
- </member>
- <member name="T:MailKit.Security.SecureSocketOptions">
- <summary>
- Secure socket options.
- </summary>
- <remarks>
- Provides a way of specifying the SSL and/or TLS encryption that
- should be used for a connection.
- </remarks>
- </member>
- <member name="F:MailKit.Security.SecureSocketOptions.None">
- <summary>
- No SSL or TLS encryption should be used.
- </summary>
- </member>
- <member name="F:MailKit.Security.SecureSocketOptions.Auto">
- <summary>
- Allow the <see cref="T:MailKit.IMailService"/> to decide which SSL or TLS
- options to use (default). If the server does not support SSL or TLS,
- then the connection will continue without any encryption.
- </summary>
- </member>
- <member name="F:MailKit.Security.SecureSocketOptions.SslOnConnect">
- <summary>
- The connection should use SSL or TLS encryption immediately.
- </summary>
- </member>
- <member name="F:MailKit.Security.SecureSocketOptions.StartTls">
- <summary>
- Elevates the connection to use TLS encryption immediately after
- reading the greeting and capabilities of the server. If the server
- does not support the STARTTLS extension, then the connection will
- fail and a <see cref="T:System.NotSupportedException"/> will be thrown.
- </summary>
- </member>
- <member name="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable">
- <summary>
- Elevates the connection to use TLS encryption immediately after
- reading the greeting and capabilities of the server, but only if
- the server supports the STARTTLS extension.
- </summary>
- </member>
- <member name="T:MailKit.Security.SslHandshakeException">
- <summary>
- The exception that is thrown when there is an error during the SSL/TLS handshake.
- </summary>
- <remarks>
- <para>The exception that is thrown when there is an error during the SSL/TLS handshake.</para>
- <para>When this exception occurrs, it typically means that the IMAP, POP3 or SMTP server that
- you are connecting to is using an SSL certificate that is either expired or untrusted by
- your system.</para>
- <para>Often times, mail servers will use self-signed certificates instead of using a certificate
- that has been signed by a trusted Certificate Authority. When your system is unable to validate
- the mail server's certificate because it is not signed by a known and trusted Certificate Authority,
- this exception will occur.</para>
- <para>You can work around this problem by supplying a custom <see cref="T:System.Net.Security.RemoteCertificateValidationCallback"/>
- and setting it on the client's <see cref="P:MailKit.MailService.ServerCertificateValidationCallback"/> property.</para>
- <para>Most likely, you'll want to compare the thumbprint of the server's certificate with a known
- value and/or prompt the user to accept the certificate (similar to what you've probably seen web
- browsers do when they encounter untrusted certificates).</para>
- </remarks>
- </member>
- <member name="M:MailKit.Security.SslHandshakeException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SslHandshakeException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Security.SslHandshakeException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">An inner exception.</param>
- </member>
- <member name="M:MailKit.Security.SslHandshakeException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SslHandshakeException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Security.SslHandshakeException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.Security.SslHandshakeException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Security.SslHandshakeException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Security.SslHandshakeException"/>.
- </remarks>
- </member>
- <member name="P:MailKit.Security.SslHandshakeException.ServerCertificate">
- <summary>
- Get the server's SSL certificate.
- </summary>
- <remarks>
- Gets the server's SSL certificate, if it is available.
- </remarks>
- <value>The server's SSL certificate.</value>
- </member>
- <member name="P:MailKit.Security.SslHandshakeException.RootCertificateAuthority">
- <summary>
- Get the certificate for the Root Certificate Authority.
- </summary>
- <remarks>
- Gets the certificate for the Root Certificate Authority, if it is available.
- </remarks>
- <value>The Root Certificate Authority certificate.</value>
- </member>
- <member name="T:MailKit.AccessControl">
- <summary>
- An Access Control.
- </summary>
- <remarks>
- An Access Control is a set of permissions available for a particular identity,
- controlling whether or not that identity has the ability to perform various tasks.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- </member>
- <member name="M:MailKit.AccessControl.#ctor(System.String,System.Collections.Generic.IEnumerable{MailKit.AccessRight})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AccessControl"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AccessControl"/> with the given name and
- access rights.
- </remarks>
- <param name="name">The identifier name.</param>
- <param name="rights">The access rights.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.AccessControl.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AccessControl"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AccessControl"/> with the given name and
- access rights.
- </remarks>
- <param name="name">The identifier name.</param>
- <param name="rights">The access rights.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="M:MailKit.AccessControl.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AccessControl"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AccessControl"/> with the given name and no
- access rights.
- </remarks>
- <param name="name">The identifier name.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.AccessControl.Name">
- <summary>
- The identifier name for the access control.
- </summary>
- <remarks>
- The identifier name for the access control.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The identifier name.</value>
- </member>
- <member name="P:MailKit.AccessControl.Rights">
- <summary>
- Get the access rights.
- </summary>
- <remarks>
- Gets the access rights.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The access rights.</value>
- </member>
- <member name="T:MailKit.AccessControlList">
- <summary>
- An Access Control List (ACL)
- </summary>
- <remarks>
- An Access Control List (ACL) is a list of access controls defining the permissions
- various identities have available.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- </member>
- <member name="M:MailKit.AccessControlList.#ctor(System.Collections.Generic.IEnumerable{MailKit.AccessControl})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AccessControlList"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AccessControlList"/>.
- </remarks>
- <param name="controls">The list of access controls.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="controls"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.AccessControlList.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AccessControlList"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AccessControlList"/>.
- </remarks>
- </member>
- <member name="T:MailKit.AccessRight">
- <summary>
- An individual Access Right to be used with ACLs.
- </summary>
- <remarks>
- <para>An individual Access Right meant to be used with
- <see cref="T:MailKit.AccessControlList"/>.</para>
- <para>For more information on what rights are available,
- see https://tools.ietf.org/html/rfc4314#section-2.1
- </para>
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.LookupFolder">
- <summary>
- The access right for folder lookups.
- </summary>
- <remarks>
- Allows the <see cref="T:MailKit.IMailFolder"/> to be visible when listing folders.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.OpenFolder">
- <summary>
- The access right for opening a folder and getting the status.
- </summary>
- <remarks>
- Provides access for opening and getting the status of the folder.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.SetMessageSeen">
- <summary>
- The access right for adding or removing the Seen flag on messages in the folder.
- </summary>
- <remarks>
- Provides access to add or remove the <see cref="F:MailKit.MessageFlags.Seen"/> flag on messages within the
- <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.SetMessageFlags">
- <summary>
- The access right for adding or removing flags (other than Seen and Deleted)
- on messages in a folder.
- </summary>
- <remarks>
- Provides access to add or remove the <see cref="T:MailKit.MessageFlags"/> on messages
- (other than <see cref="F:MailKit.MessageFlags.Seen"/> and
- <see cref="F:MailKit.MessageFlags.Deleted"/>) within the folder.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.AppendMessages">
- <summary>
- The access right allowing messages to be appended or copied into the folder.
- </summary>
- <remarks>
- Provides access to append or copy messages into the folder.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.CreateFolder">
- <summary>
- The access right allowing subfolders to be created.
- </summary>
- <remarks>
- Provides access to create subfolders.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.DeleteFolder">
- <summary>
- The access right for deleting a folder and/or its subfolders.
- </summary>
- <remarks>
- Provides access to delete the folder and/or any subfolders.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.SetMessageDeleted">
- <summary>
- The access right for adding or removing the Deleted flag to messages within a folder.
- </summary>
- <remarks>
- Provides access to add or remove the <see cref="F:MailKit.MessageFlags.Deleted"/> flag from
- messages within the folder. It also provides access for setting the
- <see cref="F:MailKit.MessageFlags.Deleted"/> flag when appending a message to a folder.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.ExpungeFolder">
- <summary>
- The access right for expunging deleted messages in a folder.
- </summary>
- <remarks>
- Provides access to expunge deleted messages in a folder.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.Administer">
- <summary>
- The access right for administering the ACLs of a folder.
- </summary>
- <remarks>
- Provides administrative access to change the ACLs for the folder.
- </remarks>
- </member>
- <member name="F:MailKit.AccessRight.Right">
- <summary>
- The character representing the particular access right.
- </summary>
- <remarks>
- Represents the character value of the access right.
- </remarks>
- </member>
- <member name="M:MailKit.AccessRight.#ctor(System.Char)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AccessRight"/> struct.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AccessRight"/> struct.
- </remarks>
- <param name="right">The access right.</param>
- </member>
- <member name="M:MailKit.AccessRight.Equals(MailKit.AccessRight)">
- <summary>
- Determines whether the specified <see cref="T:MailKit.AccessRight"/> is equal to the current <see cref="T:MailKit.AccessRight"/>.
- </summary>
- <remarks>
- Determines whether the specified <see cref="T:MailKit.AccessRight"/> is equal to the current <see cref="T:MailKit.AccessRight"/>.
- </remarks>
- <param name="other">The <see cref="T:MailKit.AccessRight"/> to compare with the current <see cref="T:MailKit.AccessRight"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:MailKit.AccessRight"/> is equal to the current
- <see cref="T:MailKit.AccessRight"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:MailKit.AccessRight.op_Equality(MailKit.AccessRight,MailKit.AccessRight)">
- <summary>
- Determines whether two access rights are equal.
- </summary>
- <remarks>
- Determines whether two access rights are equal.
- </remarks>
- <returns><c>true</c> if <paramref name="right1"/> and <paramref name="right2"/> are equal; otherwise, <c>false</c>.</returns>
- <param name="right1">The first access right to compare.</param>
- <param name="right2">The second access right to compare.</param>
- </member>
- <member name="M:MailKit.AccessRight.op_Inequality(MailKit.AccessRight,MailKit.AccessRight)">
- <summary>
- Determines whether two access rights are not equal.
- </summary>
- <remarks>
- Determines whether two access rights are not equal.
- </remarks>
- <returns><c>true</c> if <paramref name="right1"/> and <paramref name="right2"/> are not equal; otherwise, <c>false</c>.</returns>
- <param name="right1">The first access right to compare.</param>
- <param name="right2">The second access right to compare.</param>
- </member>
- <member name="M:MailKit.AccessRight.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AccessRight"/>.
- </summary>
- <remarks>
- Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AccessRight"/>.
- </remarks>
- <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:MailKit.AccessRight"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AccessRight"/>;
- otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:MailKit.AccessRight.GetHashCode">
- <summary>
- Serves as a hash function for a <see cref="T:MailKit.AccessRight"/> object.
- </summary>
- <remarks>
- Serves as a hash function for a <see cref="T:MailKit.AccessRight"/> object.
- </remarks>
- <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.</returns>
- </member>
- <member name="M:MailKit.AccessRight.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AccessRight"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AccessRight"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AccessRight"/>.</returns>
- </member>
- <member name="T:MailKit.AccessRights">
- <summary>
- A set of access rights.
- </summary>
- <remarks>
- The set of access rights for a particular identity.
- </remarks>
- </member>
- <member name="M:MailKit.AccessRights.#ctor(System.Collections.Generic.IEnumerable{MailKit.AccessRight})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AccessRights"/> class.
- </summary>
- <remarks>
- Creates a new set of access rights.
- </remarks>
- <param name="rights">The access rights.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="rights"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.AccessRights.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AccessRights"/> class.
- </summary>
- <remarks>
- Creates a new set of access rights.
- </remarks>
- <param name="rights">The access rights.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="rights"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.AccessRights.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AccessRights"/> class.
- </summary>
- <remarks>
- Creates an empty set of access rights.
- </remarks>
- </member>
- <member name="P:MailKit.AccessRights.Count">
- <summary>
- Get the number of access rights in the collection.
- </summary>
- <remarks>
- Gets the number of access rights in the collection.
- </remarks>
- <value>The count.</value>
- </member>
- <member name="P:MailKit.AccessRights.IsReadOnly">
- <summary>
- Get whether or not this set of access rights is read only.
- </summary>
- <remarks>
- Gets whether or not this set of access rights is read only.
- </remarks>
- <value><c>true</c> if this collection is read only; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.AccessRights.System#Collections#Generic#ICollection{MailKit#AccessRight}#Add(MailKit.AccessRight)">
- <summary>
- Add the specified access right.
- </summary>
- <remarks>
- Adds the specified access right if it is not already included.
- </remarks>
- <param name="right">The access right.</param>
- </member>
- <member name="M:MailKit.AccessRights.Add(MailKit.AccessRight)">
- <summary>
- Add the specified access right.
- </summary>
- <remarks>
- Adds the specified access right if it is not already included.
- </remarks>
- <returns><c>true</c> if the right was added; otherwise, <c>false</c>.</returns>
- <param name="right">The access right.</param>
- </member>
- <member name="M:MailKit.AccessRights.Add(System.Char)">
- <summary>
- Add the specified right.
- </summary>
- <remarks>
- Adds the right specified by the given character.
- </remarks>
- <returns><c>true</c> if the right was added; otherwise, <c>false</c>.</returns>
- <param name="right">The right.</param>
- </member>
- <member name="M:MailKit.AccessRights.AddRange(System.String)">
- <summary>
- Add the rights specified by the characters in the given string.
- </summary>
- <remarks>
- Adds the rights specified by the characters in the given string.
- </remarks>
- <param name="rights">The rights.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="rights"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.AccessRights.AddRange(System.Collections.Generic.IEnumerable{MailKit.AccessRight})">
- <summary>
- Add the range of specified rights.
- </summary>
- <remarks>
- Adds the range of specified rights.
- </remarks>
- <param name="rights">The rights.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="rights"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.AccessRights.Clear">
- <summary>
- Clears the access rights.
- </summary>
- <remarks>
- Removes all of the access rights.
- </remarks>
- </member>
- <member name="M:MailKit.AccessRights.Contains(MailKit.AccessRight)">
- <summary>
- Checks if the set of access rights contains the specified right.
- </summary>
- <remarks>
- Determines whether or not the set of access rights already contains the specified right
- </remarks>
- <returns><value>true</value> if the specified right exists; otherwise <value>false</value>.</returns>
- <param name="right">The access right.</param>
- </member>
- <member name="M:MailKit.AccessRights.CopyTo(MailKit.AccessRight[],System.Int32)">
- <summary>
- Copies all of the access rights to the specified array.
- </summary>
- <remarks>
- Copies all of the access rights into the array,
- starting at the specified array index.
- </remarks>
- <param name="array">The array.</param>
- <param name="arrayIndex">The array index.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="array"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="arrayIndex"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.AccessRights.Remove(MailKit.AccessRight)">
- <summary>
- Removes the specified access right.
- </summary>
- <remarks>
- Removes the specified access right.
- </remarks>
- <returns><value>true</value> if the access right was removed; otherwise <value>false</value>.</returns>
- <param name="right">The access right.</param>
- </member>
- <member name="P:MailKit.AccessRights.Item(System.Int32)">
- <summary>
- Get the access right at the specified index.
- </summary>
- <remarks>
- Gets the access right at the specified index.
- </remarks>
- <value>The access right at the specified index.</value>
- <param name="index">The index.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.AccessRights.GetEnumerator">
- <summary>
- Get the access rights enumerator.
- </summary>
- <remarks>
- Gets the access rights enumerator.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.AccessRights.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Get the access rights enumerator.
- </summary>
- <remarks>
- Gets the access rights enumerator.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.AccessRights.ToString">
- <summary>
- Return a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AccessRights"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AccessRights"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AccessRights"/>.</returns>
- </member>
- <member name="T:MailKit.AlertEventArgs">
- <summary>
- Alert event arguments.
- </summary>
- <remarks>
- Some <see cref="T:MailKit.IMailStore"/> implementations, such as
- <see cref="T:MailKit.Net.Imap.ImapClient"/>, will emit Alert
- events when they receive alert messages from the server.
- </remarks>
- </member>
- <member name="M:MailKit.AlertEventArgs.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AlertEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AlertEventArgs"/>.
- </remarks>
- <param name="message">The alert message.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.AlertEventArgs.Message">
- <summary>
- Gets the alert message.
- </summary>
- <remarks>
- The alert message will be the exact message received from the server.
- </remarks>
- <value>The alert message.</value>
- </member>
- <member name="T:MailKit.Annotation">
- <summary>
- An annotation.
- </summary>
- <remarks>
- <para>An annotation.</para>
- <para>For more information about annotations, see
- <a href="https://tools.ietf.org/html/rfc5257">rfc5257</a>.</para>
- </remarks>
- </member>
- <member name="M:MailKit.Annotation.#ctor(MailKit.AnnotationEntry)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Annotation"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Annotation"/>.
- </remarks>
- <param name="entry">The annotation entry.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="entry"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.Annotation.Entry">
- <summary>
- Get the annotation tag.
- </summary>
- <remarks>
- Gets the annotation tag.
- </remarks>
- <value>The annotation tag.</value>
- </member>
- <member name="P:MailKit.Annotation.Properties">
- <summary>
- Get the annotation properties.
- </summary>
- <remarks>
- Gets the annotation properties.
- </remarks>
- </member>
- <member name="T:MailKit.AnnotationAccess">
- <summary>
- An annotation access level.
- </summary>
- <remarks>
- <para>An annotation access level.</para>
- <para>For more information about annotations, see
- <a href="https://tools.ietf.org/html/rfc5257">rfc5257</a>.</para>
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationAccess.None">
- <summary>
- Annotations are not supported.
- </summary>
- </member>
- <member name="F:MailKit.AnnotationAccess.ReadOnly">
- <summary>
- Annotations are read-only.
- </summary>
- </member>
- <member name="F:MailKit.AnnotationAccess.ReadWrite">
- <summary>
- Annotations are read-write.
- </summary>
- </member>
- <member name="T:MailKit.AnnotationAttribute">
- <summary>
- An annotation attribute.
- </summary>
- <remarks>
- <para>An annotation attribute.</para>
- <para>For more information about annotations, see
- <a href="https://tools.ietf.org/html/rfc5257">rfc5257</a>.</para>
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationAttribute.Value">
- <summary>
- The annotation value.
- </summary>
- <remarks>
- Used to get or set both the private and shared values of an annotation.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationAttribute.SharedValue">
- <summary>
- The shared annotation value.
- </summary>
- <remarks>
- Used to get or set the shared value of an annotation.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationAttribute.PrivateValue">
- <summary>
- The private annotation value.
- </summary>
- <remarks>
- Used to get or set the private value of an annotation.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationAttribute.Size">
- <summary>
- The size of an annotation value.
- </summary>
- <remarks>
- Used to get the size of the both the private and shared annotation values.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationAttribute.SharedSize">
- <summary>
- The size of a shared annotation value.
- </summary>
- <remarks>
- Used to get the size of a shared annotation value.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationAttribute.PrivateSize">
- <summary>
- The size of a private annotation value.
- </summary>
- <remarks>
- Used to get the size of a private annotation value.
- </remarks>
- </member>
- <member name="M:MailKit.AnnotationAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AnnotationAttribute"/> class.
- </summary>
- <param name="specifier">The annotation attribute specifier.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="specifier"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="specifier"/> contains illegal characters.
- </exception>
- </member>
- <member name="P:MailKit.AnnotationAttribute.Name">
- <summary>
- Get the name of the annotation attribute.
- </summary>
- <remarks>
- Gets the name of the annotation attribute.
- </remarks>
- </member>
- <member name="P:MailKit.AnnotationAttribute.Scope">
- <summary>
- Get the scope of the annotation attribute.
- </summary>
- <remarks>
- Gets the scope of the annotation attribute.
- </remarks>
- </member>
- <member name="P:MailKit.AnnotationAttribute.Specifier">
- <summary>
- Get the annotation attribute specifier.
- </summary>
- <remarks>
- Gets the annotation attribute specifier.
- </remarks>
- </member>
- <member name="M:MailKit.AnnotationAttribute.Equals(MailKit.AnnotationAttribute)">
- <summary>
- Determines whether the specified <see cref="T:MailKit.AnnotationAttribute"/> is equal to the current <see cref="T:MailKit.AnnotationAttribute"/>.
- </summary>
- <remarks>
- Determines whether the specified <see cref="T:MailKit.AnnotationAttribute"/> is equal to the current <see cref="T:MailKit.AnnotationAttribute"/>.
- </remarks>
- <param name="other">The <see cref="T:MailKit.AnnotationAttribute"/> to compare with the current <see cref="T:MailKit.AnnotationAttribute"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:MailKit.AnnotationAttribute"/> is equal to the current
- <see cref="T:MailKit.AnnotationAttribute"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:MailKit.AnnotationAttribute.op_Equality(MailKit.AnnotationAttribute,MailKit.AnnotationAttribute)">
- <summary>
- Determines whether two annotation attributes are equal.
- </summary>
- <remarks>
- Determines whether two annotation attributes are equal.
- </remarks>
- <returns><c>true</c> if <paramref name="attr1"/> and <paramref name="attr2"/> are equal; otherwise, <c>false</c>.</returns>
- <param name="attr1">The first annotation attribute to compare.</param>
- <param name="attr2">The second annotation attribute to compare.</param>
- </member>
- <member name="M:MailKit.AnnotationAttribute.op_Inequality(MailKit.AnnotationAttribute,MailKit.AnnotationAttribute)">
- <summary>
- Determines whether two annotation attributes are not equal.
- </summary>
- <remarks>
- Determines whether two annotation attributes are not equal.
- </remarks>
- <returns><c>true</c> if <paramref name="attr1"/> and <paramref name="attr2"/> are not equal; otherwise, <c>false</c>.</returns>
- <param name="attr1">The first annotation attribute to compare.</param>
- <param name="attr2">The second annotation attribute to compare.</param>
- </member>
- <member name="M:MailKit.AnnotationAttribute.Equals(System.Object)">
- <summary>
- Determine whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AnnotationAttribute"/>.
- </summary>
- <remarks>
- Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AnnotationAttribute"/>.
- </remarks>
- <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:MailKit.AnnotationAttribute"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current
- <see cref="T:MailKit.AnnotationAttribute"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:MailKit.AnnotationAttribute.GetHashCode">
- <summary>
- Serves as a hash function for a <see cref="T:MailKit.AnnotationAttribute"/> object.
- </summary>
- <remarks>
- Serves as a hash function for a <see cref="T:MailKit.AnnotationAttribute"/> object.
- </remarks>
- <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.</returns>
- </member>
- <member name="M:MailKit.AnnotationAttribute.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AnnotationAttribute"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AnnotationAttribute"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AnnotationAttribute"/>.</returns>
- </member>
- <member name="T:MailKit.AnnotationEntry">
- <summary>
- An annotation entry.
- </summary>
- <remarks>
- <para>An annotation entry.</para>
- <para>For more information about annotations, see
- <a href="https://tools.ietf.org/html/rfc5257">rfc5257</a>.</para>
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationEntry.Comment">
- <summary>
- An annotation entry for a comment on a message.
- </summary>
- <remarks>
- Used to get or set a comment on a message.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationEntry.PrivateComment">
- <summary>
- An annotation entry for a private comment on a message.
- </summary>
- <remarks>
- Used to get or set a private comment on a message.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationEntry.SharedComment">
- <summary>
- An annotation entry for a shared comment on a message.
- </summary>
- <remarks>
- Used to get or set a shared comment on a message.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationEntry.Flags">
- <summary>
- An annotation entry for flags on a message.
- </summary>
- <remarks>
- Used to get or set flags on a message.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationEntry.PrivateFlags">
- <summary>
- An annotation entry for private flags on a message.
- </summary>
- <remarks>
- Used to get or set private flags on a message.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationEntry.SharedFlags">
- <summary>
- Aa annotation entry for shared flags on a message.
- </summary>
- <remarks>
- Used to get or set shared flags on a message.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationEntry.AltSubject">
- <summary>
- An annotation entry for an alternate subject on a message.
- </summary>
- <remarks>
- Used to get or set an alternate subject on a message.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationEntry.PrivateAltSubject">
- <summary>
- An annotation entry for a private alternate subject on a message.
- </summary>
- <remarks>
- Used to get or set a private alternate subject on a message.
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationEntry.SharedAltSubject">
- <summary>
- An annotation entry for a shared alternate subject on a message.
- </summary>
- <remarks>
- Used to get or set a shared alternate subject on a message.
- </remarks>
- </member>
- <member name="M:MailKit.AnnotationEntry.#ctor(System.String,MailKit.AnnotationScope)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AnnotationEntry"/> struct.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AnnotationEntry"/>.
- </remarks>
- <param name="path">The annotation entry path.</param>
- <param name="scope">The scope of the annotation.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="path"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="path"/> is invalid.
- </exception>
- </member>
- <member name="M:MailKit.AnnotationEntry.#ctor(System.String,System.String,MailKit.AnnotationScope)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AnnotationEntry"/> struct.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AnnotationEntry"/> for an individual body part of a message.
- </remarks>
- <param name="partSpecifier">The part-specifier of the body part of the message.</param>
- <param name="path">The annotation entry path.</param>
- <param name="scope">The scope of the annotation.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="partSpecifier"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="path"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="partSpecifier"/> is invalid.</para>
- <para>-or-</para>
- <para><paramref name="path"/> is invalid.</para>
- </exception>
- </member>
- <member name="M:MailKit.AnnotationEntry.#ctor(MailKit.BodyPart,System.String,MailKit.AnnotationScope)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AnnotationEntry"/> struct.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AnnotationEntry"/> for an individual body part of a message.
- </remarks>
- <param name="part">The body part of the message.</param>
- <param name="path">The annotation entry path.</param>
- <param name="scope">The scope of the annotation.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="part"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="path"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="path"/> is invalid.
- </exception>
- </member>
- <member name="P:MailKit.AnnotationEntry.Entry">
- <summary>
- Get the annotation entry specifier.
- </summary>
- <remarks>
- Gets the annotation entry specifier.
- </remarks>
- <value>The annotation entry specifier.</value>
- </member>
- <member name="P:MailKit.AnnotationEntry.PartSpecifier">
- <summary>
- Get the part-specifier component of the annotation entry.
- </summary>
- <remarks>
- Gets the part-specifier component of the annotation entry.
- </remarks>
- </member>
- <member name="P:MailKit.AnnotationEntry.Path">
- <summary>
- Get the path component of the annotation entry.
- </summary>
- <remarks>
- Gets the path component of the annotation entry.
- </remarks>
- </member>
- <member name="P:MailKit.AnnotationEntry.Scope">
- <summary>
- Get the scope of the annotation.
- </summary>
- <remarks>
- Gets the scope of the annotation.
- </remarks>
- </member>
- <member name="M:MailKit.AnnotationEntry.Equals(MailKit.AnnotationEntry)">
- <summary>
- Determines whether the specified <see cref="T:MailKit.AnnotationEntry"/> is equal to the current <see cref="T:MailKit.AnnotationEntry"/>.
- </summary>
- <remarks>
- Determines whether the specified <see cref="T:MailKit.AnnotationEntry"/> is equal to the current <see cref="T:MailKit.AnnotationEntry"/>.
- </remarks>
- <param name="other">The <see cref="T:MailKit.AnnotationEntry"/> to compare with the current <see cref="T:MailKit.AnnotationEntry"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:MailKit.AnnotationEntry"/> is equal to the current
- <see cref="T:MailKit.AnnotationEntry"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:MailKit.AnnotationEntry.op_Equality(MailKit.AnnotationEntry,MailKit.AnnotationEntry)">
- <summary>
- Determines whether two annotation entries are equal.
- </summary>
- <remarks>
- Determines whether two annotation entries are equal.
- </remarks>
- <returns><c>true</c> if <paramref name="entry1"/> and <paramref name="entry2"/> are equal; otherwise, <c>false</c>.</returns>
- <param name="entry1">The first annotation entry to compare.</param>
- <param name="entry2">The second annotation entry to compare.</param>
- </member>
- <member name="M:MailKit.AnnotationEntry.op_Inequality(MailKit.AnnotationEntry,MailKit.AnnotationEntry)">
- <summary>
- Determines whether two annotation entries are not equal.
- </summary>
- <remarks>
- Determines whether two annotation entries are not equal.
- </remarks>
- <returns><c>true</c> if <paramref name="entry1"/> and <paramref name="entry2"/> are not equal; otherwise, <c>false</c>.</returns>
- <param name="entry1">The first annotation entry to compare.</param>
- <param name="entry2">The second annotation entry to compare.</param>
- </member>
- <member name="M:MailKit.AnnotationEntry.Equals(System.Object)">
- <summary>
- Determine whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AnnotationEntry"/>.
- </summary>
- <remarks>
- Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AnnotationEntry"/>.
- </remarks>
- <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:MailKit.AnnotationEntry"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current
- <see cref="T:MailKit.AnnotationEntry"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:MailKit.AnnotationEntry.GetHashCode">
- <summary>
- Serves as a hash function for a <see cref="T:MailKit.AnnotationEntry"/> object.
- </summary>
- <remarks>
- Serves as a hash function for a <see cref="T:MailKit.AnnotationEntry"/> object.
- </remarks>
- <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.</returns>
- </member>
- <member name="M:MailKit.AnnotationEntry.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AnnotationEntry"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AnnotationEntry"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AnnotationEntry"/>.</returns>
- </member>
- <member name="M:MailKit.AnnotationEntry.Parse(System.String)">
- <summary>
- Parse an annotation entry.
- </summary>
- <remarks>
- Parses an annotation entry.
- </remarks>
- <param name="entry">The annotation entry.</param>
- <returns>The parsed annotation entry.</returns>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="entry"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.FormatException">
- <paramref name="entry"/> does not conform to the annotation entry syntax.
- </exception>
- </member>
- <member name="T:MailKit.AnnotationsChangedEventArgs">
- <summary>
- Event args used when an annotation changes.
- </summary>
- <remarks>
- Event args used when an annotation changes.
- </remarks>
- </member>
- <member name="M:MailKit.AnnotationsChangedEventArgs.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AnnotationsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AnnotationsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- </member>
- <member name="M:MailKit.AnnotationsChangedEventArgs.#ctor(System.Int32,System.Collections.Generic.IEnumerable{MailKit.Annotation})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AnnotationsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AnnotationsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="annotations">The annotations that changed.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="annotations"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.AnnotationsChangedEventArgs.Annotations">
- <summary>
- Get the annotations that changed.
- </summary>
- <remarks>
- Gets the annotations that changed.
- </remarks>
- <value>The annotation.</value>
- </member>
- <member name="P:MailKit.AnnotationsChangedEventArgs.ModSeq">
- <summary>
- Gets the updated mod-sequence value of the message, if available.
- </summary>
- <remarks>
- Gets the updated mod-sequence value of the message, if available.
- </remarks>
- <value>The mod-sequence value.</value>
- </member>
- <member name="T:MailKit.AnnotationScope">
- <summary>
- The scope of an annotation.
- </summary>
- <remarks>
- <para>Represents the scope of an annotation.</para>
- <para>For more information about annotations, see
- <a href="https://tools.ietf.org/html/rfc5257">rfc5257</a>.</para>
- </remarks>
- </member>
- <member name="F:MailKit.AnnotationScope.None">
- <summary>
- No scopes.
- </summary>
- </member>
- <member name="F:MailKit.AnnotationScope.Private">
- <summary>
- The private annotation scope.
- </summary>
- </member>
- <member name="F:MailKit.AnnotationScope.Shared">
- <summary>
- The shared annotation scope.
- </summary>
- </member>
- <member name="F:MailKit.AnnotationScope.Both">
- <summary>
- Both private and shared scopes.
- </summary>
- </member>
- <member name="T:MailKit.AuthenticatedEventArgs">
- <summary>
- Authenticated event arguments.
- </summary>
- <remarks>
- Some servers, such as GMail IMAP, will send some free-form text in
- the response to a successful login.
- </remarks>
- </member>
- <member name="M:MailKit.AuthenticatedEventArgs.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.AuthenticatedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.AuthenticatedEventArgs"/>.
- </remarks>
- <param name="message">The free-form text.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.AuthenticatedEventArgs.Message">
- <summary>
- Get the free-form text sent by the server.
- </summary>
- <remarks>
- Gets the free-form text sent by the server.
- </remarks>
- <value>The free-form text sent by the server.</value>
- </member>
- <member name="T:MailKit.BodyPart">
- <summary>
- An abstract body part of a message.
- </summary>
- <remarks>
- Each body part will actually be a <see cref="T:MailKit.BodyPartBasic"/>,
- <see cref="T:MailKit.BodyPartText"/>, <see cref="T:MailKit.BodyPartMessage"/>, or
- <see cref="T:MailKit.BodyPartMultipart"/>.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- </member>
- <member name="M:MailKit.BodyPart.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.BodyPart"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.BodyPart"/>.
- </remarks>
- </member>
- <member name="P:MailKit.BodyPart.ContentType">
- <summary>
- Gets the Content-Type of the body part.
- </summary>
- <remarks>
- Gets the Content-Type of the body part.
- </remarks>
- <value>The content type.</value>
- </member>
- <member name="P:MailKit.BodyPart.PartSpecifier">
- <summary>
- Gets the part specifier.
- </summary>
- <remarks>
- Gets the part specifier.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <value>The part specifier.</value>
- </member>
- <member name="M:MailKit.BodyPart.Accept(MailKit.BodyPartVisitor)">
- <summary>
- Dispatches to the specific visit method for this MIME body part.
- </summary>
- <remarks>
- This default implementation for <see cref="T:MailKit.BodyPart"/> nodes
- calls <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>. Override this
- method to call into a more specific method on a derived visitor class
- of the <see cref="T:MailKit.BodyPartVisitor"/> class. However, it should still
- support unknown visitors by calling
- <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>.
- </remarks>
- <param name="visitor">The visitor.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="visitor"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.BodyPart.Encode(System.Text.StringBuilder)">
- <summary>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <remarks>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </remarks>
- <param name="builder">The string builder.</param>
- </member>
- <member name="M:MailKit.BodyPart.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.BodyPart"/>.
- </summary>
- <remarks>
- <para>Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.BodyPart"/>.</para>
- <note type="note">The syntax of the string returned, while similar to IMAP's BODYSTRUCTURE syntax,
- is not completely compatible.</note>
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.BodyPart"/>.</returns>
- </member>
- <member name="M:MailKit.BodyPart.TryParse(System.String,MailKit.BodyPart@)">
- <summary>
- Tries to parse the given text into a new <see cref="T:MailKit.BodyPart"/> instance.
- </summary>
- <remarks>
- <para>Parses a body part from the specified text.</para>
- <note type="note">This syntax, while similar to IMAP's BODYSTRUCTURE syntax, is not completely
- compatible.</note>
- </remarks>
- <returns><c>true</c>, if the body part was successfully parsed, <c>false</c> otherwise.</returns>
- <param name="text">The text to parse.</param>
- <param name="part">The parsed body part.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- </member>
- <member name="T:MailKit.BodyPartBasic">
- <summary>
- A basic message body part.
- </summary>
- <remarks>
- Represents any message body part that is not a multipart,
- message/rfc822 part, or a text part.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- </member>
- <member name="M:MailKit.BodyPartBasic.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.BodyPartBasic"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.BodyPartBasic"/>.
- </remarks>
- </member>
- <member name="P:MailKit.BodyPartBasic.ContentId">
- <summary>
- Gets the Content-Id of the body part, if available.
- </summary>
- <remarks>
- Gets the Content-Id of the body part, if available.
- </remarks>
- <value>The content identifier.</value>
- </member>
- <member name="P:MailKit.BodyPartBasic.ContentDescription">
- <summary>
- Gets the Content-Description of the body part, if available.
- </summary>
- <remarks>
- Gets the Content-Description of the body part, if available.
- </remarks>
- <value>The content description.</value>
- </member>
- <member name="P:MailKit.BodyPartBasic.ContentTransferEncoding">
- <summary>
- Gets the Content-Transfer-Encoding of the body part.
- </summary>
- <remarks>
- <para>Gets the Content-Transfer-Encoding of the body part.</para>
- <para>Hint: Use the <a href="M_MimeKit_Utils_MimeUtils_TryParse_1.htm">MimeUtils.TryParse</a>
- method to parse this value into a usable <see cref="T:MimeKit.ContentEncoding"/>.</para>
- </remarks>
- <value>The content transfer encoding.</value>
- </member>
- <member name="P:MailKit.BodyPartBasic.Octets">
- <summary>
- Gets the size of the body part, in bytes.
- </summary>
- <remarks>
- Gets the size of the body part, in bytes.
- </remarks>
- <value>The number of octets.</value>
- </member>
- <member name="P:MailKit.BodyPartBasic.ContentMd5">
- <summary>
- Gets the MD5 hash of the content, if available.
- </summary>
- <remarks>
- Gets the MD5 hash of the content, if available.
- </remarks>
- <value>The content md5.</value>
- </member>
- <member name="P:MailKit.BodyPartBasic.ContentDisposition">
- <summary>
- Gets the Content-Disposition of the body part, if available.
- </summary>
- <remarks>
- <para>Gets the Content-Disposition of the body part, if available.</para>
- <note type="note">The Content-Disposition value is only retrieved if the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is used when fetching
- summary information from an <see cref="T:MailKit.IMailFolder"/>.</note>
- </remarks>
- <value>The content disposition.</value>
- </member>
- <member name="P:MailKit.BodyPartBasic.ContentLanguage">
- <summary>
- Gets the Content-Language of the body part, if available.
- </summary>
- <remarks>
- <para>Gets the Content-Language of the body part, if available.</para>
- <para>The Content-Language value is only retrieved if the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is used when fetching
- summary information from an <see cref="T:MailKit.IMailFolder"/>.</para>
- </remarks>
- <value>The content language.</value>
- </member>
- <member name="P:MailKit.BodyPartBasic.ContentLocation">
- <summary>
- Gets the Content-Location of the body part, if available.
- </summary>
- <remarks>
- <para>Gets the Content-Location of the body part, if available.</para>
- <para>The Content-Location value is only retrieved if the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is used when fetching
- summary information from an <see cref="T:MailKit.IMailFolder"/>.</para>
- </remarks>
- <value>The content location.</value>
- </member>
- <member name="P:MailKit.BodyPartBasic.IsAttachment">
- <summary>
- Determines whether or not the body part is an attachment.
- </summary>
- <remarks>
- <para>Determines whether or not the body part is an attachment based on the value of
- the Content-Disposition.</para>
- <note type="note">Since the value of the Content-Disposition header is needed, it
- is necessary to include the <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag when
- fetching summary information from an <see cref="T:MailKit.IMailFolder"/>.</note>
- </remarks>
- <value><c>true</c> if this part is an attachment; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.BodyPartBasic.FileName">
- <summary>
- Get the name of the file.
- </summary>
- <remarks>
- <para>First checks for the "filename" parameter on the Content-Disposition header. If
- that does not exist, then the "name" parameter on the Content-Type header is used.</para>
- <note type="note">Since the value of the Content-Disposition header is needed, it is
- necessary to include the <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag when
- fetching summary information from an <see cref="T:MailKit.IMailFolder"/>.</note>
- </remarks>
- <value>The name of the file.</value>
- </member>
- <member name="M:MailKit.BodyPartBasic.Accept(MailKit.BodyPartVisitor)">
- <summary>
- Dispatches to the specific visit method for this MIME body part.
- </summary>
- <remarks>
- This default implementation for <see cref="T:MailKit.BodyPart"/> nodes
- calls <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>. Override this
- method to call into a more specific method on a derived visitor class
- of the <see cref="T:MailKit.BodyPartVisitor"/> class. However, it should still
- support unknown visitors by calling
- <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>.
- </remarks>
- <param name="visitor">The visitor.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="visitor"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.BodyPartBasic.Encode(System.Text.StringBuilder)">
- <summary>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <remarks>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </remarks>
- <param name="builder">The string builder.</param>
- </member>
- <member name="T:MailKit.BodyPartCollection">
- <summary>
- A <see cref="T:MailKit.BodyPart"/> collection.
- </summary>
- <remarks>
- A <see cref="T:MailKit.BodyPart"/> collection.
- </remarks>
- </member>
- <member name="M:MailKit.BodyPartCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.BodyPartCollection"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.BodyPartCollection"/>.
- </remarks>
- </member>
- <member name="P:MailKit.BodyPartCollection.Count">
- <summary>
- Get the number of body parts in the collection.
- </summary>
- <remarks>
- Gets the number of body parts in the collection.
- </remarks>
- <value>The count.</value>
- </member>
- <member name="P:MailKit.BodyPartCollection.IsReadOnly">
- <summary>
- Get whether or not this body part collection is read only.
- </summary>
- <remarks>
- Gets whether or not this body part collection is read only.
- </remarks>
- <value><c>true</c> if this collection is read only; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.BodyPartCollection.Add(MailKit.BodyPart)">
- <summary>
- Add the specified body part to the collection.
- </summary>
- <remarks>
- Adds the specified body part to the collection.
- </remarks>
- <param name="part">The body part.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.BodyPartCollection.Clear">
- <summary>
- Clears the body part collection.
- </summary>
- <remarks>
- Removes all of the body parts from the collection.
- </remarks>
- </member>
- <member name="M:MailKit.BodyPartCollection.Contains(MailKit.BodyPart)">
- <summary>
- Checks if the collection contains the specified body part.
- </summary>
- <remarks>
- Determines whether or not the collection contains the specified body part.
- </remarks>
- <returns><value>true</value> if the specified body part exists; otherwise <value>false</value>.</returns>
- <param name="part">The body part.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.BodyPartCollection.CopyTo(MailKit.BodyPart[],System.Int32)">
- <summary>
- Copies all of the body parts in the collection to the specified array.
- </summary>
- <remarks>
- Copies all of the body parts within the collection into the array,
- starting at the specified array index.
- </remarks>
- <param name="array">The array.</param>
- <param name="arrayIndex">The array index.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="array"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="arrayIndex"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.BodyPartCollection.Remove(MailKit.BodyPart)">
- <summary>
- Removes the specified body part.
- </summary>
- <remarks>
- Removes the specified body part.
- </remarks>
- <returns><value>true</value> if the body part was removed; otherwise <value>false</value>.</returns>
- <param name="part">The body part.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.BodyPartCollection.Item(System.Int32)">
- <summary>
- Get the body part at the specified index.
- </summary>
- <remarks>
- Gets the body part at the specified index.
- </remarks>
- <value>The body part at the specified index.</value>
- <param name="index">The index.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.BodyPartCollection.IndexOf(System.Uri)">
- <summary>
- Gets the index of the body part matching the specified URI.
- </summary>
- <remarks>
- <para>Finds the index of the body part matching the specified URI, if it exists.</para>
- <para>If the URI scheme is <c>"cid"</c>, then matching is performed based on the Content-Id header
- values, otherwise the Content-Location headers are used. If the provided URI is absolute and a child
- part's Content-Location is relative, then then the child part's Content-Location URI will be combined
- with the value of its Content-Base header, if available, otherwise it will be combined with the
- multipart/related part's Content-Base header in order to produce an absolute URI that can be
- compared with the provided absolute URI.</para>
- </remarks>
- <returns>The index of the part matching the specified URI if found; otherwise <c>-1</c>.</returns>
- <param name="uri">The URI of the body part.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uri"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.BodyPartCollection.GetEnumerator">
- <summary>
- Get the body part enumerator.
- </summary>
- <remarks>
- Gets the body part enumerator.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.BodyPartCollection.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Get the body part enumerator.
- </summary>
- <remarks>
- Gets the body part enumerator.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="T:MailKit.BodyPartMessage">
- <summary>
- A message/rfc822 body part.
- </summary>
- <remarks>
- Represents a message/rfc822 body part.
- </remarks>
- </member>
- <member name="M:MailKit.BodyPartMessage.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.BodyPartMessage"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.BodyPartMessage"/>.
- </remarks>
- </member>
- <member name="P:MailKit.BodyPartMessage.Envelope">
- <summary>
- Gets the envelope of the message, if available.
- </summary>
- <remarks>
- Gets the envelope of the message, if available.
- </remarks>
- <value>The envelope.</value>
- </member>
- <member name="P:MailKit.BodyPartMessage.Body">
- <summary>
- Gets the body structure of the message.
- </summary>
- <remarks>
- Gets the body structure of the message.
- </remarks>
- <value>The body structure.</value>
- </member>
- <member name="P:MailKit.BodyPartMessage.Lines">
- <summary>
- Gets the length of the message, in lines.
- </summary>
- <remarks>
- Gets the length of the message, in lines.
- </remarks>
- <value>The number of lines.</value>
- </member>
- <member name="M:MailKit.BodyPartMessage.Accept(MailKit.BodyPartVisitor)">
- <summary>
- Dispatches to the specific visit method for this MIME body part.
- </summary>
- <remarks>
- This default implementation for <see cref="T:MailKit.BodyPart"/> nodes
- calls <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>. Override this
- method to call into a more specific method on a derived visitor class
- of the <see cref="T:MailKit.BodyPartVisitor"/> class. However, it should still
- support unknown visitors by calling
- <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>.
- </remarks>
- <param name="visitor">The visitor.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="visitor"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.BodyPartMessage.Encode(System.Text.StringBuilder)">
- <summary>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <remarks>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </remarks>
- <param name="builder">The string builder.</param>
- </member>
- <member name="T:MailKit.BodyPartMultipart">
- <summary>
- A multipart body part.
- </summary>
- <remarks>
- A multipart body part.
- </remarks>
- </member>
- <member name="M:MailKit.BodyPartMultipart.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.BodyPartMultipart"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.BodyPartMultipart"/>.
- </remarks>
- </member>
- <member name="P:MailKit.BodyPartMultipart.BodyParts">
- <summary>
- Gets the child body parts.
- </summary>
- <remarks>
- Gets the child body parts.
- </remarks>
- <value>The child body parts.</value>
- </member>
- <member name="P:MailKit.BodyPartMultipart.ContentDisposition">
- <summary>
- Gets the Content-Disposition of the body part, if available.
- </summary>
- <remarks>
- Gets the Content-Disposition of the body part, if available.
- </remarks>
- <value>The content disposition.</value>
- </member>
- <member name="P:MailKit.BodyPartMultipart.ContentLanguage">
- <summary>
- Gets the Content-Language of the body part, if available.
- </summary>
- <remarks>
- Gets the Content-Language of the body part, if available.
- </remarks>
- <value>The content language.</value>
- </member>
- <member name="P:MailKit.BodyPartMultipart.ContentLocation">
- <summary>
- Gets the Content-Location of the body part, if available.
- </summary>
- <remarks>
- Gets the Content-Location of the body part, if available.
- </remarks>
- <value>The content location.</value>
- </member>
- <member name="M:MailKit.BodyPartMultipart.Accept(MailKit.BodyPartVisitor)">
- <summary>
- Dispatches to the specific visit method for this MIME body part.
- </summary>
- <remarks>
- This default implementation for <see cref="T:MailKit.BodyPart"/> nodes
- calls <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>. Override this
- method to call into a more specific method on a derived visitor class
- of the <see cref="T:MailKit.BodyPartVisitor"/> class. However, it should still
- support unknown visitors by calling
- <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>.
- </remarks>
- <param name="visitor">The visitor.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="visitor"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.BodyPartMultipart.Encode(System.Text.StringBuilder)">
- <summary>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <remarks>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </remarks>
- <param name="builder">The string builder.</param>
- </member>
- <member name="T:MailKit.BodyPartText">
- <summary>
- A textual body part.
- </summary>
- <remarks>
- Represents any body part with a media type of "text".
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- </member>
- <member name="M:MailKit.BodyPartText.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.BodyPartText"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.BodyPartText"/>.
- </remarks>
- </member>
- <member name="P:MailKit.BodyPartText.IsPlain">
- <summary>
- Gets whether or not this text part contains plain text.
- </summary>
- <remarks>
- Checks whether or not the text part's Content-Type is text/plain.
- </remarks>
- <value><c>true</c> if the text is html; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.BodyPartText.IsHtml">
- <summary>
- Gets whether or not this text part contains HTML.
- </summary>
- <remarks>
- Checks whether or not the text part's Content-Type is text/html.
- </remarks>
- <value><c>true</c> if the text is html; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.BodyPartText.Lines">
- <summary>
- Gets the length of the text, in lines.
- </summary>
- <remarks>
- Gets the length of the text, in lines.
- </remarks>
- <value>The number of lines.</value>
- </member>
- <member name="M:MailKit.BodyPartText.Accept(MailKit.BodyPartVisitor)">
- <summary>
- Dispatches to the specific visit method for this MIME body part.
- </summary>
- <remarks>
- This default implementation for <see cref="T:MailKit.BodyPart"/> nodes
- calls <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>. Override this
- method to call into a more specific method on a derived visitor class
- of the <see cref="T:MailKit.BodyPartVisitor"/> class. However, it should still
- support unknown visitors by calling
- <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>.
- </remarks>
- <param name="visitor">The visitor.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="visitor"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.BodyPartText.Encode(System.Text.StringBuilder)">
- <summary>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <remarks>
- Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
- </remarks>
- <param name="builder">The string builder.</param>
- </member>
- <member name="T:MailKit.BodyPartVisitor">
- <summary>
- Represents a visitor for a tree of MIME body parts.
- </summary>
- <remarks>
- This class is designed to be inherited to create more specialized classes whose
- functionality requires traversing, examining or copying a tree of MIME body parts.
- </remarks>
- </member>
- <member name="M:MailKit.BodyPartVisitor.Visit(MailKit.BodyPart)">
- <summary>
- Dispatches the entity to one of the more specialized visit methods in this class.
- </summary>
- <remarks>
- Dispatches the entity to one of the more specialized visit methods in this class.
- </remarks>
- <param name="body">The MIME body part.</param>
- </member>
- <member name="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)">
- <summary>
- Visit the abstract MIME body part.
- </summary>
- <remarks>
- Visits the abstract MIME body part.
- </remarks>
- <param name="entity">The MIME body part.</param>
- </member>
- <member name="M:MailKit.BodyPartVisitor.VisitBodyPartBasic(MailKit.BodyPartBasic)">
- <summary>
- Visit the basic MIME body part.
- </summary>
- <remarks>
- Visits the basic MIME body part.
- </remarks>
- <param name="entity">The basic MIME body part.</param>
- </member>
- <member name="M:MailKit.BodyPartVisitor.VisitMessage(MailKit.BodyPart)">
- <summary>
- Visit the message contained within a message/rfc822 or message/news MIME entity.
- </summary>
- <remarks>
- Visits the message contained within a message/rfc822 or message/news MIME entity.
- </remarks>
- <param name="message">The body part representing the message/rfc822 message.</param>
- </member>
- <member name="M:MailKit.BodyPartVisitor.VisitBodyPartMessage(MailKit.BodyPartMessage)">
- <summary>
- Visit the message/rfc822 or message/news MIME entity.
- </summary>
- <remarks>
- Visits the message/rfc822 or message/news MIME entity.
- </remarks>
- <param name="entity">The message/rfc822 or message/news body part.</param>
- </member>
- <member name="M:MailKit.BodyPartVisitor.VisitChildren(MailKit.BodyPartMultipart)">
- <summary>
- Visit the children of a <see cref="T:MailKit.BodyPartMultipart"/>.
- </summary>
- <remarks>
- Visits the children of a <see cref="T:MailKit.BodyPartMultipart"/>.
- </remarks>
- <param name="multipart">The multipart.</param>
- </member>
- <member name="M:MailKit.BodyPartVisitor.VisitBodyPartMultipart(MailKit.BodyPartMultipart)">
- <summary>
- Visit the abstract multipart MIME entity.
- </summary>
- <remarks>
- Visits the abstract multipart MIME entity.
- </remarks>
- <param name="multipart">The multipart body part.</param>
- </member>
- <member name="M:MailKit.BodyPartVisitor.VisitBodyPartText(MailKit.BodyPartText)">
- <summary>
- Visit the text-based MIME part entity.
- </summary>
- <remarks>
- Visits the text-based MIME part entity.
- </remarks>
- <param name="entity">The text-based body part.</param>
- </member>
- <member name="T:MailKit.CommandException">
- <summary>
- The exception that is thrown when there is a command error.
- </summary>
- <remarks>
- A <see cref="T:MailKit.CommandException"/> can be thrown by any of the various client
- methods in MailKit. Unlike a <see cref="T:MailKit.ProtocolException"/>, a
- <see cref="T:MailKit.CommandException"/> is typically non-fatal (meaning that it does
- not force the client to disconnect).
- </remarks>
- </member>
- <member name="M:MailKit.CommandException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.CommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.CommandException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">An inner exception.</param>
- </member>
- <member name="M:MailKit.CommandException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.CommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.CommandException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.CommandException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.CommandException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.CommandException"/>.
- </remarks>
- </member>
- <member name="T:MailKit.CompressedStream">
- <summary>
- A compressed stream.
- </summary>
- </member>
- <member name="P:MailKit.CompressedStream.InnerStream">
- <summary>
- Gets the inner stream.
- </summary>
- <value>The inner stream.</value>
- </member>
- <member name="P:MailKit.CompressedStream.CanRead">
- <summary>
- Gets whether the stream supports reading.
- </summary>
- <value><c>true</c> if the stream supports reading; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.CompressedStream.CanWrite">
- <summary>
- Gets whether the stream supports writing.
- </summary>
- <value><c>true</c> if the stream supports writing; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.CompressedStream.CanSeek">
- <summary>
- Gets whether the stream supports seeking.
- </summary>
- <value><c>true</c> if the stream supports seeking; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.CompressedStream.CanTimeout">
- <summary>
- Gets whether the stream supports I/O timeouts.
- </summary>
- <value><c>true</c> if the stream supports I/O timeouts; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.CompressedStream.ReadTimeout">
- <summary>
- Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
- </summary>
- <returns>A value, in miliseconds, that determines how long the stream will attempt to read before timing out.</returns>
- <value>The read timeout.</value>
- </member>
- <member name="P:MailKit.CompressedStream.WriteTimeout">
- <summary>
- Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
- </summary>
- <returns>A value, in miliseconds, that determines how long the stream will attempt to write before timing out.</returns>
- <value>The write timeout.</value>
- </member>
- <member name="P:MailKit.CompressedStream.Position">
- <summary>
- Gets or sets the position within the current stream.
- </summary>
- <returns>The current position within the stream.</returns>
- <value>The position of the stream.</value>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- </member>
- <member name="P:MailKit.CompressedStream.Length">
- <summary>
- Gets the length in bytes of the stream.
- </summary>
- <returns>A long value representing the length of the stream in bytes.</returns>
- <value>The length of the stream.</value>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- </member>
- <member name="M:MailKit.CompressedStream.Read(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.CompressedStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.CompressedStream.Write(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <param name="buffer">The buffer to write.</param>
- <param name="offset">The offset of the first byte to write.</param>
- <param name="count">The number of bytes to write.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.CompressedStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <returns>A task that represents the asynchronous write operation.</returns>
- <param name="buffer">The buffer to write.</param>
- <param name="offset">The offset of the first byte to write.</param>
- <param name="count">The number of bytes to write.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.CompressedStream.Flush">
- <summary>
- Clears all output buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.CompressedStream.FlushAsync(System.Threading.CancellationToken)">
- <summary>
- Clears all output buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <returns>A task that represents the asynchronous flush operation.</returns>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.CompressedStream.Seek(System.Int64,System.IO.SeekOrigin)">
- <summary>
- Sets the position within the current stream.
- </summary>
- <returns>The new position within the stream.</returns>
- <param name="offset">The offset into the stream relative to the <paramref name="origin"/>.</param>
- <param name="origin">The origin to seek from.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- </member>
- <member name="M:MailKit.CompressedStream.SetLength(System.Int64)">
- <summary>
- Sets the length of the stream.
- </summary>
- <param name="value">The desired length of the stream in bytes.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support setting the length.
- </exception>
- </member>
- <member name="M:MailKit.CompressedStream.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.CompressedStream"/> and
- optionally releases the managed resources.
- </summary>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="T:MailKit.ConnectedEventArgs">
- <summary>
- Connected event arguments.
- </summary>
- <remarks>
- When a <see cref="T:MailKit.IMailService"/> is connected, it will emit a
- <see cref="E:MailKit.IMailService.Connected"/> event.
- </remarks>
- </member>
- <member name="M:MailKit.ConnectedEventArgs.#ctor(System.String,System.Int32,MailKit.Security.SecureSocketOptions)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ConnectedEventArgs"/> class.
- </summary>
- <param name="host">The name of the host that the client connected to.</param>
- <param name="port">The port that the client connected to on the remote host.</param>
- <param name="options">The SSL/TLS options that were used when connecting to the remote host.</param>
- </member>
- <member name="P:MailKit.ConnectedEventArgs.Host">
- <summary>
- Get the name of the remote host.
- </summary>
- <remarks>
- Gets the name of the remote host.
- </remarks>
- <value>The host name of the server.</value>
- </member>
- <member name="P:MailKit.ConnectedEventArgs.Port">
- <summary>
- Get the port.
- </summary>
- <remarks>
- Gets the port.
- </remarks>
- <value>The port.</value>
- </member>
- <member name="P:MailKit.ConnectedEventArgs.Options">
- <summary>
- Get the SSL/TLS options.
- </summary>
- <remarks>
- Gets the SSL/TLS options.
- </remarks>
- <value>The SSL/TLS options.</value>
- </member>
- <member name="T:MailKit.DeliveryStatusNotification">
- <summary>
- Delivery status notification types.
- </summary>
- <remarks>
- A set of flags that may be bitwise-or'd together to specify
- when a delivery status notification should be sent for a
- particlar recipient.
- </remarks>
- </member>
- <member name="F:MailKit.DeliveryStatusNotification.Never">
- <summary>
- Never send delivery status notifications.
- </summary>
- </member>
- <member name="F:MailKit.DeliveryStatusNotification.Success">
- <summary>
- Send a notification on successful delivery to the recipient.
- </summary>
- </member>
- <member name="F:MailKit.DeliveryStatusNotification.Failure">
- <summary>
- Send a notification on failure to deliver to the recipient.
- </summary>
- </member>
- <member name="F:MailKit.DeliveryStatusNotification.Delay">
- <summary>
- Send a notification when the delivery to the recipient has
- been delayed for an unusual amount of time.
- </summary>
- </member>
- <member name="T:MailKit.DisconnectedEventArgs">
- <summary>
- Disconnected event arguments.
- </summary>
- <remarks>
- When a <see cref="T:MailKit.IMailService"/> gets disconnected, it will emit a
- <see cref="E:MailKit.IMailService.Disconnected"/> event.
- </remarks>
- </member>
- <member name="M:MailKit.DisconnectedEventArgs.#ctor(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.DisconnectedEventArgs"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.DisconnectedEventArgs"/> class.
- </remarks>
- <param name="host">The name of the host that the client was connected to.</param>
- <param name="port">The port that the client was connected to.</param>
- <param name="options">The SSL/TLS options that were used by the client.</param>
- <param name="requested">If <c>true</c>, the <see cref="T:MailKit.IMailService"/> was disconnected via the
- <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> method.</param>
- </member>
- <member name="P:MailKit.DisconnectedEventArgs.IsRequested">
- <summary>
- Get whether or not the service was explicitly asked to disconnect.
- </summary>
- <remarks>
- If the <see cref="T:MailKit.IMailService"/> was disconnected via the
- <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> method, then
- the value of <see cref="P:MailKit.DisconnectedEventArgs.IsRequested"/> will be <c>true</c>. If the connection was unexpectedly
- dropped, then the value will be <c>false</c>.
- </remarks>
- <value><c>true</c> if the disconnect was explicitly requested; otherwise, <c>false</c>.</value>
- </member>
- <member name="T:MailKit.DuplexStream">
- <summary>
- A duplex stream.
- </summary>
- </member>
- <member name="M:MailKit.DuplexStream.#ctor(System.IO.Stream,System.IO.Stream)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.DuplexStream"/> class.
- </summary>
- <param name="istream">The stream to use for input.</param>
- <param name="ostream">The stream to use for output.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="istream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="ostream"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.DuplexStream.InputStream">
- <summary>
- Gets the input stream.
- </summary>
- <value>The input stream.</value>
- </member>
- <member name="P:MailKit.DuplexStream.OutputStream">
- <summary>
- Gets the output stream.
- </summary>
- <value>The output stream.</value>
- </member>
- <member name="P:MailKit.DuplexStream.CanRead">
- <summary>
- Gets whether the stream supports reading.
- </summary>
- <value><c>true</c> if the stream supports reading; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.DuplexStream.CanWrite">
- <summary>
- Gets whether the stream supports writing.
- </summary>
- <value><c>true</c> if the stream supports writing; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.DuplexStream.CanSeek">
- <summary>
- Gets whether the stream supports seeking.
- </summary>
- <value><c>true</c> if the stream supports seeking; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.DuplexStream.CanTimeout">
- <summary>
- Gets whether the stream supports I/O timeouts.
- </summary>
- <value><c>true</c> if the stream supports I/O timeouts; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.DuplexStream.ReadTimeout">
- <summary>
- Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
- </summary>
- <returns>A value, in miliseconds, that determines how long the stream will attempt to read before timing out.</returns>
- <value>The read timeout.</value>
- </member>
- <member name="P:MailKit.DuplexStream.WriteTimeout">
- <summary>
- Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
- </summary>
- <returns>A value, in miliseconds, that determines how long the stream will attempt to write before timing out.</returns>
- <value>The write timeout.</value>
- </member>
- <member name="P:MailKit.DuplexStream.Position">
- <summary>
- Gets or sets the position within the current stream.
- </summary>
- <returns>The current position within the stream.</returns>
- <value>The position of the stream.</value>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- </member>
- <member name="P:MailKit.DuplexStream.Length">
- <summary>
- Gets the length in bytes of the stream.
- </summary>
- <returns>A long value representing the length of the stream in bytes.</returns>
- <value>The length of the stream.</value>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- </member>
- <member name="M:MailKit.DuplexStream.Read(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.DuplexStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads a sequence of bytes from the stream and advances the position
- within the stream by the number of bytes read.
- </summary>
- <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
- bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
- <param name="buffer">The buffer.</param>
- <param name="offset">The buffer offset.</param>
- <param name="count">The number of bytes to read.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.DuplexStream.Write(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <param name="buffer">The buffer to write.</param>
- <param name="offset">The offset of the first byte to write.</param>
- <param name="count">The number of bytes to write.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.DuplexStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Writes a sequence of bytes to the stream and advances the current
- position within this stream by the number of bytes written.
- </summary>
- <returns>A task that represents the asynchronous write operation.</returns>
- <param name="buffer">The buffer to write.</param>
- <param name="offset">The offset of the first byte to write.</param>
- <param name="count">The number of bytes to write.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.DuplexStream.Flush">
- <summary>
- Clears all output buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.DuplexStream.FlushAsync(System.Threading.CancellationToken)">
- <summary>
- Clears all output buffers for this stream and causes any buffered data to be written
- to the underlying device.
- </summary>
- <returns>A task that represents the asynchronous flush operation.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The stream has been disposed.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The stream does not support writing.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.DuplexStream.Seek(System.Int64,System.IO.SeekOrigin)">
- <summary>
- Sets the position within the current stream.
- </summary>
- <returns>The new position within the stream.</returns>
- <param name="offset">The offset into the stream relative to the <paramref name="origin"/>.</param>
- <param name="origin">The origin to seek from.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support seeking.
- </exception>
- </member>
- <member name="M:MailKit.DuplexStream.SetLength(System.Int64)">
- <summary>
- Sets the length of the stream.
- </summary>
- <param name="value">The desired length of the stream in bytes.</param>
- <exception cref="T:System.NotSupportedException">
- The stream does not support setting the length.
- </exception>
- </member>
- <member name="M:MailKit.DuplexStream.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.DuplexStream"/> and
- optionally releases the managed resources.
- </summary>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="T:MailKit.Envelope">
- <summary>
- A message envelope containing a brief summary of the message.
- </summary>
- <remarks>
- The envelope of a message contains information such as the
- date the message was sent, the subject of the message,
- the sender of the message, who the message was sent to,
- which message(s) the message may be in reply to,
- and the message id.
- </remarks>
- </member>
- <member name="M:MailKit.Envelope.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Envelope"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Envelope"/>.
- </remarks>
- </member>
- <member name="P:MailKit.Envelope.From">
- <summary>
- Gets the address(es) that the message is from.
- </summary>
- <remarks>
- Gets the address(es) that the message is from.
- </remarks>
- <value>The address(es) that the message is from.</value>
- </member>
- <member name="P:MailKit.Envelope.Sender">
- <summary>
- Gets the actual sender(s) of the message.
- </summary>
- <remarks>
- The senders may differ from the addresses in <see cref="P:MailKit.Envelope.From"/> if
- the message was sent by someone on behalf of someone else.
- </remarks>
- <value>The actual sender(s) of the message.</value>
- </member>
- <member name="P:MailKit.Envelope.ReplyTo">
- <summary>
- Gets the address(es) that replies should be sent to.
- </summary>
- <remarks>
- The senders of the message may prefer that replies are sent
- somewhere other than the address they used to send the message.
- </remarks>
- <value>The address(es) that replies should be sent to.</value>
- </member>
- <member name="P:MailKit.Envelope.To">
- <summary>
- Gets the list of addresses that the message was sent to.
- </summary>
- <remarks>
- Gets the list of addresses that the message was sent to.
- </remarks>
- <value>The address(es) that the message was sent to.</value>
- </member>
- <member name="P:MailKit.Envelope.Cc">
- <summary>
- Gets the list of addresses that the message was carbon-copied to.
- </summary>
- <remarks>
- Gets the list of addresses that the message was carbon-copied to.
- </remarks>
- <value>The address(es) that the message was carbon-copied to.</value>
- </member>
- <member name="P:MailKit.Envelope.Bcc">
- <summary>
- Gets the list of addresses that the message was blind-carbon-copied to.
- </summary>
- <remarks>
- Gets the list of addresses that the message was blind-carbon-copied to.
- </remarks>
- <value>The address(es) that the message was carbon-copied to.</value>
- </member>
- <member name="P:MailKit.Envelope.InReplyTo">
- <summary>
- The Message-Id that the message is replying to.
- </summary>
- <remarks>
- The Message-Id that the message is replying to.
- </remarks>
- <value>The Message-Id that the message is replying to.</value>
- </member>
- <member name="P:MailKit.Envelope.Date">
- <summary>
- Gets the date that the message was sent on, if available.
- </summary>
- <remarks>
- Gets the date that the message was sent on, if available.
- </remarks>
- <value>The date the message was sent.</value>
- </member>
- <member name="P:MailKit.Envelope.MessageId">
- <summary>
- Gets the ID of the message, if available.
- </summary>
- <remarks>
- Gets the ID of the message, if available.
- </remarks>
- <value>The message identifier.</value>
- </member>
- <member name="P:MailKit.Envelope.Subject">
- <summary>
- Gets the subject of the message.
- </summary>
- <remarks>
- Gets the subject of the message.
- </remarks>
- <value>The subject.</value>
- </member>
- <member name="M:MailKit.Envelope.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.Envelope"/>.
- </summary>
- <remarks>
- <para>The returned string can be parsed by <see cref="M:MailKit.Envelope.TryParse(System.String,MailKit.Envelope@)"/>.</para>
- <note type="warning">The syntax of the string returned, while similar to IMAP's ENVELOPE syntax,
- is not completely compatible.</note>
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.Envelope"/>.</returns>
- </member>
- <member name="M:MailKit.Envelope.TryParse(System.String,MailKit.Envelope@)">
- <summary>
- Tries to parse the given text into a new <see cref="T:MailKit.Envelope"/> instance.
- </summary>
- <remarks>
- <para>Parses an Envelope value from the specified text.</para>
- <note type="warning">This syntax, while similar to IMAP's ENVELOPE syntax, is not
- completely compatible.</note>
- </remarks>
- <returns><c>true</c>, if the envelope was successfully parsed, <c>false</c> otherwise.</returns>
- <param name="text">The text to parse.</param>
- <param name="envelope">The parsed envelope.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="text"/> is <c>null</c>.
- </exception>
- </member>
- <member name="T:MailKit.FolderAccess">
- <summary>
- A folder access mode.
- </summary>
- <remarks>
- A folder access mode.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
- </example>
- </member>
- <member name="F:MailKit.FolderAccess.None">
- <summary>
- The folder is not open.
- </summary>
- </member>
- <member name="F:MailKit.FolderAccess.ReadOnly">
- <summary>
- The folder is read-only.
- </summary>
- </member>
- <member name="F:MailKit.FolderAccess.ReadWrite">
- <summary>
- The folder is read/write.
- </summary>
- </member>
- <member name="T:MailKit.FolderAttributes">
- <summary>
- Folder attributes as used by <see cref="P:MailKit.IMailFolder.Attributes"/>.
- </summary>
- <remarks>
- Folder attributes as used by <see cref="P:MailKit.IMailFolder.Attributes"/>.
- </remarks>
- </member>
- <member name="F:MailKit.FolderAttributes.None">
- <summary>
- The folder does not have any attributes.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.NoInferiors">
- <summary>
- It is not possible for any subfolders to exist under the folder.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.NoSelect">
- <summary>
- It is not possible to select the folder.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Marked">
- <summary>
- The folder has been marked as possibly containing new messages
- since the folder was last selected.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Unmarked">
- <summary>
- The folder does not contain any new messages since the folder
- was last selected.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.NonExistent">
- <summary>
- The folder does not exist, but is simply a place-holder.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Subscribed">
- <summary>
- The folder is subscribed.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Remote">
- <summary>
- The folder is remote.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.HasChildren">
- <summary>
- The folder has subfolders.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.HasNoChildren">
- <summary>
- The folder does not have any subfolders.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.All">
- <summary>
- The folder is a special "All" folder containing an aggregate of all messages.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Archive">
- <summary>
- The folder is a special "Archive" folder.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Drafts">
- <summary>
- The folder is the special "Drafts" folder.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Flagged">
- <summary>
- The folder is the special "Flagged" folder.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Inbox">
- <summary>
- The folder is the special "Inbox" folder.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Junk">
- <summary>
- The folder is the special "Junk" folder.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Sent">
- <summary>
- The folder is the special "Sent" folder.
- </summary>
- </member>
- <member name="F:MailKit.FolderAttributes.Trash">
- <summary>
- The folder is the special "Trash" folder.
- </summary>
- </member>
- <member name="T:MailKit.FolderCreatedEventArgs">
- <summary>
- Event args used when a <see cref="T:MailKit.IMailFolder"/> is created.
- </summary>
- <remarks>
- Event args used when a <see cref="T:MailKit.IMailFolder"/> is created.
- </remarks>
- </member>
- <member name="M:MailKit.FolderCreatedEventArgs.#ctor(MailKit.IMailFolder)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderCreatedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderCreatedEventArgs"/>.
- </remarks>
- <param name="folder">The newly created folder.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folder"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.FolderCreatedEventArgs.Folder">
- <summary>
- Get the folder that was just created.
- </summary>
- <remarks>
- Gets the folder that was just created.
- </remarks>
- <value>The folder.</value>
- </member>
- <member name="T:MailKit.FolderNamespace">
- <summary>
- A folder namespace.
- </summary>
- <remarks>
- A folder namespace.
- </remarks>
- </member>
- <member name="F:MailKit.FolderNamespace.DirectorySeparator">
- <summary>
- The directory separator for this folder namespace.
- </summary>
- <remarks>
- The directory separator for this folder namespace.
- </remarks>
- </member>
- <member name="F:MailKit.FolderNamespace.Path">
- <summary>
- The base path for this folder namespace.
- </summary>
- <remarks>
- The base path for this folder namespace.
- </remarks>
- </member>
- <member name="M:MailKit.FolderNamespace.#ctor(System.Char,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderNamespace"/> class.
- </summary>
- <remarks>
- Creates a new folder namespace.
- </remarks>
- <param name="directorySeparator">The directory separator.</param>
- <param name="path">The folder path.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="path"/> is <c>null</c>.
- </exception>
- </member>
- <member name="T:MailKit.FolderNamespaceCollection">
- <summary>
- A read-only collection of folder namespaces.
- </summary>
- <remarks>
- A read-only collection of folder namespaces.
- </remarks>
- </member>
- <member name="M:MailKit.FolderNamespaceCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderNamespaceCollection"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderNamespaceCollection"/>.
- </remarks>
- </member>
- <member name="P:MailKit.FolderNamespaceCollection.Count">
- <summary>
- Gets the number of folder namespaces contained in the collection.
- </summary>
- <remarks>
- Gets the number of folder namespaces contained in the collection.
- </remarks>
- <value>The count.</value>
- </member>
- <member name="M:MailKit.FolderNamespaceCollection.Add(MailKit.FolderNamespace)">
- <summary>
- Adds the specified namespace.
- </summary>
- <remarks>
- Adds the specified namespace.
- </remarks>
- <param name="namespace">The namespace to add.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.FolderNamespaceCollection.Clear">
- <summary>
- Removes all namespaces from the collection.
- </summary>
- <remarks>
- Removes all namespaces from the collection.
- </remarks>
- </member>
- <member name="M:MailKit.FolderNamespaceCollection.Contains(MailKit.FolderNamespace)">
- <summary>
- Checks if the collection contains the specified namespace.
- </summary>
- <remarks>
- Checks if the collection contains the specified namespace.
- </remarks>
- <returns><value>true</value> if the specified namespace exists;
- otherwise <value>false</value>.</returns>
- <param name="namespace">The namespace.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.FolderNamespaceCollection.Remove(MailKit.FolderNamespace)">
- <summary>
- Removes the first occurance of the specified namespace.
- </summary>
- <remarks>
- Removes the first occurance of the specified namespace.
- </remarks>
- <returns><value>true</value> if the frst occurance of the specified
- namespace was removed; otherwise <value>false</value>.</returns>
- <param name="namespace">The namespace.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.FolderNamespaceCollection.Item(System.Int32)">
- <summary>
- Gets the <see cref="T:MailKit.FolderNamespace"/> at the specified index.
- </summary>
- <remarks>
- Gets the <see cref="T:MailKit.FolderNamespace"/> at the specified index.
- </remarks>
- <value>The folder namespace at the specified index.</value>
- <param name="index">The index.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="value"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.FolderNamespaceCollection.GetEnumerator">
- <summary>
- Gets the enumerator.
- </summary>
- <remarks>
- Gets the enumerator.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.FolderNamespaceCollection.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Gets the enumerator.
- </summary>
- <remarks>
- Gets the enumerator.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.FolderNamespaceCollection.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.FolderNamespaceCollection"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.FolderNamespaceCollection"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.FolderNamespaceCollection"/>.</returns>
- </member>
- <member name="T:MailKit.FolderNotFoundException">
- <summary>
- The exception that is thrown when a folder could not be found.
- </summary>
- <remarks>
- This exception is thrown by <see cref="M:MailKit.IMailFolder.GetSubfolder(System.String,System.Threading.CancellationToken)"/>.
- </remarks>
- </member>
- <member name="M:MailKit.FolderNotFoundException.#ctor(System.String,System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderNotFoundException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderNotFoundException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="folderName">The name of the folder.</param>
- <param name="innerException">The inner exception.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folderName"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.FolderNotFoundException.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderNotFoundException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderNotFoundException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="folderName">The name of the folder.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folderName"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.FolderNotFoundException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderNotFoundException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderNotFoundException"/>.
- </remarks>
- <param name="folderName">The name of the folder.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folderName"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.FolderNotFoundException.FolderName">
- <summary>
- Gets the name of the folder that could not be found.
- </summary>
- <remarks>
- Gets the name of the folder that could not be found.
- </remarks>
- <value>The name of the folder.</value>
- </member>
- <member name="T:MailKit.FolderNotOpenException">
- <summary>
- The exception that is thrown when a folder is not open.
- </summary>
- <remarks>
- This exception is thrown when an operation on a folder could not be completed
- due to the folder being in a closed state. For example, the
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>
- method will throw a <see cref="T:MailKit.FolderNotOpenException"/> if the folder is not
- current open.
- </remarks>
- </member>
- <member name="M:MailKit.FolderNotOpenException.#ctor(System.String,MailKit.FolderAccess,System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderNotOpenException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderNotOpenException"/>.
- </remarks>
- <param name="folderName">The folder name.</param>
- <param name="access">The minimum folder access required by the operation.</param>
- <param name="message">The error message.</param>
- <param name="innerException">The inner exception.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folderName"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.FolderNotOpenException.#ctor(System.String,MailKit.FolderAccess,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderNotOpenException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderNotOpenException"/>.
- </remarks>
- <param name="folderName">The folder name.</param>
- <param name="access">The minimum folder access required by the operation.</param>
- <param name="message">The error message.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folderName"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.FolderNotOpenException.#ctor(System.String,MailKit.FolderAccess)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderNotOpenException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderNotOpenException"/>.
- </remarks>
- <param name="folderName">The folder name.</param>
- <param name="access">The minimum folder access required by the operation.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="folderName"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.FolderNotOpenException.FolderName">
- <summary>
- Get the name of the folder.
- </summary>
- <remarks>
- Gets the name of the folder.
- </remarks>
- <value>The name of the folder.</value>
- </member>
- <member name="P:MailKit.FolderNotOpenException.FolderAccess">
- <summary>
- Get the minimum folder access required by the operation.
- </summary>
- <remarks>
- Gets the minimum folder access required by the operation.
- </remarks>
- <value>The minimum required folder access.</value>
- </member>
- <member name="T:MailKit.FolderQuota">
- <summary>
- A folder quota.
- </summary>
- <remarks>
- A <see cref="T:MailKit.FolderQuota"/> is returned by <see cref="M:MailKit.IMailFolder.GetQuota(System.Threading.CancellationToken)"/>.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- </member>
- <member name="M:MailKit.FolderQuota.#ctor(MailKit.IMailFolder)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderQuota"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderQuota"/> with the specified root.
- </remarks>
- <param name="quotaRoot">The quota root.</param>
- </member>
- <member name="P:MailKit.FolderQuota.QuotaRoot">
- <summary>
- Get the quota root.
- </summary>
- <remarks>
- Gets the quota root. If the quota root is <c>null</c>, then
- it suggests that the folder does not have a quota.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The quota root.</value>
- </member>
- <member name="P:MailKit.FolderQuota.MessageLimit">
- <summary>
- Get or set the message limit.
- </summary>
- <remarks>
- Gets or sets the message limit.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The message limit.</value>
- </member>
- <member name="P:MailKit.FolderQuota.StorageLimit">
- <summary>
- Get or set the storage limit, in kilobytes.
- </summary>
- <remarks>
- Gets or sets the storage limit, in kilobytes.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The storage limit, in kilobytes.</value>
- </member>
- <member name="P:MailKit.FolderQuota.CurrentMessageCount">
- <summary>
- Get or set the current message count.
- </summary>
- <remarks>
- Gets or sets the current message count.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The current message count.</value>
- </member>
- <member name="P:MailKit.FolderQuota.CurrentStorageSize">
- <summary>
- Gets or sets the size of the current storage, in kilobytes.
- </summary>
- <remarks>
- Gets or sets the size of the current storage, in kilobytes.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The size of the current storage, in kilobytes.</value>
- </member>
- <member name="T:MailKit.FolderRenamedEventArgs">
- <summary>
- Event args used when a <see cref="T:MailKit.IMailFolder"/> is renamed.
- </summary>
- <remarks>
- Event args used when a <see cref="T:MailKit.IMailFolder"/> is renamed.
- </remarks>
- </member>
- <member name="M:MailKit.FolderRenamedEventArgs.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.FolderRenamedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.FolderRenamedEventArgs"/>.
- </remarks>
- <param name="oldName">The old name of the folder.</param>
- <param name="newName">The new name of the folder.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="oldName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="newName"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.FolderRenamedEventArgs.OldName">
- <summary>
- The old name of the folder.
- </summary>
- <remarks>
- The old name of the folder.
- </remarks>
- <value>The old name.</value>
- </member>
- <member name="P:MailKit.FolderRenamedEventArgs.NewName">
- <summary>
- The new name of the folder.
- </summary>
- <remarks>
- The new name of the folder.
- </remarks>
- <value>The new name.</value>
- </member>
- <member name="T:MailKit.IMailFolder">
- <summary>
- An interface for a mailbox folder as used by <see cref="T:MailKit.IMailStore"/>.
- </summary>
- <remarks>
- Implemented by message stores such as <see cref="T:MailKit.Net.Imap.ImapClient"/>
- </remarks>
- </member>
- <member name="P:MailKit.IMailFolder.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the folder.
- </summary>
- <remarks>
- Gets an object that can be used to synchronize access to the folder.
- </remarks>
- <value>The sync root.</value>
- </member>
- <member name="P:MailKit.IMailFolder.ParentFolder">
- <summary>
- Get the parent folder.
- </summary>
- <remarks>
- Root-level folders do not have a parent folder.
- </remarks>
- <value>The parent folder.</value>
- </member>
- <member name="P:MailKit.IMailFolder.Attributes">
- <summary>
- Get the folder attributes.
- </summary>
- <remarks>
- Gets the folder attributes.
- </remarks>
- <value>The folder attributes.</value>
- </member>
- <member name="P:MailKit.IMailFolder.AnnotationAccess">
- <summary>
- Get the annotation access level.
- </summary>
- <remarks>
- If annotations are supported, this property can be used to determine whether or not
- the <see cref="T:MailKit.IMailFolder"/> supports reading and writing annotations.
- </remarks>
- </member>
- <member name="P:MailKit.IMailFolder.AnnotationScopes">
- <summary>
- Get the supported annotation scopes.
- </summary>
- <remarks>
- If annotations are supported, this property can be used to determine which
- annotation scopes are supported by the <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="P:MailKit.IMailFolder.MaxAnnotationSize">
- <summary>
- Get the maximum size of annotation values supported by the folder.
- </summary>
- <remarks>
- If annotations are supported, this property can be used to determine the
- maximum size of annotation values supported by the <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="P:MailKit.IMailFolder.PermanentFlags">
- <summary>
- Get the permanent flags.
- </summary>
- <remarks>
- <para>The permanent flags are the message flags that will persist between sessions.</para>
- <para>If the <see cref="F:MailKit.MessageFlags.UserDefined"/> flag is set, then the folder allows
- storing of user-defined (custom) message flags.</para>
- </remarks>
- <value>The permanent flags.</value>
- </member>
- <member name="P:MailKit.IMailFolder.AcceptedFlags">
- <summary>
- Get the accepted flags.
- </summary>
- <remarks>
- The accepted flags are the message flags that will be accepted and persist
- for the current session. For the set of flags that will persist between
- sessions, see the <see cref="P:MailKit.IMailFolder.PermanentFlags"/> property.
- </remarks>
- <value>The accepted flags.</value>
- </member>
- <member name="P:MailKit.IMailFolder.DirectorySeparator">
- <summary>
- Get the directory separator.
- </summary>
- <remarks>
- Gets the directory separator.
- </remarks>
- <value>The directory separator.</value>
- </member>
- <member name="P:MailKit.IMailFolder.Access">
- <summary>
- Get the read/write access of the folder.
- </summary>
- <remarks>
- Gets the read/write access of the folder.
- </remarks>
- <value>The read/write access.</value>
- </member>
- <member name="P:MailKit.IMailFolder.IsNamespace">
- <summary>
- Get whether or not the folder is a namespace folder.
- </summary>
- <remarks>
- Gets whether or not the folder is a namespace folder.
- </remarks>
- <value><c>true</c> if the folder is a namespace folder; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailFolder.FullName">
- <summary>
- Get the full name of the folder.
- </summary>
- <remarks>
- This is the equivalent of the full path of a file on a file system.
- </remarks>
- <value>The full name of the folder.</value>
- </member>
- <member name="P:MailKit.IMailFolder.Name">
- <summary>
- Get the name of the folder.
- </summary>
- <remarks>
- This is the equivalent of the file name of a file on the file system.
- </remarks>
- <value>The name of the folder.</value>
- </member>
- <member name="P:MailKit.IMailFolder.Id">
- <summary>
- Get the unique identifier for the folder, if available.
- </summary>
- <remarks>
- <para>Gets a unique identifier for the folder, if available. This is useful for clients
- implementing a message cache that want to track the folder after it is renamed by another
- client.</para>
- <note type="note">This property will only be available if the server supports the
- <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
- </remarks>
- <value>The unique folder identifier.</value>
- </member>
- <member name="P:MailKit.IMailFolder.IsSubscribed">
- <summary>
- Get whether or not the folder is subscribed.
- </summary>
- <remarks>
- Gets whether or not the folder is subscribed.
- </remarks>
- <value><c>true</c> if the folder is subscribed; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailFolder.IsOpen">
- <summary>
- Get whether or not the folder is currently open.
- </summary>
- <remarks>
- Gets whether or not the folder is currently open.
- </remarks>
- <value><c>true</c> if the folder is currently open; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailFolder.Exists">
- <summary>
- Get whether or not the folder exists.
- </summary>
- <remarks>
- Gets whether or not the folder exists.
- </remarks>
- <value><c>true</c> if the folder exists; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailFolder.SupportsModSeq">
- <summary>
- Get whether or not the folder supports mod-sequences.
- </summary>
- <remarks>
- If mod-sequences are not supported by the folder, then all of the APIs that take a modseq
- argument will throw <see cref="T:System.NotSupportedException"/> and should not be used.
- </remarks>
- <value><c>true</c> if supports mod-sequences; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailFolder.HighestModSeq">
- <summary>
- Get the highest mod-sequence value of all messages in the mailbox.
- </summary>
- <remarks>
- Gets the highest mod-sequence value of all messages in the mailbox.
- </remarks>
- <value>The highest mod-sequence value.</value>
- </member>
- <member name="P:MailKit.IMailFolder.UidValidity">
- <summary>
- Get the Unique ID validity.
- </summary>
- <remarks>
- <para>UIDs are only valid so long as the UID validity value remains unchanged. If and when
- the folder's <see cref="P:MailKit.IMailFolder.UidValidity"/> is changed, a client MUST discard its cache of UIDs
- along with any summary information that it may have and re-query the folder.</para>
- <para>The <see cref="P:MailKit.IMailFolder.UidValidity"/> will only be set after the folder has been opened.</para>
- </remarks>
- <value>The UID validity.</value>
- </member>
- <member name="P:MailKit.IMailFolder.UidNext">
- <summary>
- Get the UID that the next message that is added to the folder will be assigned.
- </summary>
- <remarks>
- This value will only be set after the folder has been opened.
- </remarks>
- <value>The next UID.</value>
- </member>
- <member name="P:MailKit.IMailFolder.AppendLimit">
- <summary>
- Get the maximum size of a message that can be appended to the folder.
- </summary>
- <remarks>
- <para>Gets the maximum size of a message that can be appended to the folder.</para>
- <note type="note">If the value is not set, then the limit is unspecified.</note>
- </remarks>
- <value>The append limit.</value>
- </member>
- <member name="P:MailKit.IMailFolder.Size">
- <summary>
- Get the size of the folder.
- </summary>
- <remarks>
- <para>Gets the size of the folder in bytes.</para>
- <note type="note">If the value is not set, then the size is unspecified.</note>
- </remarks>
- <value>The size.</value>
- </member>
- <member name="P:MailKit.IMailFolder.FirstUnread">
- <summary>
- Get the index of the first unread message in the folder.
- </summary>
- <remarks>
- This value will only be set after the folder has been opened.
- </remarks>
- <value>The index of the first unread message.</value>
- </member>
- <member name="P:MailKit.IMailFolder.Unread">
- <summary>
- Get the number of unread messages in the folder.
- </summary>
- <remarks>
- <para>Gets the number of unread messages in the folder.</para>
- <note type="note">This value will only be set after calling
- <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- with <see cref="F:MailKit.StatusItems.Unread"/>.</note>
- </remarks>
- <value>The number of unread messages.</value>
- </member>
- <member name="P:MailKit.IMailFolder.Recent">
- <summary>
- Get the number of recently delivered messages in the folder.
- </summary>
- <remarks>
- <para>Gets the number of recently delivered messages in the folder.</para>
- <note type="note">
- This value will only be set after calling
- <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- with <see cref="F:MailKit.StatusItems.Recent"/>.</note>
- </remarks>
- <value>The number of recently delivered messages.</value>
- </member>
- <member name="P:MailKit.IMailFolder.Count">
- <summary>
- Get the total number of messages in the folder.
- </summary>
- <remarks>
- Gets the total number of messages in the folder.
- </remarks>
- <value>The total number of messages.</value>
- </member>
- <member name="M:MailKit.IMailFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Opens the folder using the requested folder access.
- </summary>
- <remarks>
- <para>This variant of the <see cref="M:MailKit.IMailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- method is meant for quick resynchronization of the folder. Before calling this method,
- the <see cref="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method MUST be called.</para>
- <para>You should also make sure to add listeners to the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> and
- <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events to get notifications of changes since
- the last time the folder was opened.</para>
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="uidValidity">The last known <see cref="P:MailKit.IMailFolder.UidValidity"/> value.</param>
- <param name="highestModSeq">The last known <see cref="P:MailKit.IMailFolder.HighestModSeq"/> value.</param>
- <param name="uids">The last known list of unique message identifiers.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.OpenAsync(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously opens the folder using the requested folder access.
- </summary>
- <remarks>
- <para>This variant of the <see cref="M:MailKit.IMailFolder.OpenAsync(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- method is meant for quick resynchronization of the folder. Before calling this method,
- the <see cref="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method MUST be called.</para>
- <para>You should also make sure to add listeners to the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> and
- <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events to get notifications of changes since
- the last time the folder was opened.</para>
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="uidValidity">The last known <see cref="P:MailKit.IMailFolder.UidValidity"/> value.</param>
- <param name="highestModSeq">The last known <see cref="P:MailKit.IMailFolder.HighestModSeq"/> value.</param>
- <param name="uids">The last known list of unique message identifiers.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)">
- <summary>
- Open the folder using the requested folder access.
- </summary>
- <remarks>
- Opens the folder using the requested folder access.
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.OpenAsync(MailKit.FolderAccess,System.Threading.CancellationToken)">
- <summary>
- Asynchronously open the folder using the requested folder access.
- </summary>
- <remarks>
- Asynchronously opens the folder using the requested folder access.
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Close(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Close the folder, optionally expunging the messages marked for deletion.
- </summary>
- <remarks>
- Closes the folder, optionally expunging the messages marked for deletion.
- </remarks>
- <param name="expunge">If set to <c>true</c>, expunge.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CloseAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously close the folder, optionally expunging the messages marked for deletion.
- </summary>
- <remarks>
- Asynchronously closes the folder, optionally expunging the messages marked for deletion.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="expunge">If set to <c>true</c>, expunge.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Create(System.String,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="isMessageFolder"><c>true</c> if the folder will be used to contain messages; otherwise <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CreateAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously create a new subfolder with the given name.
- </summary>
- <remarks>
- Asynchronously creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="isMessageFolder"><c>true</c> if the folder will be used to contain messages; otherwise <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Create(System.String,System.Collections.Generic.IEnumerable{MailKit.SpecialFolder},System.Threading.CancellationToken)">
- <summary>
- Create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUses">A list of special uses for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CreateAsync(System.String,System.Collections.Generic.IEnumerable{MailKit.SpecialFolder},System.Threading.CancellationToken)">
- <summary>
- Asynchronously create a new subfolder with the given name.
- </summary>
- <remarks>
- Asynchronously creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUses">A list of special uses for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Create(System.String,MailKit.SpecialFolder,System.Threading.CancellationToken)">
- <summary>
- Create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUse">The special use for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CreateAsync(System.String,MailKit.SpecialFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously create a new subfolder with the given name.
- </summary>
- <remarks>
- Asynchronously creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUse">The special use for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Rename(MailKit.IMailFolder,System.String,System.Threading.CancellationToken)">
- <summary>
- Rename the folder.
- </summary>
- <remarks>
- Renames the folder.
- </remarks>
- <param name="parent">The new parent folder.</param>
- <param name="name">The new name of the folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RenameAsync(MailKit.IMailFolder,System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously rename the folder.
- </summary>
- <remarks>
- Asynchronously renames the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="parent">The new parent folder.</param>
- <param name="name">The new name of the folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Delete(System.Threading.CancellationToken)">
- <summary>
- Delete the folder.
- </summary>
- <remarks>
- Deletes the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.DeleteAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously delete the folder.
- </summary>
- <remarks>
- Asynchronously deletes the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Subscribe(System.Threading.CancellationToken)">
- <summary>
- Subscribe to the folder.
- </summary>
- <remarks>
- Subscribes to the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SubscribeAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously subscribe to the folder.
- </summary>
- <remarks>
- Asynchronously subscribes to the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Unsubscribe(System.Threading.CancellationToken)">
- <summary>
- Unsubscribe from the folder.
- </summary>
- <remarks>
- Unsubscribes from the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.UnsubscribeAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously unsubscribe from the folder.
- </summary>
- <remarks>
- Asynchronously unsubscribes from the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetSubfolders(MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get the subfolders.
- </summary>
- <remarks>
- <para>Gets the subfolders as well as queries the server for the status of the requested items.</para>
- <para>When the <paramref name="items"/> argument is non-empty, this has the equivalent functionality
- of calling <see cref="M:MailKit.IMailFolder.GetSubfolders(System.Boolean,System.Threading.CancellationToken)"/> and then calling
- <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> on each of the returned folders.</para>
- <note type="tip">Using this method is potentially more efficient than querying the status of each returned folder.</note>
- </remarks>
- <returns>The subfolders.</returns>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetSubfoldersAsync(MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the subfolders.
- </summary>
- <remarks>
- <para>Asynchronously gets the subfolders as well as queries the server for the status of the requested items.</para>
- <para>When the <paramref name="items"/> argument is non-empty, this has the equivalent functionality
- of calling <see cref="M:MailKit.IMailFolder.GetSubfoldersAsync(System.Boolean,System.Threading.CancellationToken)"/> and then calling
- <see cref="M:MailKit.IMailFolder.StatusAsync(MailKit.StatusItems,System.Threading.CancellationToken)"/> on each of the returned folders.</para>
- </remarks>
- <returns>The subfolders.</returns>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetSubfolders(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get the subfolders.
- </summary>
- <remarks>
- Gets the subfolders.
- </remarks>
- <returns>The subfolders.</returns>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetSubfoldersAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the subfolders.
- </summary>
- <remarks>
- Asynchronously gets the subfolders.
- </remarks>
- <returns>The subfolders.</returns>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetSubfolder(System.String,System.Threading.CancellationToken)">
- <summary>
- Get the specified subfolder.
- </summary>
- <remarks>
- Gets the specified subfolder.
- </remarks>
- <returns>The subfolder.</returns>
- <param name="name">The name of the subfolder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetSubfolderAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the specified subfolder.
- </summary>
- <remarks>
- Asynchronously gets the specified subfolder.
- </remarks>
- <returns>The subfolder.</returns>
- <param name="name">The name of the subfolder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Check(System.Threading.CancellationToken)">
- <summary>
- Force the server to flush its state for the folder.
- </summary>
- <remarks>
- Forces the server to flush its state for the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CheckAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously force the server to flush its state for the folder.
- </summary>
- <remarks>
- Asynchronously forces the server to flush its state for the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)">
- <summary>
- Update the values of the specified items.
- </summary>
- <remarks>
- <para>Updates the values of the specified items.</para>
- <para>The <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> method
- MUST NOT be used on a folder that is already in the opened state. Instead, other ways
- of getting the desired information should be used.</para>
- <para>For example, a common use for the <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- method is to get the number of unread messages in the folder. When the folder is open, however, it is
- possible to use the <see cref="M:MailKit.IMailFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)"/>
- method to query for the list of unread messages.</para>
- </remarks>
- <param name="items">The items to update.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.StatusAsync(MailKit.StatusItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously update the values of the specified items.
- </summary>
- <remarks>
- <para>Updates the values of the specified items.</para>
- <para>The <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> method
- MUST NOT be used on a folder that is already in the opened state. Instead, other ways
- of getting the desired information should be used.</para>
- <para>For example, a common use for the <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- method is to get the number of unread messages in the folder. When the folder is open, however, it is
- possible to use the <see cref="M:MailKit.IMailFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)"/>
- method to query for the list of unread messages.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="items">The items to update.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetAccessControlList(System.Threading.CancellationToken)">
- <summary>
- Get the complete access control list for the folder.
- </summary>
- <remarks>
- Gets the complete access control list for the folder.
- </remarks>
- <returns>The access control list.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetAccessControlListAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the complete access control list for the folder.
- </summary>
- <remarks>
- Asynchronously gets the complete access control list for the folder.
- </remarks>
- <returns>The access control list.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetAccessRights(System.String,System.Threading.CancellationToken)">
- <summary>
- Get the access rights for a particular identifier.
- </summary>
- <remarks>
- Gets the access rights for a particular identifier.
- </remarks>
- <returns>The access rights.</returns>
- <param name="name">The identifier name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetAccessRightsAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the access rights for a particular identifier.
- </summary>
- <remarks>
- Asynchronously gets the access rights for a particular identifier.
- </remarks>
- <returns>The access rights.</returns>
- <param name="name">The identifier name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMyAccessRights(System.Threading.CancellationToken)">
- <summary>
- Get the access rights for the current authenticated user.
- </summary>
- <remarks>
- Gets the access rights for the current authenticated user.
- </remarks>
- <returns>The access rights.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMyAccessRightsAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the access rights for the current authenticated user.
- </summary>
- <remarks>
- Asynchronously gets the access rights for the current authenticated user.
- </remarks>
- <returns>The access rights.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Add access rights for the specified identity.
- </summary>
- <remarks>
- Adds the given access rights for the specified identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add access rights for the specified identity.
- </summary>
- <remarks>
- Asynchronously adds the given access rights for the specified identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Remove access rights for the specified identity.
- </summary>
- <remarks>
- Removes the given access rights for the specified identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove access rights for the specified identity.
- </summary>
- <remarks>
- Asynchronously removes the given access rights for the specified identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Set the access rights for the specified identity.
- </summary>
- <remarks>
- Sets the access rights for the specified identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the access rights for the sepcified identity.
- </summary>
- <remarks>
- Asynchronously sets the access rights for the specified identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveAccess(System.String,System.Threading.CancellationToken)">
- <summary>
- Remove all access rights for the given identity.
- </summary>
- <remarks>
- Removes all access rights for the given identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveAccessAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove all access rights for the given identity.
- </summary>
- <remarks>
- Asynchronously removes all access rights for the given identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetQuota(System.Threading.CancellationToken)">
- <summary>
- Get the quota information for the folder.
- </summary>
- <remarks>
- <para>Gets the quota information for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The folder quota.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetQuotaAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the quota information for the folder.
- </summary>
- <remarks>
- <para>Asynchronously gets the quota information for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The folder quota.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetQuota(System.Nullable{System.UInt32},System.Nullable{System.UInt32},System.Threading.CancellationToken)">
- <summary>
- Set the quota limits for the folder.
- </summary>
- <remarks>
- <para>Sets the quota limits for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The updated folder quota.</returns>
- <param name="messageLimit">If not <c>null</c>, sets the maximum number of messages to allow.</param>
- <param name="storageLimit">If not <c>null</c>, sets the maximum storage size (in kilobytes).</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetQuotaAsync(System.Nullable{System.UInt32},System.Nullable{System.UInt32},System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the quota limits for the folder.
- </summary>
- <remarks>
- <para>Asynchronously sets the quota limits for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The updated folder quota.</returns>
- <param name="messageLimit">If not <c>null</c>, sets the maximum number of messages to allow.</param>
- <param name="storageLimit">If not <c>null</c>, sets the maximum storage size (in kilobytes).</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMetadata(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMetadataAsync(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMetadata(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMetadataAsync(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMetadata(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMetadataAsync(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetMetadata(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Sets the specified metadata.
- </summary>
- <remarks>
- Sets the specified metadata.
- </remarks>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetMetadataAsync(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sets the specified metadata.
- </summary>
- <remarks>
- Asynchronously sets the specified metadata.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Expunge(System.Threading.CancellationToken)">
- <summary>
- Expunge the folder, permanently removing all messages marked for deletion.
- </summary>
- <remarks>
- <para>Expunges the folder, permanently removing all messages marked for deletion.</para>
- <note type="note">Normally, an <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event will be emitted for each
- message that is expunged. However, if the mail store supports the quick
- resynchronization feature and it has been enabled via the
- <see cref="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
- the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> event will be emitted rather than the
- <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.ExpungeAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously expunge the folder, permanently removing all messages marked for deletion.
- </summary>
- <remarks>
- <para>Asynchronously expunges the folder, permanently removing all messages marked for deletion.</para>
- <note type="note">Normally, an <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event will be emitted for
- each message that is expunged. However, if the mail store supports the quick
- resynchronization feature and it has been enabled via the
- <see cref="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
- the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> event will be emitted rather than the
- <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Expunge(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Expunge the specified uids, permanently removing them from the folder.
- </summary>
- <remarks>
- <para>Expunges the specified uids, permanently removing them from the folder.</para>
- <note type="note">Normally, an <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event will be emitted for
- each message that is expunged. However, if the mail store supports the quick
- resynchronization feature and it has been enabled via the
- <see cref="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
- the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> event will be emitted rather than the
- <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <param name="uids">The message uids.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.ExpungeAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously expunge the specified uids, permanently removing them from the folder.
- </summary>
- <remarks>
- <para>Asynchronously expunges the specified uids, permanently removing them from the folder.</para>
- <note type="note">Normally, an <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event will be emitted for
- each message that is expunged. However, if the mail store supports the quick
- resynchronization feature and it has been enabled via the
- <see cref="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
- the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> event will be emitted rather than the
- <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The message uids.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Append(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The list of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CopyTo(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified message to the destination folder.
- </summary>
- <remarks>
- Copies the specified message to the destination folder.
- </remarks>
- <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
- <param name="uid">The UID of the message to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CopyToAsync(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified message to the destination folder.
- </summary>
- <remarks>
- Asynchronously copies the specified message to the destination folder.
- </remarks>
- <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
- <param name="uid">The UID of the message to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CopyTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Copies the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CopyToAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Asynchronously copies the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.MoveTo(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified message to the destination folder.
- </summary>
- <remarks>
- Moves the specified message to the destination folder.
- </remarks>
- <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
- <param name="uid">The UID of the message to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.MoveToAsync(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified message to the destination folder.
- </summary>
- <remarks>
- Asynchronously moves the specified message to the destination folder.
- </remarks>
- <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
- <param name="uid">The UID of the message to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.MoveTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified messages to the destination folder.
- </summary>
- <remarks>
- Moves the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.MoveToAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified messages to the destination folder.
- </summary>
- <remarks>
- Asynchronously moves the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CopyTo(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified message to the destination folder.
- </summary>
- <remarks>
- Copies the specified message to the destination folder.
- </remarks>
- <param name="index">The index of the message to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CopyToAsync(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified message to the destination folder.
- </summary>
- <remarks>
- Asynchronously copies the specified message to the destination folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The indexes of the message to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CopyTo(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Copies the specified messages to the destination folder.
- </remarks>
- <param name="indexes">The indexes of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.CopyToAsync(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Asynchronously copies the specified messages to the destination folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.MoveTo(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified message to the destination folder.
- </summary>
- <remarks>
- Moves the specified message to the destination folder.
- </remarks>
- <param name="index">The index of the message to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.MoveToAsync(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified message to the destination folder.
- </summary>
- <remarks>
- Asynchronously moves the specified message to the destination folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.MoveTo(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified messages to the destination folder.
- </summary>
- <remarks>
- Moves the specified messages to the destination folder.
- </remarks>
- <param name="indexes">The indexes of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.MoveToAsync(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified messages to the destination folder.
- </summary>
- <remarks>
- Asynchronously moves the specified messages to the destination folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.IMailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.IMailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.IMailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.IMailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.IMailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.IMailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes that have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes that have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes that have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes
- (inclusive) that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes (inclusive) that have a higher mod-sequence value than the
- one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes
- (inclusive) that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes (inclusive) that have a higher mod-sequence value than the
- one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes
- (inclusive) that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes (inclusive) that have a higher mod-sequence value than the
- one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetHeaders(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message headers.
- </summary>
- <remarks>
- Gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetHeadersAsync(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message headers.
- </summary>
- <remarks>
- Asynchronously gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetHeaders(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetHeadersAsync(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Asynchronously gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetHeaders(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message headers.
- </summary>
- <remarks>
- Gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetHeadersAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message headers.
- </summary>
- <remarks>
- Asynchronously gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetHeaders(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetHeadersAsync(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Asynchronously gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message.
- </summary>
- <remarks>
- Gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMessageAsync(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message.
- </summary>
- <remarks>
- Asynchronously gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message.
- </summary>
- <remarks>
- Gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetMessageAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message.
- </summary>
- <remarks>
- Asynchronously gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetBodyPart(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetBodyPartAsync(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Asynchronously gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetBodyPart(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetBodyPartAsync(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Asynchronously gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStream(MailKit.UniqueId,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- Gets a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStreamAsync(MailKit.UniqueId,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- Asynchronously gets a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStream(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- Gets a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStreamAsync(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- Asynchronously gets a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStream(MailKit.UniqueId,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified body part.
- </summary>
- <remarks>
- Gets a substream of the body part. If the starting offset is beyond
- the end of the body part, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the body part, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The desired body part.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStreamAsync(MailKit.UniqueId,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified body part.
- </summary>
- <remarks>
- Asynchronously gets a substream of the body part. If the starting offset is beyond
- the end of the body part, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the body part, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The desired body part.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStream(System.Int32,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified body part.
- </summary>
- <remarks>
- Gets a substream of the body part. If the starting offset is beyond
- the end of the body part, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the body part, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The desired body part.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStreamAsync(System.Int32,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified body part.
- </summary>
- <remarks>
- Asynchronously gets a substream of the body part. If the starting offset is beyond
- the end of the body part, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the body part, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The desired body part.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStream(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStreamAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- <para>Asynchronously gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStream(MailKit.UniqueId,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message. If the starting offset is beyond
- the end of the specified section of the message, an empty stream is returned. If
- the number of bytes desired extends beyond the end of the section, a truncated
- stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStreamAsync(MailKit.UniqueId,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- <para>Asynchronously gets a substream of the specified message. If the starting
- offset is beyond the end of the specified section of the message, an empty stream
- is returned. If the number of bytes desired extends beyond the end of the section,
- a truncated stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStream(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStreamAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- <para>Asynchronously gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStream(System.Int32,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message. If the starting offset is beyond
- the end of the specified section of the message, an empty stream is returned. If
- the number of bytes desired extends beyond the end of the section, a truncated
- stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.GetStreamAsync(System.Int32,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- <para>Asynchronously gets a substream of the specified message. If the starting
- offset is beyond the end of the specified section of the message, an empty stream
- is returned. If the number of bytes desired extends beyond the end of the section,
- a truncated stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified message.
- </summary>
- <remarks>
- Adds a set of flags to the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UIDs of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified message.
- </summary>
- <remarks>
- Adds a set of flags to the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UIDs of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified message.
- </summary>
- <remarks>
- Removes a set of flags from the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified message.
- </summary>
- <remarks>
- Removes a set of flags from the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified message.
- </summary>
- <remarks>
- Sets the flags of the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified message.
- </summary>
- <remarks>
- Sets the flags of the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified message.
- </summary>
- <remarks>
- Adds a set of flags to the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified message.
- </summary>
- <remarks>
- Adds a set of flags to the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified message.
- </summary>
- <remarks>
- Removes a set of flags from the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified message.
- </summary>
- <remarks>
- Removes a set of flags from the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified message.
- </summary>
- <remarks>
- Sets the flags of the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified message.
- </summary>
- <remarks>
- Sets the flags of the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabels(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified message.
- </summary>
- <remarks>
- Adds a set of labels to the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabelsAsync(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UIDs of the message.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabels(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified message.
- </summary>
- <remarks>
- Removes a set of labels from the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabelsAsync(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabels(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified message.
- </summary>
- <remarks>
- Sets the labels of the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabelsAsync(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages.
- </summary>
- <remarks>
- Sets the labels of the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabels(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified message.
- </summary>
- <remarks>
- Adds a set of labels to the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabelsAsync(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabels(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified message.
- </summary>
- <remarks>
- Removes a set of labels from the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabelsAsync(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabels(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified message.
- </summary>
- <remarks>
- Sets the labels of the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabelsAsync(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages.
- </summary>
- <remarks>
- Sets the labels of the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.AddLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SetLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Store(MailKit.UniqueId,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified message.
- </summary>
- <remarks>
- Stores the annotations for the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.StoreAsync(MailKit.UniqueId,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified message.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Store(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages.
- </summary>
- <remarks>
- Stores the annotations for the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.StoreAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Store(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.StoreAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Store(System.Int32,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified message.
- </summary>
- <remarks>
- Stores the annotations for the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.StoreAsync(System.Int32,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified message.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The indexes of the message.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Store(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages.
- </summary>
- <remarks>
- Stores the annotations for the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.StoreAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Store(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.StoreAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.s
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SearchAsync(MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Search(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the subset of UIDs in the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SearchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the subset of UIDs in the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Search(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SearchAsync(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Asynchronously searches the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Search(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the subset of UIDs in the folder for messages matching the specified query.
- </summary>
- <remarks>
- Searches the fsubset of UIDs in the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SearchAsync(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the subset of UIDs in the folder for messages matching the specified query.
- </summary>
- <remarks>
- Asynchronously searches the fsubset of UIDs in the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Sort(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SortAsync(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Sort(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SortAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Sort(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SortAsync(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- Asynchronously searches the folder for messages matching the specified query, returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Sort(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.SortAsync(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- Asynchronously searches the folder for messages matching the specified query,
- returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Thread(MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.ThreadAsync(MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.Thread(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailFolder.ThreadAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="E:MailKit.IMailFolder.Opened">
- <summary>
- Occurs when the folder is opened.
- </summary>
- <remarks>
- Emitted when the folder is opened.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.Closed">
- <summary>
- Occurs when the folder is closed.
- </summary>
- <remarks>
- Emitted when the folder is closed.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.Deleted">
- <summary>
- Occurs when the folder is deleted.
- </summary>
- <remarks>
- Emitted when the folder is deleted.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.Renamed">
- <summary>
- Occurs when the folder is renamed.
- </summary>
- <remarks>
- Emitted when the folder is renamed.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.Subscribed">
- <summary>
- Occurs when the folder is subscribed.
- </summary>
- <remarks>
- Emitted when the folder is subscribed.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.Unsubscribed">
- <summary>
- Occurs when the folder is unsubscribed.
- </summary>
- <remarks>
- Emitted when the folder is unsubscribed.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.MessageExpunged">
- <summary>
- Occurs when a message is expunged from the folder.
- </summary>
- <remarks>
- Emitted when a message is expunged from the folder.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- </member>
- <member name="E:MailKit.IMailFolder.MessagesVanished">
- <summary>
- Occurs when messages vanish from the folder.
- </summary>
- <remarks>
- Emitted when a messages vanish from the folder.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.MessageFlagsChanged">
- <summary>
- Occurs when flags changed on a message.
- </summary>
- <remarks>
- Emitted when flags changed on a message.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- </member>
- <member name="E:MailKit.IMailFolder.MessageLabelsChanged">
- <summary>
- Occurs when labels changed on a message.
- </summary>
- <remarks>
- Emitted when labels changed on a message.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.AnnotationsChanged">
- <summary>
- Occurs when annotations changed on a message.
- </summary>
- <remarks>
- Emitted when annotations changed on a message.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.MessageSummaryFetched">
- <summary>
- Occurs when a message summary is fetched from the folder.
- </summary>
- <remarks>
- <para>Emitted when a message summary is fetched from the folder.</para>
- <para>When multiple message summaries are being fetched from a remote folder,
- it is possible that the connection will drop or some other exception will
- occur, causing the Fetch method to fail, requiring the client to request the
- same set of message summaries again after it reconnects. This is obviously
- inefficient. To alleviate this potential problem, this event will be emitted
- as soon as the <see cref="T:MailKit.IMailFolder"/> successfully retrieves the complete
- <see cref="T:MailKit.IMessageSummary"/> for each requested message.</para>
- <note type="note">The <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- methods will return a list of all message summaries that any information was
- retrieved for, regardless of whether or not all of the requested items were fetched,
- therefore there may be a discrepency between the number of times this event is
- emitetd and the number of summary items returned from the Fetch method.</note>
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.MetadataChanged">
- <summary>
- Occurs when metadata changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.IMailFolder.MetadataChanged"/> event is emitted when metadata changes.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.ModSeqChanged">
- <summary>
- Occurs when the mod-sequence changed on a message.
- </summary>
- <remarks>
- Emitted when the mod-sequence changed on a message.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.HighestModSeqChanged">
- <summary>
- Occurs when the highest mod-sequence changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.IMailFolder.HighestModSeqChanged"/> event is emitted whenever the <see cref="P:MailKit.IMailFolder.HighestModSeq"/> value changes.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.UidNextChanged">
- <summary>
- Occurs when the next UID changes.
- </summary>
- <remarks>
- Emitted when the <see cref="P:MailKit.IMailFolder.UidNext"/> property changes.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.UidValidityChanged">
- <summary>
- Occurs when the UID validity changes.
- </summary>
- <remarks>
- Emitted when the <see cref="P:MailKit.IMailFolder.UidValidity"/> property changes.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.IdChanged">
- <summary>
- Occurs when the ID changes.
- </summary>
- <remarks>
- Emitted when the <see cref="P:MailKit.IMailFolder.Id"/> property changes.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.SizeChanged">
- <summary>
- Occurs when the size of the folder changes.
- </summary>
- <remarks>
- Emitted when the <see cref="P:MailKit.IMailFolder.Size"/> property changes.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.CountChanged">
- <summary>
- Occurs when the message count changes.
- </summary>
- <remarks>
- Emitted when the <see cref="P:MailKit.IMailFolder.Count"/> property changes.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- </member>
- <member name="E:MailKit.IMailFolder.RecentChanged">
- <summary>
- Occurs when the recent message count changes.
- </summary>
- <remarks>
- Emitted when the <see cref="P:MailKit.IMailFolder.Recent"/> property changes.
- </remarks>
- </member>
- <member name="E:MailKit.IMailFolder.UnreadChanged">
- <summary>
- Occurs when the message unread count changes.
- </summary>
- <remarks>
- Emitted when the <see cref="P:MailKit.IMailFolder.Unread"/> property changes.
- </remarks>
- </member>
- <member name="T:MailKit.IMailService">
- <summary>
- An interface for message services such as SMTP, POP3, or IMAP.
- </summary>
- <remarks>
- Implemented by <see cref="T:MailKit.Net.Smtp.SmtpClient"/>
- and <see cref="T:MailKit.Net.Pop3.Pop3Client"/>.
- </remarks>
- </member>
- <member name="P:MailKit.IMailService.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the folder.
- </summary>
- <remarks>
- Gets an object that can be used to synchronize access to the folder.
- </remarks>
- <value>The sync root.</value>
- </member>
- <member name="P:MailKit.IMailService.SslProtocols">
- <summary>
- Gets or sets the SSL and TLS protocol versions that the client is allowed to use.
- </summary>
- <remarks>
- <para>Gets or sets the SSL and TLS protocol versions that the client is allowed to use.</para>
- <para>By default, MailKit initializes this value to support only TLS v1.0 and greater and
- does not support any version of SSL due to those protocols no longer being considered
- secure.</para>
- <para>This property should be set before calling any of the
- <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a> methods.</para>
- </remarks>
- <value>The SSL and TLS protocol versions that are supported.</value>
- </member>
- <member name="P:MailKit.IMailService.ClientCertificates">
- <summary>
- Get or set the client SSL certificates.
- </summary>
- <remarks>
- <para>Some servers may require the client SSL certificates in order
- to allow the user to connect.</para>
- <para>This property should be set before calling any of the
- <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a> methods.</para>
- </remarks>
- <value>The client SSL certificates.</value>
- </member>
- <member name="P:MailKit.IMailService.CheckCertificateRevocation">
- <summary>
- Get or set whether connecting via SSL/TLS should check certificate revocation.
- </summary>
- <remarks>
- <para>Gets or sets whether connecting via SSL/TLS should check certificate revocation.</para>
- <para>Normally, the value of this property should be set to <c>true</c> (the default) for security
- reasons, but there are times when it may be necessary to set it to <c>false</c>.</para>
- <para>For example, most Certificate Authorities are probably pretty good at keeping their CRL and/or
- OCSP servers up 24/7, but occasionally they do go down or are otherwise unreachable due to other
- network problems between the client and the Certificate Authority. When this happens, it becomes
- impossible to check the revocation status of one or more of the certificates in the chain
- resulting in an <see cref="T:MailKit.Security.SslHandshakeException"/> being thrown in the
- <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a> method. If this becomes a problem,
- it may become desirable to set <see cref="P:MailKit.IMailService.CheckCertificateRevocation"/> to <c>false</c>.</para>
- </remarks>
- <value><c>true</c> if certificate revocation should be checked; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailService.ServerCertificateValidationCallback">
- <summary>
- Get or sets a callback function to validate the server certificate.
- </summary>
- <remarks>
- <para>Gets or sets a callback function to validate the server certificate.</para>
- <para>This property should be set before calling any of the
- <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a> methods.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\SslCertificateValidation.cs"/>
- </example>
- <value>The server certificate validation callback function.</value>
- </member>
- <member name="P:MailKit.IMailService.LocalEndPoint">
- <summary>
- Get or set the local IP end point to use when connecting to a remote host.
- </summary>
- <remarks>
- Gets or sets the local IP end point to use when connecting to a remote host.
- </remarks>
- <value>The local IP end point or <c>null</c> to use the default end point.</value>
- </member>
- <member name="P:MailKit.IMailService.ProxyClient">
- <summary>
- Get or set the proxy client to use when connecting to a remote host.
- </summary>
- <remarks>
- Gets or sets the proxy client to use when connecting to a remote host via any of the
- <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a> methods.
- </remarks>
- <value>The proxy client.</value>
- </member>
- <member name="P:MailKit.IMailService.AuthenticationMechanisms">
- <summary>
- Get the authentication mechanisms supported by the message service.
- </summary>
- <remarks>
- The authentication mechanisms are queried durring the
- <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a> method.
- </remarks>
- <value>The supported authentication mechanisms.</value>
- </member>
- <member name="P:MailKit.IMailService.IsAuthenticated">
- <summary>
- Get whether or not the client is currently authenticated with the mail server.
- </summary>
- <remarks>
- <para>Gets whether or not the client is currently authenticated with the mail server.</para>
- <para>To authenticate with the mail server, use one of the
- <a href="Overload_MailKit_MailService_Authenticate.htm">Authenticate</a> methods
- or any of the Async alternatives.</para>
- </remarks>
- <value><c>true</c> if the client is authenticated; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailService.IsConnected">
- <summary>
- Get whether or not the service is currently connected.
- </summary>
- <remarks>
- <para>The <see cref="P:MailKit.IMailService.IsConnected"/> state is set to <c>true</c> immediately after
- one of the <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a>
- methods succeeds and is not set back to <c>false</c> until either the client
- is disconnected via <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> or until a
- <see cref="T:MailKit.ProtocolException"/> is thrown while attempting to read or write to
- the underlying network socket.</para>
- <para>When an <see cref="T:MailKit.ProtocolException"/> is caught, the connection state of the
- <see cref="T:MailKit.IMailService"/> should be checked before continuing.</para>
- </remarks>
- <value><c>true</c> if the service connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailService.IsSecure">
- <summary>
- Get whether or not the connection is secure (typically via SSL or TLS).
- </summary>
- <remarks>
- Gets whether or not the connection is secure (typically via SSL or TLS).
- </remarks>
- <value><c>true</c> if the connection is secure; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailService.Timeout">
- <summary>
- Get or set the timeout for network streaming operations, in milliseconds.
- </summary>
- <remarks>
- Gets or sets the underlying socket stream's <see cref="P:System.IO.Stream.ReadTimeout"/>
- and <see cref="P:System.IO.Stream.WriteTimeout"/> values.
- </remarks>
- <value>The timeout in milliseconds.</value>
- </member>
- <member name="M:MailKit.IMailService.Connect(System.String,System.Int32,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified mail server.
- </summary>
- <remarks>
- <para>Establish a connection to the specified mail server.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="useSsl"><value>true</value> if the client should make an SSL-wrapped connection to the server; otherwise, <value>false</value>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.ConnectAsync(System.String,System.Int32,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified mail server.
- </summary>
- <remarks>
- <para>Asynchronously establishes a connection to the specified mail server.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="useSsl"><value>true</value> if the client should make an SSL-wrapped connection to the server; otherwise, <value>false</value>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.Connect(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified mail server.
- </summary>
- <remarks>
- <para>Establish a connection to the specified mail server.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.ConnectAsync(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified mail server.
- </summary>
- <remarks>
- <para>Asynchronously establishes a connection to the specified mail server.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.Connect(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified mail server using the provided socket.
- </summary>
- <remarks>
- <para>Establish a connection to the specified mail server using the provided socket.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- <para>The <paramref name="host"/> is a zero-length string.</para>
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.ConnectAsync(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified mail server using the provided socket.
- </summary>
- <remarks>
- <para>Asynchronously establishes a connection to the specified mail server using the provided socket.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- <para>The <paramref name="host"/> is a zero-length string.</para>
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.Connect(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified mail server using the provided stream.
- </summary>
- <remarks>
- <para>Establish a connection to the specified mail server using the provided stream.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <param name="stream">The stream to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.ConnectAsync(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified mail server using the provided stream.
- </summary>
- <remarks>
- <para>Asynchronously establishes a connection to the specified mail server using the provided stream.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="stream">The stream to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.Authenticate(System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>Authenticates using the supplied credentials.</para>
- <para>If the server supports one or more SASL authentication mechanisms, then
- the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.AuthenticateAsync(System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>Asynchronously authenticates using the supplied credentials.</para>
- <para>If the server supports one or more SASL authentication mechanisms, then
- the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.Authenticate(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>Authenticates using the supplied credentials.</para>
- <para>If the server supports one or more SASL authentication mechanisms, then
- the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- </remarks>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.AuthenticateAsync(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>Asynchronously authenticates using the supplied credentials.</para>
- <para>If the server supports one or more SASL authentication mechanisms, then
- the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.Authenticate(System.Text.Encoding,System.String,System.String,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the specified user name and password.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.AuthenticateAsync(System.Text.Encoding,System.String,System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the specified user name and password.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.Authenticate(System.String,System.String,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the specified user name and password.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
- </example>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.AuthenticateAsync(System.String,System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the specified user name and password.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.Authenticate(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.AuthenticateAsync(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Disconnect the service.
- </summary>
- <remarks>
- <para>Disconnects from the service.</para>
- <para>If <paramref name="quit"/> is <c>true</c>, a "QUIT" command will be issued in order to disconnect cleanly.</para>
- </remarks>
- <param name="quit">If set to <c>true</c>, a "QUIT" command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.DisconnectAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously disconnect the service.
- </summary>
- <remarks>
- <para>Asynchronously disconnects from the service.</para>
- <para>If <paramref name="quit"/> is <c>true</c>, a "QUIT" command will be issued in order to disconnect cleanly.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="quit">If set to <c>true</c>, a logout/quit command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.NoOp(System.Threading.CancellationToken)">
- <summary>
- Ping the message service to keep the connection alive.
- </summary>
- <remarks>
- Mail servers, if left idle for too long, will automatically drop the connection.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.IMailService.NoOpAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously ping the mail server to keep the connection alive.
- </summary>
- <remarks>
- Mail servers, if left idle for too long, will automatically drop the connection.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailService"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="E:MailKit.IMailService.Connected">
- <summary>
- Occurs when the client has been successfully connected.
- </summary>
- <remarks>
- The <see cref="E:MailKit.IMailService.Connected"/> event is raised when the client
- successfully connects to the mail server.
- </remarks>
- </member>
- <member name="E:MailKit.IMailService.Disconnected">
- <summary>
- Occurs when the client has been disconnected.
- </summary>
- <remarks>
- The <see cref="E:MailKit.IMailService.Disconnected"/> event is raised whenever the client
- has been disconnected.
- </remarks>
- </member>
- <member name="E:MailKit.IMailService.Authenticated">
- <summary>
- Occurs when the client has been successfully authenticated.
- </summary>
- <remarks>
- The <see cref="E:MailKit.IMailService.Authenticated"/> event is raised whenever the client
- has been authenticated.
- </remarks>
- </member>
- <member name="T:MailKit.IMailSpool">
- <summary>
- An interface for retreiving messages from a spool.
- </summary>
- <remarks>
- An interface for retreiving messages from a spool.
- </remarks>
- </member>
- <member name="P:MailKit.IMailSpool.Count">
- <summary>
- Get the number of messages available in the message spool.
- </summary>
- <remarks>
- <para>Gets the number of messages available in the message spool.</para>
- <para>Once authenticated, the <see cref="P:MailKit.IMailSpool.Count"/> property will be set
- to the number of available messages in the spool.</para>
- </remarks>
- <value>The message count.</value>
- </member>
- <member name="P:MailKit.IMailSpool.SupportsUids">
- <summary>
- Get whether or not the service supports referencing messages by UIDs.
- </summary>
- <remarks>
- <para>Not all servers support referencing messages by UID, so this property should
- be checked before using <see cref="M:MailKit.IMailSpool.GetMessageUid(System.Int32,System.Threading.CancellationToken)"/>
- and <see cref="M:MailKit.IMailSpool.GetMessageUids(System.Threading.CancellationToken)"/>.</para>
- <para>If the server does not support UIDs, then all methods that take UID arguments
- along with <see cref="M:MailKit.IMailSpool.GetMessageUid(System.Int32,System.Threading.CancellationToken)"/> and
- <see cref="M:MailKit.IMailSpool.GetMessageUids(System.Threading.CancellationToken)"/> will fail.</para>
- </remarks>
- <value><c>true</c> if supports uids; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageCount(System.Threading.CancellationToken)">
- <summary>
- Get the message count.
- </summary>
- <remarks>
- Gets the message count.
- </remarks>
- <returns>The message count.</returns>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageUid(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the UID of the message at the specified index.
- </summary>
- <remarks>
- Not all servers support UIDs, so you should first check
- the <see cref="P:MailKit.IMailSpool.SupportsUids"/> property.
- </remarks>
- <returns>The message UID.</returns>
- <param name="index">The message index.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageUidAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the UID of the message at the specified index.
- </summary>
- <remarks>
- Not all servers support UIDs, so you should first check
- the <see cref="P:MailKit.IMailSpool.SupportsUids"/> property.
- </remarks>
- <returns>The message UID.</returns>
- <param name="index">The message index.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageUids(System.Threading.CancellationToken)">
- <summary>
- Get the full list of available message UIDs.
- </summary>
- <remarks>
- Not all servers support UIDs, so you should first check
- the <see cref="P:MailKit.IMailSpool.SupportsUids"/> property.
- </remarks>
- <returns>The message UIDs.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageUidsAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the full list of available message UIDs.
- </summary>
- <remarks>
- Not all servers support UIDs, so you should first check
- the <see cref="P:MailKit.IMailSpool.SupportsUids"/> property.
- </remarks>
- <returns>The message UIDs.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageSize(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the size of the specified message, in bytes.
- </summary>
- <remarks>
- Gets the size of the specified message, in bytes.
- </remarks>
- <returns>The message size, in bytes.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageSizeAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the size of the specified message, in bytes.
- </summary>
- <remarks>
- Asynchronously gets the size of the specified message, in bytes.
- </remarks>
- <returns>The message size, in bytes.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageSizes(System.Threading.CancellationToken)">
- <summary>
- Get the sizes for all available messages, in bytes.
- </summary>
- <remarks>
- Gets the sizes for all available messages, in bytes.
- </remarks>
- <returns>The message sizes, in bytes.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageSizesAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the sizes for all available messages, in bytes.
- </summary>
- <remarks>
- Asynchronously gets the sizes for all available messages, in bytes.
- </remarks>
- <returns>The message sizes, in bytes.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the headers for the specified message.
- </summary>
- <remarks>
- Gets the headers for the specified message.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageHeadersAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the headers for the specified message.
- </summary>
- <remarks>
- Asynchronously gets the headers for the specified message.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageHeaders(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Get the headers for the specified messages.
- </summary>
- <remarks>
- Gets the headers for the specified messages.
- </remarks>
- <returns>The headers for the specified messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageHeadersAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the headers for the specified messages.
- </summary>
- <remarks>
- Asynchronously gets the headers for the specified messages.
- </remarks>
- <returns>The headers for the specified messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageHeaders(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the headers of the messages within the specified range.
- </summary>
- <remarks>
- Gets the headers of the messages within the specified range.
- </remarks>
- <returns>The headers of the messages within the specified range.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageHeadersAsync(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the headers of the messages within the specified range.
- </summary>
- <remarks>
- Gets the headers of the messages within the specified range.
- </remarks>
- <returns>The headers of the messages within the specified range.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message at the specified index.
- </summary>
- <remarks>
- Gets the message at the specified index.
- </remarks>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessageAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message at the specified index.
- </summary>
- <remarks>
- Asynchronously gets the message at the specified index.
- </remarks>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessages(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the messages at the specified indexes.
- </summary>
- <remarks>
- Gets the messages at the specified indexes.
- </remarks>
- <returns>The messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessagesAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the messages at the specified indexes.
- </summary>
- <remarks>
- Asynchronously gets the messages at the specified indexes.
- </remarks>
- <returns>The messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessages(System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the messages within the specified range.
- </summary>
- <remarks>
- Gets the messages within the specified range.
- </remarks>
- <returns>The messages.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetMessagesAsync(System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the messages within the specified range.
- </summary>
- <remarks>
- Asynchronously gets the messages within the specified range.
- </remarks>
- <returns>The messages.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message or header stream at the specified index.
- </summary>
- <remarks>
- Gets the message or header stream at the specified index.
- </remarks>
- <returns>The message or header stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetStreamAsync(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message or header stream at the specified index.
- </summary>
- <remarks>
- Asynchronously gets the message or header stream at the specified index.
- </remarks>
- <returns>The message or header stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetStreams(System.Collections.Generic.IList{System.Int32},System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message or header streams at the specified index.
- </summary>
- <remarks>
- Gets the message or header streams at the specified index.
- </remarks>
- <returns>The message or header streams.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetStreamsAsync(System.Collections.Generic.IList{System.Int32},System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message or header streams at the specified indexes.
- </summary>
- <remarks>
- Asynchronously gets the message or header streams at the specified indexes.
- </remarks>
- <returns>The message or header streams.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetStreams(System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message or header streams within the specified range.
- </summary>
- <remarks>
- Gets the message or header streams within the specified range.
- </remarks>
- <returns>The message or header streams.</returns>
- <param name="startIndex">The index of the first stream to get.</param>
- <param name="count">The number of streams to get.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.GetStreamsAsync(System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message or header streams within the specified range.
- </summary>
- <remarks>
- Asynchronously gets the message or header streams within the specified range.
- </remarks>
- <returns>The messages.</returns>
- <param name="startIndex">The index of the first stream to get.</param>
- <param name="count">The number of streams to get.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailSpool.DeleteMessage(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Mark the specified message for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.DeleteMessageAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark the specified message for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.DeleteMessages(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Mark the specified messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.DeleteMessagesAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark the specified messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.DeleteMessages(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Mark the specified range of messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="startIndex">The index of the first message to mark for deletion.</param>
- <param name="count">The number of messages to mark for deletion.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.DeleteMessagesAsync(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark the specified range of messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="startIndex">The index of the first message to mark for deletion.</param>
- <param name="count">The number of messages to mark for deletion.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.DeleteAllMessages(System.Threading.CancellationToken)">
- <summary>
- Mark all messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.DeleteAllMessagesAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark all messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.Reset(System.Threading.CancellationToken)">
- <summary>
- Reset the state of all messages marked for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailSpool.ResetAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously reset the state of all messages marked for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="T:MailKit.IMailStore">
- <summary>
- An interface for retreiving messages from a message store such as IMAP.
- </summary>
- <remarks>
- Implemented by <see cref="T:MailKit.Net.Imap.ImapClient"/>.
- </remarks>
- </member>
- <member name="P:MailKit.IMailStore.PersonalNamespaces">
- <summary>
- Get the personal namespaces.
- </summary>
- <remarks>
- The personal folder namespaces contain a user's personal mailbox folders.
- </remarks>
- <value>The personal namespaces.</value>
- </member>
- <member name="P:MailKit.IMailStore.SharedNamespaces">
- <summary>
- Get the shared namespaces.
- </summary>
- <remarks>
- The shared folder namespaces contain mailbox folders that are shared with the user.
- </remarks>
- <value>The shared namespaces.</value>
- </member>
- <member name="P:MailKit.IMailStore.OtherNamespaces">
- <summary>
- Get the other namespaces.
- </summary>
- <remarks>
- The other folder namespaces contain other mailbox folders.
- </remarks>
- <value>The other namespaces.</value>
- </member>
- <member name="P:MailKit.IMailStore.SupportsQuotas">
- <summary>
- Get whether or not the mail store supports quotas.
- </summary>
- <remarks>
- Gets whether or not the mail store supports quotas.
- </remarks>
- <value><c>true</c> if the mail store supports quotas; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMailStore.ThreadingAlgorithms">
- <summary>
- Get the threading algorithms supported by the mail store.
- </summary>
- <remarks>
- The threading algorithms are queried as part of the
- <a href="Overload_MailKit_IMailStore_Connect.htm">Connect</a>
- and <a href="Overload_MailKit_IMailStore_Authenticate.htm">Authenticate</a> methods.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The threading algorithms.</value>
- </member>
- <member name="P:MailKit.IMailStore.Inbox">
- <summary>
- Get the Inbox folder.
- </summary>
- <remarks>
- The Inbox folder is the default folder and is typically the folder
- where all new messages are delivered.
- </remarks>
- <value>The Inbox folder.</value>
- </member>
- <member name="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)">
- <summary>
- Enable the quick resynchronization feature.
- </summary>
- <remarks>
- <para>Enables quick resynchronization when a folder is opened using the
- <see cref="M:MailKit.IMailFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/>
- method.</para>
- <para>If this feature is enabled, the <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event
- is replaced with the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> event.</para>
- <para>This method needs to be called immediately after
- <see cref="M:MailKit.IMailService.Authenticate(System.Net.ICredentials,System.Threading.CancellationToken)"/>,
- before the opening of any folders.</para>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailService"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Quick resynchronization needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support quick resynchronization.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.EnableQuickResyncAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously enable the quick resynchronization feature.
- </summary>
- <remarks>
- <para>Enables quick resynchronization when a folder is opened using the
- <see cref="M:MailKit.IMailFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/>
- method.</para>
- <para>If this feature is enabled, the <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event
- is replaced with the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> event.</para>
- <para>This method needs to be called immediately after
- <see cref="M:MailKit.IMailService.Authenticate(System.Net.ICredentials,System.Threading.CancellationToken)"/>,
- before the opening of any folders.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailService"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Quick resynchronization needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support quick resynchronization.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.GetFolder(MailKit.SpecialFolder)">
- <summary>
- Get the specified special folder.
- </summary>
- <remarks>
- Not all message stores support the concept of special folders,
- so this method may return <c>null</c>.
- </remarks>
- <returns>The folder if available; otherwise <c>null</c>.</returns>
- <param name="folder">The type of special folder.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="folder"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.GetFolder(MailKit.FolderNamespace)">
- <summary>
- Get the folder for the specified namespace.
- </summary>
- <remarks>
- The main reason to get the toplevel folder in a namespace is
- to list its child folders.
- </remarks>
- <returns>The folder.</returns>
- <param name="namespace">The namespace.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The folder could not be found.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.GetFolders(MailKit.FolderNamespace,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailService"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The namespace folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.GetFoldersAsync(MailKit.FolderNamespace,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Asynchronously gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailService"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The namespace folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.GetFolders(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailService"/> has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailService"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The namespace folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.GetFoldersAsync(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Asynchronously gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailService"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailService"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The namespace folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.GetFolder(System.String,System.Threading.CancellationToken)">
- <summary>
- Get the folder for the specified path.
- </summary>
- <remarks>
- Gets the folder for the specified path.
- </remarks>
- <returns>The folder.</returns>
- <param name="path">The folder path.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="path"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.GetFolderAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the folder for the specified path.
- </summary>
- <remarks>
- Asynchronously gets the folder for the specified path.
- </remarks>
- <returns>The folder.</returns>
- <param name="path">The folder path.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="path"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.IMailStore.GetMetadata(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailStore.GetMetadataAsync(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailStore.GetMetadata(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailStore.GetMetadataAsync(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailStore.GetMetadata(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailStore.GetMetadataAsync(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailStore.SetMetadata(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Sets the specified metadata.
- </summary>
- <remarks>
- Sets the specified metadata.
- </remarks>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="M:MailKit.IMailStore.SetMetadataAsync(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sets the specified metadata.
- </summary>
- <remarks>
- Asynchronously sets the specified metadata.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- </member>
- <member name="E:MailKit.IMailStore.Alert">
- <summary>
- Occurs when a remote message store receives an alert message from the server.
- </summary>
- <remarks>
- Some implementations, such as <see cref="T:MailKit.Net.Imap.ImapClient"/>,
- will emit Alert events when they receive alert messages from the server.
- </remarks>
- </member>
- <member name="E:MailKit.IMailStore.FolderCreated">
- <summary>
- Occurs when a folder is created.
- </summary>
- <remarks>
- The <see cref="E:MailKit.IMailStore.FolderCreated"/> event is emitted when a new folder is created.
- </remarks>
- </member>
- <member name="E:MailKit.IMailStore.MetadataChanged">
- <summary>
- Occurs when metadata changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.IMailStore.MetadataChanged"/> event is emitted when metadata changes.
- </remarks>
- </member>
- <member name="T:MailKit.IMailTransport">
- <summary>
- An interface for sending messages.
- </summary>
- <remarks>
- An interface for sending messages.
- </remarks>
- </member>
- <member name="M:MailKit.IMailTransport.Send(MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message.
- </summary>
- <remarks>
- <para>Sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailTransport.SendAsync(MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message.
- </summary>
- <remarks>
- <para>Asynchronously sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailTransport.Send(MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Sends the specified message using the supplied sender and recipients.
- </remarks>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailTransport.SendAsync(MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Asynchronously sends the specified message using the supplied sender and recipients.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailTransport.Send(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message.
- </summary>
- <remarks>
- <para>Sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailTransport.SendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message.
- </summary>
- <remarks>
- <para>Asynchronously sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailTransport.Send(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Sends the specified message using the supplied sender and recipients.
- </remarks>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="M:MailKit.IMailTransport.SendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Asynchronously sends the specified message using the supplied sender and recipients.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- </member>
- <member name="E:MailKit.IMailTransport.MessageSent">
- <summary>
- Occurs when a message is successfully sent via the transport.
- </summary>
- <remarks>
- The <see cref="E:MailKit.IMailTransport.MessageSent"/> event will be emitted each time a message is successfully sent.
- </remarks>
- </member>
- <member name="T:MailKit.IMessageSummary">
- <summary>
- A summary of a message.
- </summary>
- <remarks>
- A <see cref="T:MailKit.IMessageSummary"/> is returned by
- <see cref="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)"/>.
- The properties of the <see cref="T:MailKit.IMessageSummary"/> that will be available
- depend on the <see cref="T:MailKit.MessageSummaryItems"/> passed to the aformentioned method.
- </remarks>
- </member>
- <member name="P:MailKit.IMessageSummary.Fields">
- <summary>
- Get a bitmask of fields that have been populated.
- </summary>
- <remarks>
- Gets a bitmask of fields that have been populated.
- </remarks>
- <value>The fields that have been populated.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Body">
- <summary>
- Gets the body structure of the message, if available.
- </summary>
- <remarks>
- <para>The body will be one of <see cref="T:MailKit.BodyPartText"/>,
- <see cref="T:MailKit.BodyPartMessage"/>, <see cref="T:MailKit.BodyPartBasic"/>,
- or <see cref="T:MailKit.BodyPartMultipart"/>.</para>
- <para>This property will only be set if either the
- <see cref="F:MailKit.MessageSummaryItems.Body"/> flag or the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The body structure of the message.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.TextBody">
- <summary>
- Gets the text body part of the message if it exists.
- </summary>
- <remarks>
- <para>Gets the <c>text/plain</c> body part of the message.</para>
- <para>This property will only be usable if the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <value>The text body if it exists; otherwise, <c>null</c>.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.HtmlBody">
- <summary>
- Gets the html body part of the message if it exists.
- </summary>
- <remarks>
- <para>Gets the <c>text/html</c> body part of the message.</para>
- <para>This property will only be usable if the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The html body if it exists; otherwise, <c>null</c>.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.BodyParts">
- <summary>
- Gets the body parts of the message.
- </summary>
- <remarks>
- <para>Traverses over the <see cref="P:MailKit.IMessageSummary.Body"/>, enumerating all of the
- <see cref="T:MailKit.BodyPartBasic"/> objects.</para>
- <para>This property will only be usable if either the
- <see cref="F:MailKit.MessageSummaryItems.Body"/> flag or the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The body parts.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Attachments">
- <summary>
- Gets the attachments.
- </summary>
- <remarks>
- <para>Traverses over the <see cref="P:MailKit.IMessageSummary.Body"/>, enumerating all of the
- <see cref="T:MailKit.BodyPartBasic"/> objects that have a <c>Content-Disposition</c>
- header set to <c>"attachment"</c>.</para>
- <para>This property will only be usable if the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <value>The attachments.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.PreviewText">
- <summary>
- Gets the preview text of the message.
- </summary>
- <remarks>
- <para>The preview text is a short snippet of the beginning of the message
- text, typically shown in a mail client's message list to provide the user
- with a sense of what the message is about.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.PreviewText"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The preview text.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Envelope">
- <summary>
- Gets the envelope of the message, if available.
- </summary>
- <remarks>
- <para>The envelope of a message contains information such as the
- date the message was sent, the subject of the message,
- the sender of the message, who the message was sent to,
- which message(s) the message may be in reply to,
- and the message id.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Envelope"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The envelope of the message.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.NormalizedSubject">
- <summary>
- Gets the normalized subject.
- </summary>
- <remarks>
- <para>A normalized <c>Subject</c> header value where prefixes such as <c>"Re:"</c>, <c>"Re[#]:"</c> and <c>"FWD:"</c> have been pruned.</para>
- <para>This property is typically used for threading messages by subject.</para>
- </remarks>
- <value>The normalized subject.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Date">
- <summary>
- Gets the Date header value.
- </summary>
- <remarks>
- Gets the Date header value. If the Date header is not present, the arrival date is used.
- If neither are known, <see cref="F:System.DateTimeOffset.MinValue"/> is returned.
- </remarks>
- <value>The date.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.IsReply">
- <summary>
- Gets whether or not the message is a reply.
- </summary>
- <remarks>
- This value should be based on whether the message subject contained any <c>"Re:"</c>, <c>"Re[#]:"</c> or <c>"FWD:"</c> prefixes.
- </remarks>
- <value><c>true</c> if the message is a reply; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Flags">
- <summary>
- Gets the message flags, if available.
- </summary>
- <remarks>
- <para>Gets the message flags, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Flags"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The message flags.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Keywords">
- <summary>
- Gets the user-defined message flags, if available.
- </summary>
- <remarks>
- <para>Gets the user-defined message flags, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Flags"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The user-defined message flags.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.UserFlags">
- <summary>
- Gets the user-defined message flags, if available.
- </summary>
- <remarks>
- <para>Gets the user-defined message flags, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Flags"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The user-defined message flags.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Annotations">
- <summary>
- Gets the message annotations, if available.
- </summary>
- <remarks>
- <para>Gets the message annotations, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Annotations"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The message annotations.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Headers">
- <summary>
- Gets the list of headers, if available.
- </summary>
- <remarks>
- <para>Gets the list of headers, if available.</para>
- <para>This property will only be set if <see cref="F:MailKit.MessageSummaryItems.Headers"/>
- is specified in a call to one of the
- <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods or specific headers are requested via a one of the Fetch or FetchAsync methods
- that accept list of specific headers to request for each message such as
- <see cref="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)"/>.
- </para>
- </remarks>
- <value>The list of headers.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.InternalDate">
- <summary>
- Gets the internal date of the message, if available.
- </summary>
- <remarks>
- <para>Gets the internal date of the message (often the same date as found in the <c>Received</c> header), if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.InternalDate"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The internal date of the message.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Size">
- <summary>
- Gets the size of the message, in bytes, if available.
- </summary>
- <remarks>
- <para>Gets the size of the message, in bytes, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Size"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The size of the message.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.ModSeq">
- <summary>
- Gets the mod-sequence value for the message, if available.
- </summary>
- <remarks>
- <para>Gets the mod-sequence value for the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.ModSeq"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The mod-sequence value.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.References">
- <summary>
- Gets the message-ids that the message references, if available.
- </summary>
- <remarks>
- <para>Gets the message-ids that the message references, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.References"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The references.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.EmailId">
- <summary>
- Get the globally unique identifier for the message, if available.
- </summary>
- <remarks>
- <para>Gets the globally unique identifier of the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.EmailId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- <note type="info">This property maps to the <c>EMAILID</c> value defined in the
- <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
- </remarks>
- <value>The globally unique message identifier.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Id">
- <summary>
- Get the globally unique identifier for the message, if available.
- </summary>
- <remarks>
- <para>Gets the globally unique identifier of the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.EmailId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- <note type="info">This property maps to the <c>EMAILID</c> value defined in the
- <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
- </remarks>
- <value>The globally unique message identifier.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.ThreadId">
- <summary>
- Get the globally unique thread identifier for the message, if available.
- </summary>
- <remarks>
- <para>Gets the globally unique thread identifier for the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.ThreadId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- <note type="info">This property maps to the <c>THREADID</c> value defined in the
- <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
- </remarks>
- <value>The globally unique thread identifier.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.UniqueId">
- <summary>
- Gets the unique identifier of the message, if available.
- </summary>
- <remarks>
- <para>Gets the unique identifier of the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.UniqueId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The uid of the message.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.Index">
- <summary>
- Gets the index of the message.
- </summary>
- <remarks>
- <para>Gets the index of the message.</para>
- <para>This property is always set.</para>
- </remarks>
- <value>The index of the message.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.GMailMessageId">
- <summary>
- Gets the GMail message identifier, if available.
- </summary>
- <remarks>
- <para>Gets the GMail message identifier, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.GMailMessageId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The GMail message identifier.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.GMailThreadId">
- <summary>
- Gets the GMail thread identifier, if available.
- </summary>
- <remarks>
- <para>Gets the GMail thread identifier, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.GMailThreadId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The GMail thread identifier.</value>
- </member>
- <member name="P:MailKit.IMessageSummary.GMailLabels">
- <summary>
- Gets the list of GMail labels, if available.
- </summary>
- <remarks>
- <para>Gets the list of GMail labels, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.GMailLabels"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The GMail labels.</value>
- </member>
- <member name="T:MailKit.IProtocolLogger">
- <summary>
- An interface for logging the communication between a client and server.
- </summary>
- <remarks>
- An interface for logging the communication between a client and server.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ProtocolLogger" />
- </example>
- </member>
- <member name="M:MailKit.IProtocolLogger.LogConnect(System.Uri)">
- <summary>
- Logs a connection to the specified URI.
- </summary>
- <remarks>
- Logs a connection to the specified URI.
- </remarks>
- <param name="uri">The URI.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uri"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The logger has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IProtocolLogger.LogClient(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Logs a sequence of bytes sent by the client.
- </summary>
- <remarks>
- <para>Logs a sequence of bytes sent by the client.</para>
- <para><see cref="M:MailKit.IProtocolLogger.LogClient(System.Byte[],System.Int32,System.Int32)"/> is called by the <see cref="T:MailKit.IMailService"/> upon every successful
- write operation to its underlying network stream, passing the exact same <paramref name="buffer"/>,
- <paramref name="offset"/>, and <paramref name="count"/> arguments to the logging function.</para>
- </remarks>
- <param name='buffer'>The buffer to log.</param>
- <param name='offset'>The offset of the first byte to log.</param>
- <param name='count'>The number of bytes to log.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The logger has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.IProtocolLogger.LogServer(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Logs a sequence of bytes sent by the server.
- </summary>
- <remarks>
- <para>Logs a sequence of bytes sent by the server.</para>
- <para><see cref="M:MailKit.IProtocolLogger.LogServer(System.Byte[],System.Int32,System.Int32)"/> is called by the <see cref="T:MailKit.IMailService"/> upon every successful
- read of its underlying network stream with the exact buffer that was read.</para>
- </remarks>
- <param name='buffer'>The buffer to log.</param>
- <param name='offset'>The offset of the first byte to log.</param>
- <param name='count'>The number of bytes to log.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The logger has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="T:MailKit.ITransferProgress">
- <summary>
- An interface for reporting progress of uploading or downloading messages.
- </summary>
- <remarks>
- An interface for reporting progress of uploading or downloading messages.
- </remarks>
- </member>
- <member name="M:MailKit.ITransferProgress.Report(System.Int64,System.Int64)">
- <summary>
- Report the progress of the transfer operation.
- </summary>
- <remarks>
- <para>Reports the progress of the transfer operation.</para>
- <para>This method is only used if the operation knows the size
- of the message, part, or stream being transferred without doing
- extra work to calculate it.</para>
- </remarks>
- <param name="bytesTransferred">The number of bytes transferred.</param>
- <param name="totalSize">The total size, in bytes, of the message, part, or stream being transferred.</param>
- </member>
- <member name="M:MailKit.ITransferProgress.Report(System.Int64)">
- <summary>
- Report the progress of the transfer operation.
- </summary>
- <remarks>
- <para>Reports the progress of the transfer operation.</para>
- </remarks>
- <param name="bytesTransferred">The number of bytes transferred.</param>
- </member>
- <member name="T:MailKit.MailFolder">
- <summary>
- An abstract mail folder implementation.
- </summary>
- <remarks>
- An abstract mail folder implementation.
- </remarks>
- </member>
- <member name="F:MailKit.MailFolder.SettableFlags">
- <summary>
- The bit mask of settable flags.
- </summary>
- <remarks>
- Only flags in the list of settable flags may be set on a message by the client.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.#ctor">
- <summary>
- Initialize a new instance of the <see cref="T:MailKit.MailFolder"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.MailFolder"/> class.
- </remarks>
- </member>
- <member name="P:MailKit.MailFolder.SyncRoot">
- <summary>
- Get an object that can be used to synchronize access to the folder.
- </summary>
- <remarks>
- <para>Gets an object that can be used to synchronize access to the folder.</para>
- </remarks>
- <value>The sync root.</value>
- </member>
- <member name="P:MailKit.MailFolder.ParentFolder">
- <summary>
- Get the parent folder.
- </summary>
- <remarks>
- Root-level folders do not have a parent folder.
- </remarks>
- <value>The parent folder.</value>
- </member>
- <member name="P:MailKit.MailFolder.Attributes">
- <summary>
- Get the folder attributes.
- </summary>
- <remarks>
- Gets the folder attributes.
- </remarks>
- <value>The folder attributes.</value>
- </member>
- <member name="P:MailKit.MailFolder.AnnotationAccess">
- <summary>
- Get the annotation access level.
- </summary>
- <remarks>
- If annotations are supported, this property can be used to determine whether or not
- the <see cref="T:MailKit.IMailFolder"/> supports reading and writing annotations.
- </remarks>
- </member>
- <member name="P:MailKit.MailFolder.AnnotationScopes">
- <summary>
- Get the supported annotation scopes.
- </summary>
- <remarks>
- If annotations are supported, this property can be used to determine which
- annotation scopes are supported by the <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="P:MailKit.MailFolder.MaxAnnotationSize">
- <summary>
- Get the maximum size of annotation values supported by the folder.
- </summary>
- <remarks>
- If annotations are supported, this property can be used to determine the
- maximum size of annotation values supported by the <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="P:MailKit.MailFolder.PermanentFlags">
- <summary>
- Get the permanent flags.
- </summary>
- <remarks>
- <para>The permanent flags are the message flags that will persist between sessions.</para>
- <para>If the <see cref="F:MailKit.MessageFlags.UserDefined"/> flag is set, then the folder allows
- storing of user-defined (custom) message flags.</para>
- </remarks>
- <value>The permanent flags.</value>
- </member>
- <member name="P:MailKit.MailFolder.AcceptedFlags">
- <summary>
- Get the accepted flags.
- </summary>
- <remarks>
- The accepted flags are the message flags that will be accepted and persist
- for the current session. For the set of flags that will persist between
- sessions, see the <see cref="P:MailKit.MailFolder.PermanentFlags"/> property.
- </remarks>
- <value>The accepted flags.</value>
- </member>
- <member name="P:MailKit.MailFolder.DirectorySeparator">
- <summary>
- Get the directory separator.
- </summary>
- <remarks>
- Gets the directory separator.
- </remarks>
- <value>The directory separator.</value>
- </member>
- <member name="P:MailKit.MailFolder.Access">
- <summary>
- Get the read/write access of the folder.
- </summary>
- <remarks>
- Gets the read/write access of the folder.
- </remarks>
- <value>The read/write access.</value>
- </member>
- <member name="P:MailKit.MailFolder.IsNamespace">
- <summary>
- Get whether or not the folder is a namespace folder.
- </summary>
- <remarks>
- Gets whether or not the folder is a namespace folder.
- </remarks>
- <value><c>true</c> if the folder is a namespace folder; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailFolder.FullName">
- <summary>
- Get the full name of the folder.
- </summary>
- <remarks>
- This is the equivalent of the full path of a file on a file system.
- </remarks>
- <value>The full name of the folder.</value>
- </member>
- <member name="P:MailKit.MailFolder.Name">
- <summary>
- Get the name of the folder.
- </summary>
- <remarks>
- This is the equivalent of the file name of a file on the file system.
- </remarks>
- <value>The name of the folder.</value>
- </member>
- <member name="P:MailKit.MailFolder.Id">
- <summary>
- Get the unique identifier for the folder, if available.
- </summary>
- <remarks>
- <para>Gets a unique identifier for the folder, if available. This is useful for clients
- implementing a message cache that want to track the folder after it is renamed by another
- client.</para>
- <note type="note">This property will only be available if the server supports the
- <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
- </remarks>
- <value>The unique folder identifier.</value>
- </member>
- <member name="P:MailKit.MailFolder.IsSubscribed">
- <summary>
- Get a value indicating whether the folder is subscribed.
- </summary>
- <remarks>
- Gets a value indicating whether the folder is subscribed.
- </remarks>
- <value><c>true</c> if the folder is subscribed; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailFolder.IsOpen">
- <summary>
- Get a value indicating whether the folder is currently open.
- </summary>
- <remarks>
- Gets a value indicating whether the folder is currently open.
- </remarks>
- <value><c>true</c> if the folder is currently open; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailFolder.Exists">
- <summary>
- Get a value indicating whether the folder exists.
- </summary>
- <remarks>
- Gets a value indicating whether the folder exists.
- </remarks>
- <value><c>true</c> if the folder exists; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailFolder.SupportsModSeq">
- <summary>
- Get whether or not the folder supports mod-sequences.
- </summary>
- <remarks>
- <para>If mod-sequences are not supported by the folder, then all of the APIs that take a modseq
- argument will throw <see cref="T:System.NotSupportedException"/> and should not be used.</para>
- </remarks>
- <value><c>true</c> if supports mod-sequences; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailFolder.HighestModSeq">
- <summary>
- Get the highest mod-sequence value of all messages in the mailbox.
- </summary>
- <remarks>
- Gets the highest mod-sequence value of all messages in the mailbox.
- </remarks>
- <value>The highest mod-sequence value.</value>
- </member>
- <member name="P:MailKit.MailFolder.UidValidity">
- <summary>
- Get the UID validity.
- </summary>
- <remarks>
- <para>UIDs are only valid so long as the UID validity value remains unchanged. If and when
- the folder's <see cref="P:MailKit.MailFolder.UidValidity"/> is changed, a client MUST discard its cache of UIDs
- along with any summary information that it may have and re-query the folder.</para>
- <para>This value will only be set after the folder has been opened.</para>
- </remarks>
- <value>The UID validity.</value>
- </member>
- <member name="P:MailKit.MailFolder.UidNext">
- <summary>
- Get the UID that the folder will assign to the next message that is added.
- </summary>
- <remarks>
- This value will only be set after the folder has been opened.
- </remarks>
- <value>The next UID.</value>
- </member>
- <member name="P:MailKit.MailFolder.AppendLimit">
- <summary>
- Get the maximum size of a message that can be appended to the folder.
- </summary>
- <remarks>
- <para>Gets the maximum size of a message that can be appended to the folder.</para>
- <note type="note">If the value is not set, then the limit is unspecified.</note>
- </remarks>
- <value>The append limit.</value>
- </member>
- <member name="P:MailKit.MailFolder.Size">
- <summary>
- Get the size of the folder.
- </summary>
- <remarks>
- <para>Gets the size of the folder in bytes.</para>
- <note type="note">If the value is not set, then the size is unspecified.</note>
- </remarks>
- <value>The size.</value>
- </member>
- <member name="P:MailKit.MailFolder.FirstUnread">
- <summary>
- Get the index of the first unread message in the folder.
- </summary>
- <remarks>
- This value will only be set after the folder has been opened.
- </remarks>
- <value>The index of the first unread message.</value>
- </member>
- <member name="P:MailKit.MailFolder.Unread">
- <summary>
- Get the number of unread messages in the folder.
- </summary>
- <remarks>
- <para>Gets the number of unread messages in the folder.</para>
- <note type="note">This value will only be set after calling
- <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- with <see cref="F:MailKit.StatusItems.Unread"/>.</note>
- </remarks>
- <value>The number of unread messages.</value>
- </member>
- <member name="P:MailKit.MailFolder.Recent">
- <summary>
- Get the number of recently added messages in the folder.
- </summary>
- <remarks>
- <para>Gets the number of recently delivered messages in the folder.</para>
- <note type="note">This value will only be set after calling
- <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- with <see cref="F:MailKit.StatusItems.Recent"/> or by opening the folder.</note>
- </remarks>
- <value>The number of recently added messages.</value>
- </member>
- <member name="P:MailKit.MailFolder.Count">
- <summary>
- Get the total number of messages in the folder.
- </summary>
- <remarks>
- <para>Gets the total number of messages in the folder.</para>
- <note type="note">This value will only be set after calling
- <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- with <see cref="F:MailKit.StatusItems.Count"/> or by opening the folder.</note>
- </remarks>
- <value>The total number of messages.</value>
- </member>
- <member name="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Opens the folder using the requested folder access.
- </summary>
- <remarks>
- <para>This variant of the <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- method is meant for quick resynchronization of the folder. Before calling this method,
- the <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method MUST be called.</para>
- <para>You should also make sure to add listeners to the <see cref="E:MailKit.MailFolder.MessagesVanished"/> and
- <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events to get notifications of changes since
- the last time the folder was opened.</para>
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="uidValidity">The last known <see cref="P:MailKit.MailFolder.UidValidity"/> value.</param>
- <param name="highestModSeq">The last known <see cref="P:MailKit.MailFolder.HighestModSeq"/> value.</param>
- <param name="uids">The last known list of unique message identifiers.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="access"/> is not a valid value.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The quick resynchronization feature has not been enabled.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the quick resynchronization feature.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.OpenAsync(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously opens the folder using the requested folder access.
- </summary>
- <remarks>
- <para>This variant of the <see cref="M:MailKit.MailFolder.OpenAsync(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
- method is meant for quick resynchronization of the folder. Before calling this method,
- the <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method MUST be called.</para>
- <para>You should also make sure to add listeners to the <see cref="E:MailKit.MailFolder.MessagesVanished"/> and
- <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events to get notifications of changes since
- the last time the folder was opened.</para>
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="uidValidity">The last known <see cref="P:MailKit.MailFolder.UidValidity"/> value.</param>
- <param name="highestModSeq">The last known <see cref="P:MailKit.MailFolder.HighestModSeq"/> value.</param>
- <param name="uids">The last known list of unique message identifiers.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="access"/> is not a valid value.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The quick resynchronization feature has not been enabled.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the quick resynchronization feature.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)">
- <summary>
- Open the folder using the requested folder access.
- </summary>
- <remarks>
- Opens the folder using the requested folder access.
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="access"/> is not a valid value.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.OpenAsync(MailKit.FolderAccess,System.Threading.CancellationToken)">
- <summary>
- Asynchronously open the folder using the requested folder access.
- </summary>
- <remarks>
- Asynchronously opens the folder using the requested folder access.
- </remarks>
- <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
- <param name="access">The requested folder access.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="access"/> is not a valid value.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Close(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Close the folder, optionally expunging the messages marked for deletion.
- </summary>
- <remarks>
- Closes the folder, optionally expunging the messages marked for deletion.
- </remarks>
- <param name="expunge">If set to <c>true</c>, expunge.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CloseAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously close the folder, optionally expunging the messages marked for deletion.
- </summary>
- <remarks>
- Asynchronously closes the folder, optionally expunging the messages marked for deletion.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="expunge">If set to <c>true</c>, expunge.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Create(System.String,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="isMessageFolder"><c>true</c> if the folder will be used to contain messages; otherwise <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CreateAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously create a new subfolder with the given name.
- </summary>
- <remarks>
- Asynchronously creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="isMessageFolder"><c>true</c> if the folder will be used to contain messages; otherwise <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Create(System.String,System.Collections.Generic.IEnumerable{MailKit.SpecialFolder},System.Threading.CancellationToken)">
- <summary>
- Create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUses">A list of special uses for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="specialUses"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailService"/> does not support the creation of special folders.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CreateAsync(System.String,System.Collections.Generic.IEnumerable{MailKit.SpecialFolder},System.Threading.CancellationToken)">
- <summary>
- Asynchronously create a new subfolder with the given name.
- </summary>
- <remarks>
- Asynchronously creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUses">A list of special uses for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="specialUses"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailService"/> does not support the creation of special folders.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Create(System.String,MailKit.SpecialFolder,System.Threading.CancellationToken)">
- <summary>
- Create a new subfolder with the given name.
- </summary>
- <remarks>
- Creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUse">The special use for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailService"/> does not support the creation of special folders.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CreateAsync(System.String,MailKit.SpecialFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously create a new subfolder with the given name.
- </summary>
- <remarks>
- Asynchronously creates a new subfolder with the given name.
- </remarks>
- <returns>The created folder.</returns>
- <param name="name">The name of the folder to create.</param>
- <param name="specialUse">The special use for the folder being created.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is empty.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailService"/> does not support the creation of special folders.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Rename(MailKit.IMailFolder,System.String,System.Threading.CancellationToken)">
- <summary>
- Rename the folder.
- </summary>
- <remarks>
- Renames the folder.
- </remarks>
- <param name="parent">The new parent folder.</param>
- <param name="name">The new name of the folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="parent"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="name"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="parent"/> does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- <para>-or-</para>
- <para><paramref name="name"/> is not a legal folder name.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The folder cannot be renamed (it is either a namespace or the Inbox).
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RenameAsync(MailKit.IMailFolder,System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously rename the folder.
- </summary>
- <remarks>
- Asynchronously renames the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="parent">The new parent folder.</param>
- <param name="name">The new name of the folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="parent"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="name"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="parent"/> does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- <para>-or-</para>
- <para><paramref name="name"/> is not a legal folder name.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The folder cannot be renamed (it is either a namespace or the Inbox).
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Delete(System.Threading.CancellationToken)">
- <summary>
- Delete the folder.
- </summary>
- <remarks>
- Deletes the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The folder cannot be deleted (it is either a namespace or the Inbox).
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.DeleteAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously delete the folder.
- </summary>
- <remarks>
- Asynchronously deletes the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The folder cannot be deleted (it is either a namespace or the Inbox).
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Subscribe(System.Threading.CancellationToken)">
- <summary>
- Subscribe to the folder.
- </summary>
- <remarks>
- Subscribes to the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SubscribeAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously subscribe to the folder.
- </summary>
- <remarks>
- Asynchronously subscribes to the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Unsubscribe(System.Threading.CancellationToken)">
- <summary>
- Unsubscribe from the folder.
- </summary>
- <remarks>
- Unsubscribes from the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.UnsubscribeAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously unsubscribe from the folder.
- </summary>
- <remarks>
- Asynchronously unsubscribes from the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetSubfolders(MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get the subfolders.
- </summary>
- <remarks>
- <para>Gets the subfolders as well as queries the server for the status of the requested items.</para>
- <para>When the <paramref name="items"/> argument is non-empty, this has the equivalent functionality
- of calling <see cref="M:MailKit.MailFolder.GetSubfolders(System.Boolean,System.Threading.CancellationToken)"/> and then calling
- <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> on each of the returned folders.</para>
- </remarks>
- <returns>The subfolders.</returns>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetSubfoldersAsync(MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the subfolders.
- </summary>
- <remarks>
- <para>Asynchronously gets the subfolders as well as queries the server for the status of the requested items.</para>
- <para>When the <paramref name="items"/> argument is non-empty, this has the equivalent functionality
- of calling <see cref="M:MailKit.MailFolder.GetSubfoldersAsync(System.Boolean,System.Threading.CancellationToken)"/> and then calling
- <see cref="M:MailKit.MailFolder.StatusAsync(MailKit.StatusItems,System.Threading.CancellationToken)"/> on each of the returned folders.</para>
- </remarks>
- <returns>The subfolders.</returns>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetSubfolders(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get the subfolders.
- </summary>
- <remarks>
- Gets the subfolders.
- </remarks>
- <returns>The subfolders.</returns>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetSubfoldersAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the subfolders.
- </summary>
- <remarks>
- Asynchronously gets the subfolders.
- </remarks>
- <returns>The subfolders.</returns>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetSubfolder(System.String,System.Threading.CancellationToken)">
- <summary>
- Get the specified subfolder.
- </summary>
- <remarks>
- Gets the specified subfolder.
- </remarks>
- <returns>The subfolder.</returns>
- <param name="name">The name of the subfolder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is either an empty string or contains the <see cref="P:MailKit.MailFolder.DirectorySeparator"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The requested folder could not be found.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetSubfolderAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the specified subfolder.
- </summary>
- <remarks>
- Asynchronously gets the specified subfolder.
- </remarks>
- <returns>The subfolder.</returns>
- <param name="name">The name of the subfolder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="name"/> is either an empty string or contains the <see cref="P:MailKit.MailFolder.DirectorySeparator"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The requested folder could not be found.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Check(System.Threading.CancellationToken)">
- <summary>
- Force the server to flush its state for the folder.
- </summary>
- <remarks>
- Forces the server to flush its state for the folder.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CheckAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously force the server to flush its state for the folder.
- </summary>
- <remarks>
- Asynchronously forces the server to flush its state for the folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)">
- <summary>
- Update the values of the specified items.
- </summary>
- <remarks>
- <para>Updates the values of the specified items.</para>
- <para>The <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> method
- MUST NOT be used on a folder that is already in the opened state. Instead, other ways
- of getting the desired information should be used.</para>
- <para>For example, a common use for the <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- method is to get the number of unread messages in the folder. When the folder is open, however, it is
- possible to use the <see cref="M:MailKit.MailFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)"/>
- method to query for the list of unread messages.</para>
- </remarks>
- <param name="items">The items to update.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the STATUS command.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.StatusAsync(MailKit.StatusItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously update the values of the specified items.
- </summary>
- <remarks>
- <para>Updates the values of the specified items.</para>
- <para>The <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> method
- MUST NOT be used on a folder that is already in the opened state. Instead, other ways
- of getting the desired information should be used.</para>
- <para>For example, a common use for the <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- method is to get the number of unread messages in the folder. When the folder is open, however, it is
- possible to use the <see cref="M:MailKit.MailFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)"/>
- method to query for the list of unread messages.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="items">The items to update.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the STATUS command.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetAccessControlList(System.Threading.CancellationToken)">
- <summary>
- Get the complete access control list for the folder.
- </summary>
- <remarks>
- Gets the complete access control list for the folder.
- </remarks>
- <returns>The access control list.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetAccessControlListAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the complete access control list for the folder.
- </summary>
- <remarks>
- Asynchronously gets the complete access control list for the folder.
- </remarks>
- <returns>The access control list.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetAccessRights(System.String,System.Threading.CancellationToken)">
- <summary>
- Get the access rights for a particular identifier.
- </summary>
- <remarks>
- Gets the access rights for a particular identifier.
- </remarks>
- <returns>The access rights.</returns>
- <param name="name">The identifier name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetAccessRightsAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the access rights for a particular identifier.
- </summary>
- <remarks>
- Asynchronously gets the access rights for a particular identifier.
- </remarks>
- <returns>The access rights.</returns>
- <param name="name">The identifier name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMyAccessRights(System.Threading.CancellationToken)">
- <summary>
- Get the access rights for the current authenticated user.
- </summary>
- <remarks>
- Gets the access rights for the current authenticated user.
- </remarks>
- <returns>The access rights.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMyAccessRightsAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the access rights for the current authenticated user.
- </summary>
- <remarks>
- Asynchronously gets the access rights for the current authenticated user.
- </remarks>
- <returns>The access rights.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Add access rights for the specified identity.
- </summary>
- <remarks>
- Adds the given access rights for the specified identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add access rights for the specified identity.
- </summary>
- <remarks>
- Asynchronously adds the given access rights for the specified identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Remove access rights for the specified identity.
- </summary>
- <remarks>
- Removes the given access rights for the specified identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove access rights for the specified identity.
- </summary>
- <remarks>
- Asynchronously removes the given access rights for the specified identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Set the access rights for the specified identity.
- </summary>
- <remarks>
- Sets the access rights for the specified identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the access rights for the specified identity.
- </summary>
- <remarks>
- Asynchronously sets the access rights for the specified identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="rights">The access rights.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="name"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="rights"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveAccess(System.String,System.Threading.CancellationToken)">
- <summary>
- Remove all access rights for the given identity.
- </summary>
- <remarks>
- Removes all access rights for the given identity.
- </remarks>
- <param name="name">The identity name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveAccessAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove all access rights for the given identity.
- </summary>
- <remarks>
- Asynchronously removes all access rights for the given identity.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="name">The identity name.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="name"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the ACL extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetQuota(System.Threading.CancellationToken)">
- <summary>
- Get the quota information for the folder.
- </summary>
- <remarks>
- <para>Gets the quota information for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The folder quota.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support quotas.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetQuotaAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the quota information for the folder.
- </summary>
- <remarks>
- <para>Asynchronously gets the quota information for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The folder quota.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support quotas.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetQuota(System.Nullable{System.UInt32},System.Nullable{System.UInt32},System.Threading.CancellationToken)">
- <summary>
- Set the quota limits for the folder.
- </summary>
- <remarks>
- <para>Sets the quota limits for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The updated folder quota.</returns>
- <param name="messageLimit">If not <c>null</c>, sets the maximum number of messages to allow.</param>
- <param name="storageLimit">If not <c>null</c>, sets the maximum storage size (in kilobytes).</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support quotas.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetQuotaAsync(System.Nullable{System.UInt32},System.Nullable{System.UInt32},System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the quota limits for the folder.
- </summary>
- <remarks>
- <para>Asynchronously sets the quota limits for the folder.</para>
- <para>To determine if a quotas are supported, check the
- <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
- </remarks>
- <returns>The updated folder quota.</returns>
- <param name="messageLimit">If not <c>null</c>, sets the maximum number of messages to allow.</param>
- <param name="storageLimit">If not <c>null</c>, sets the maximum storage size (in kilobytes).</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support quotas.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMetadata(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Get the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMetadataAsync(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMetadata(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Get the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="tags"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMetadataAsync(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="tags"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMetadata(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Get the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="tags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMetadataAsync(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="tags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetMetadata(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Sets the specified metadata.
- </summary>
- <remarks>
- Sets the specified metadata.
- </remarks>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="metadata"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetMetadataAsync(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sets the specified metadata.
- </summary>
- <remarks>
- Asynchronously sets the specified metadata.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="metadata"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Expunge(System.Threading.CancellationToken)">
- <summary>
- Expunge the folder, permanently removing all messages marked for deletion.
- </summary>
- <remarks>
- <para>Expunges the folder, permanently removing all messages marked for deletion.</para>
- <note type="note">Normally, an <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted for
- each message that is expunged. However, if the mail store supports the quick
- resynchronization feature and it has been enabled via the
- <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
- the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than the
- <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.ExpungeAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously expunge the folder, permanently removing all messages marked for deletion.
- </summary>
- <remarks>
- <para>Asynchronously expunges the folder, permanently removing all messages marked for deletion.</para>
- <note type="note">Normally, an <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted for
- each message that is expunged. However, if the mail store supports the quick
- resynchronization feature and it has been enabled via the
- <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
- the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than the
- <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Expunge(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Expunge the specified uids, permanently removing them from the folder.
- </summary>
- <remarks>
- <para>Expunges the specified uids, permanently removing them from the folder.</para>
- <note type="note">Normally, an <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted for
- each message that is expunged. However, if the mail store supports the quick
- resynchronization feature and it has been enabled via the
- <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
- the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than the
- <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <param name="uids">The message uids.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.ExpungeAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously expunge the specified uids, permanently removing them from the folder.
- </summary>
- <remarks>
- <para>Asynchronously expunges the specified uids, permanently removing them from the folder.</para>
- <note type="note">Normally, an <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted for
- each message that is expunged. However, if the mail store supports the quick
- resynchronization feature and it has been enabled via the
- <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
- the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than the
- <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The message uids.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- One or more <paramref name="annotations"/> does not define any properties.
- </exception>"
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- One or more <paramref name="annotations"/> does not define any properties.
- </exception>"
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified message to the folder.
- </summary>
- <remarks>
- Appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified message to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
- </remarks>
- <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="flags">The message flags.</param>
- <param name="date">The received date of the message.</param>
- <param name="annotations">The message annotations.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="messages">The array of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages does not match the number of flags.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="messages">The array of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages does not match the number of flags.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="messages">The array of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="dates"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages, flags, and dates do not match.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="messages">The array of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="dates"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages, flags, and dates do not match.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The array of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages does not match the number of flags.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The array of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages does not match the number of flags.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Append(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Append the specified messages to the folder.
- </summary>
- <remarks>
- Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The array of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="dates"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages, flags, and dates do not match.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously append the specified messages to the folder.
- </summary>
- <remarks>
- Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
- </remarks>
- <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
- <param name="options">The formatting options.</param>
- <param name="messages">The array of messages to append to the folder.</param>
- <param name="flags">The message flags to use for each of the messages.</param>
- <param name="dates">The received dates to use for each of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="flags"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="dates"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="messages"/> is null.</para>
- <para>-or-</para>
- <para>The number of messages, flags, and dates do not match.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The <see cref="T:MailKit.MailFolder"/> does not exist.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Internationalized formatting was requested but has not been enabled.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.NotSupportedException">
- Internationalized formatting was requested but is not supported by the server.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CopyTo(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified message to the destination folder.
- </summary>
- <remarks>
- Copies the specified message to the destination folder.
- </remarks>
- <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
- <param name="uid">The UID of the message to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="destination"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CopyToAsync(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified message to the destination folder.
- </summary>
- <remarks>
- Asynchronously copies the specified message to the destination folder.
- </remarks>
- <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
- <param name="uid">The UID of the message to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="destination"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CopyTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Copies the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CopyToAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Asynchronously copies the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.MoveTo(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified message to the destination folder.
- </summary>
- <remarks>
- Moves the specified message to the destination folder.
- </remarks>
- <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
- <param name="uid">The UID of the message to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="destination"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.MoveToAsync(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified message to the destination folder.
- </summary>
- <remarks>
- Asynchronously moves the specified message to the destination folder.
- </remarks>
- <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
- <param name="uid">The UID of the message to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="destination"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.MoveTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified messages to the destination folder.
- </summary>
- <remarks>
- Moves the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.MoveToAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified messages to the destination folder.
- </summary>
- <remarks>
- Asynchronously moves the specified messages to the destination folder.
- </remarks>
- <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
- <param name="uids">The UIDs of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support the UIDPLUS extension.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CopyTo(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified message to the destination folder.
- </summary>
- <remarks>
- Copies the specified message to the destination folder.
- </remarks>
- <param name="index">The index of the message to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="destination"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> does not refer to a valid message index.
- </exception>
- <exception cref="T:System.ArgumentException">
- The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CopyToAsync(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified message to the destination folder.
- </summary>
- <remarks>
- Asynchronously copies the specified message to the destination folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The indexes of the message to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="destination"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> does not refer to a valid message index.
- </exception>
- <exception cref="T:System.ArgumentException">
- The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CopyTo(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Copies the specified messages to the destination folder.
- </remarks>
- <param name="indexes">The indexes of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.CopyToAsync(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously copy the specified messages to the destination folder.
- </summary>
- <remarks>
- Asynchronously copies the specified messages to the destination folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages to copy.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.MoveTo(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified message to the destination folder.
- </summary>
- <remarks>
- Moves the specified message to the destination folder.
- </remarks>
- <param name="index">The index of the message to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="destination"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> does not refer to a valid message index.
- </exception>
- <exception cref="T:System.ArgumentException">
- The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.MoveToAsync(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified message to the destination folder.
- </summary>
- <remarks>
- Asynchronously moves the specified message to the destination folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="destination"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> does not refer to a valid message index.
- </exception>
- <exception cref="T:System.ArgumentException">
- The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.MoveTo(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Move the specified messages to the destination folder.
- </summary>
- <remarks>
- Moves the specified messages to the destination folder.
- </remarks>
- <param name="indexes">The indexes of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.MoveToAsync(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
- <summary>
- Asynchronously move the specified messages to the destination folder.
- </summary>
- <remarks>
- Asynchronously moves the specified messages to the destination folder.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages to move.</param>
- <param name="destination">The destination folder.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- UIDs.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailStore"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailStore"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailStore"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailStore"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailStore"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message UIDs that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message UIDs that
- have a higher mod-sequence value than the one specified.</para>
- <para>If the mail store supports quick resynchronization and the application has
- enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
- then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages that
- have vanished since the specified mod-sequence value.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="uids">The UIDs.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailStore"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes that have a
- higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes that have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="items"/> is empty.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes that have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the specified message indexes that
- have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the specified message
- indexes that have a higher mod-sequence value than the one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="indexes">The indexes.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="headers"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="items"/> is empty.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="items"/> is empty.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the specified <paramref name="headers"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes, inclusive.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the specified <paramref name="headers"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="items"/> is empty.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes
- (inclusive) that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes (inclusive) that have a higher mod-sequence value than the
- one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="items"/> is empty.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes
- (inclusive) that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes (inclusive) that have a higher mod-sequence value than the
- one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Fetch the message summaries for the messages between the two indexes (inclusive)
- that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Fetches the message summaries for the messages between the two
- indexes (inclusive) that have a higher mod-sequence value than the one
- specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the specified <paramref name="headers"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
- <summary>
- Asynchronously fetch the message summaries for the messages between the two indexes
- (inclusive) that have a higher mod-sequence value than the one specified.
- </summary>
- <remarks>
- <para>Asynchronously fetches the message summaries for the messages between
- the two indexes (inclusive) that have a higher mod-sequence value than the
- one specified.</para>
- <para>It should be noted that if another client has modified any message
- in the folder, the mail service may choose to return information that was
- not explicitly requested. It is therefore important to be prepared to
- handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
- messages that were requested as well as summaries for messages that were
- not requested at all.</para>
- </remarks>
- <returns>An enumeration of summaries for the requested messages.</returns>
- <param name="min">The minimum index.</param>
- <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="items">The message summary items to fetch.</param>
- <param name="headers">The desired header fields.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="min"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="max"/> is out of range.</para>
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="headers"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the specified <paramref name="headers"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetHeaders(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message headers.
- </summary>
- <remarks>
- Gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetHeadersAsync(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message headers.
- </summary>
- <remarks>
- Asynchronously gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetHeaders(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetHeadersAsync(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Asynchronously gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetHeaders(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message headers.
- </summary>
- <remarks>
- Gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetHeadersAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message headers.
- </summary>
- <remarks>
- Asynchronously gets the specified message headers.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetHeaders(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part headers.
- </summary>
- <remarks>
- Gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetHeadersAsync(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part headers.
- </summary>
- <remarks>
- Asynchronously gets the specified body part headers.
- </remarks>
- <returns>The body part headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested body part headers.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message.
- </summary>
- <remarks>
- Gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMessageAsync(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message.
- </summary>
- <remarks>
- Asynchronously gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified message.
- </summary>
- <remarks>
- Gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetMessageAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified message.
- </summary>
- <remarks>
- Asynchronously gets the specified message.
- </remarks>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetBodyPart(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetBodyPartAsync(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Asynchronously gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetBodyPart(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the specified body part.
- </summary>
- <remarks>
- Gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetBodyPartAsync(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the specified body part.
- </summary>
- <remarks>
- Asynchronously gets the specified body part.
- </remarks>
- <returns>The body part.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The body part.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message body.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStream(MailKit.UniqueId,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- Gets a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStreamAsync(MailKit.UniqueId,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- Asynchronously gets a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStream(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- Gets a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStreamAsync(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- Asynchronously gets a substream of the message. If the starting offset is beyond
- the end of the message, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the message, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStream(MailKit.UniqueId,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified body part.
- </summary>
- <remarks>
- Gets a substream of the body part. If the starting offset is beyond
- the end of the body part, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the body part, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The desired body part.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStreamAsync(MailKit.UniqueId,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified body part.
- </summary>
- <remarks>
- Asynchronously gets a substream of the body part. If the starting offset is beyond
- the end of the body part, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the body part, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="part">The desired body part.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStream(System.Int32,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified body part.
- </summary>
- <remarks>
- Gets a substream of the body part. If the starting offset is beyond
- the end of the body part, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the body part, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The desired body part.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStreamAsync(System.Int32,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified body part.
- </summary>
- <remarks>
- Asynchronously gets a substream of the body part. If the starting offset is beyond
- the end of the body part, an empty stream is returned. If the number of
- bytes desired extends beyond the end of the body part, a truncated stream
- will be returned.
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="part">The desired body part.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="part"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStream(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStreamAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- <para>Asynchronously gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStream(MailKit.UniqueId,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message. If the starting offset is beyond
- the end of the specified section of the message, an empty stream is returned. If
- the number of bytes desired extends beyond the end of the section, a truncated
- stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStreamAsync(MailKit.UniqueId,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified message.
- </summary>
- <remarks>
- <para>Asynchronously gets a substream of the specified message. If the starting
- offset is beyond the end of the specified section of the message, an empty stream
- is returned. If the number of bytes desired extends beyond the end of the section,
- a truncated stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStream(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStreamAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified body part.
- </summary>
- <remarks>
- <para>Asynchronously gets a substream of the specified message.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStream(System.Int32,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get a substream of the specified message.
- </summary>
- <remarks>
- <para>Gets a substream of the specified message. If the starting offset is beyond
- the end of the specified section of the message, an empty stream is returned. If
- the number of bytes desired extends beyond the end of the section, a truncated
- stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.GetStreamAsync(System.Int32,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get a substream of the specified body part.
- </summary>
- <remarks>
- <para>Asynchronously gets a substream of the specified message. If the starting
- offset is beyond the end of the specified section of the message, an empty stream
- is returned. If the number of bytes desired extends beyond the end of the section,
- a truncated stream will be returned.</para>
- <para>For more information about how to construct the <paramref name="section"/>,
- see Section 6.4.5 of RFC3501.</para>
- </remarks>
- <returns>The stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="section">The desired section of the message.</param>
- <param name="offset">The starting offset of the first desired byte.</param>
- <param name="count">The number of bytes desired.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="section"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="index"/> is out of range.</para>
- <para>-or-</para>
- <para><paramref name="offset"/> is negative.</para>
- <para>-or-</para>
- <para><paramref name="count"/> is negative.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:MailKit.MessageNotFoundException">
- The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified message.
- </summary>
- <remarks>
- Adds a set of flags to the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified message.
- </summary>
- <remarks>
- Adds a set of flags to the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified message.
- </summary>
- <remarks>
- Removes a set of flags from the specified message.
- </remarks>
- <param name="uid">The UIDs of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified message.
- </summary>
- <remarks>
- Removes a set of flags from the specified message.
- </remarks>
- <param name="uid">The UIDs of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified message.
- </summary>
- <remarks>
- Sets the flags of the specified message.
- </remarks>
- <param name="uid">The UIDs of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified message.
- </summary>
- <remarks>
- Sets the flags of the specified message.
- </remarks>
- <param name="uid">The UIDs of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified message.
- </summary>
- <remarks>
- Adds a set of flags to the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified message.
- </summary>
- <remarks>
- Adds a set of flags to the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified message.
- </summary>
- <remarks>
- Removes a set of flags from the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified message.
- </summary>
- <remarks>
- Removes a set of flags from the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified message.
- </summary>
- <remarks>
- Sets the flags of the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified message.
- </summary>
- <remarks>
- Sets the flags of the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages.
- </summary>
- <remarks>
- Sets the flags of the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to add.</param>
- <param name="keywords">A set of user-defined flags to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to remove.</param>
- <param name="keywords">A set of user-defined flags to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No flags were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="flags">The message flags to set.</param>
- <param name="keywords">A set of user-defined flags to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabels(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified message.
- </summary>
- <remarks>
- Adds a set of labels to the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabelsAsync(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabels(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified message.
- </summary>
- <remarks>
- Removes a set of labels from the specified message.
- </remarks>
- <param name="uid">The UIDs of the message.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabelsAsync(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uid"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabels(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified message.
- </summary>
- <remarks>
- Sets the labels of the specified message.
- </remarks>
- <param name="uid">The UIDs of the message.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabelsAsync(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages.
- </summary>
- <remarks>
- Sets the labels of the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabels(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified message.
- </summary>
- <remarks>
- Adds a set of labels to the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabelsAsync(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified message.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabels(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified message.
- </summary>
- <remarks>
- Removes a set of labels from the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabelsAsync(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified message.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabels(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified message.
- </summary>
- <remarks>
- Sets the labels of the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabelsAsync(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified message.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="index"/> is invalid.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages.
- </summary>
- <remarks>
- Sets the labels of the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.AddLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to add.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to remove.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> is invalid.</para>
- <para>-or-</para>
- <para>No labels were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SetLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="labels">The labels to set.</param>
- <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="labels"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Store(MailKit.UniqueId,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified message.
- </summary>
- <remarks>
- Stores the annotations for the specified message.
- </remarks>
- <param name="uid">The UID of the message.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="annotations"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.StoreAsync(MailKit.UniqueId,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified message.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uid">The UID of the message.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="annotations"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Store(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages.
- </summary>
- <remarks>
- Stores the annotations for the specified messages.
- </remarks>
- <param name="uids">The UIDs of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.StoreAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Store(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>The <see cref="T:MailKit.IMailFolder"/> does not support annotations.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.IMailFolder"/> does not support mod-sequences.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.StoreAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The unique IDs of the messages that were not updated.</returns>
- <param name="uids">The UIDs of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="uids"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>The <see cref="T:MailKit.IMailFolder"/> does not support annotations.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.IMailFolder"/> does not support mod-sequences.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Store(System.Int32,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified message.
- </summary>
- <remarks>
- Stores the annotations for the specified message.
- </remarks>
- <param name="index">The index of the message.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="annotations"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="index"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.StoreAsync(System.Int32,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified message.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified message.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The indexes of the message.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="annotations"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="index"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Store(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages.
- </summary>
- <remarks>
- Stores the annotations for the specified messages.
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.StoreAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Store(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>The <see cref="T:MailKit.IMailFolder"/> does not support annotations.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.IMailFolder"/> does not support mod-sequences.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.StoreAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
- <summary>
- Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
- </summary>
- <remarks>
- Asynchronously stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.s
- </remarks>
- <returns>The indexes of the messages that were not updated.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="modseq">The mod-sequence value.</param>
- <param name="annotations">The annotations to store.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="indexes"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="annotations"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the <paramref name="indexes"/> is invalid.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Cannot store annotations without any properties defined.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>The <see cref="T:MailKit.IMailFolder"/> does not support annotations.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.IMailFolder"/> does not support mod-sequences.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- One or more search terms in the <paramref name="query"/> are not supported by the mail store.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SearchAsync(MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs.</returns>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- One or more search terms in the <paramref name="query"/> are not supported by the mail store.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Search(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the subset of UIDs in the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- One or more search terms in the <paramref name="query"/> are not supported by the mail store.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SearchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the subset of UIDs in the folder for messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- One or more search terms in the <paramref name="query"/> are not supported.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Search(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support the specified search options.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.MailFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SearchAsync(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the folder for messages matching the specified query.
- </summary>
- <remarks>
- Asynchronously searches the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support the specified search options.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.MailFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Search(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Search the subset of UIDs in the folder for messages matching the specified query.
- </summary>
- <remarks>
- Searches the fsubset of UIDs in the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support the specified search options.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SearchAsync(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously search the subset of UIDs in the folder for messages matching the specified query.
- </summary>
- <remarks>
- Asynchronously searches the fsubset of UIDs in the folder for messages matching the specified query,
- returning only the specified search results.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support the specified search options.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Sort(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- /// <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="orderBy"/> is empty.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support sorting search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SortAsync(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="orderBy"/> is empty.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support sorting search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Sort(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is empty.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support sorting search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SortAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- The returned array of unique identifiers will be sorted in the preferred order and
- can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of matching UIDs in the specified sort order.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is empty.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support sorting search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Sort(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="orderBy"/> is empty.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support the specified search options.</para>
- <para>-or-</para>
- <para>The server does not support sorting search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.MailFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SortAsync(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query.
- </summary>
- <remarks>
- Asynchronously searches the folder for messages matching the specified query, returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="orderBy"/> is empty.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support the specified search options.</para>
- <para>-or-</para>
- <para>The server does not support sorting search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The <see cref="T:MailKit.MailFolder"/> is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Sort(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Sort messages matching the specified query.
- </summary>
- <remarks>
- Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is empty.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support the specified search options.</para>
- <para>-or-</para>
- <para>The server does not support sorting search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.SortAsync(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
- <summary>
- Asynchronously sort messages matching the specified query, returning the search results in the specified sort order.
- </summary>
- <remarks>
- Asynchronously searches the folder for messages matching the specified query,
- returning the search results in the specified sort order.
- </remarks>
- <returns>The search results.</returns>
- <param name="options">The search options.</param>
- <param name="uids">The subset of UIDs</param>
- <param name="query">The search query.</param>
- <param name="orderBy">The sort order.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is empty.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support the specified search options.</para>
- <para>-or-</para>
- <para>The server does not support sorting search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Thread(MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not supported.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support threading search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.ThreadAsync(MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not supported.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="query"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support threading search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.Thread(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not supported.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support threading search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.ThreadAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
- <summary>
- Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
- </summary>
- <remarks>
- The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
- <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
- </remarks>
- <returns>An array of message threads.</returns>
- <param name="uids">The subset of UIDs</param>
- <param name="algorithm">The threading algorithm to use.</param>
- <param name="query">The search query.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not supported.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="uids"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="query"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="uids"/> is empty.</para>
- <para>-or-</para>
- <para>One or more of the <paramref name="uids"/> is invalid.</para>
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
- <para>-or-</para>
- <para>The server does not support threading search results.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="E:MailKit.MailFolder.Opened">
- <summary>
- Occurs when the folder is opened.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.Opened"/> event is emitted when the folder is opened.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnOpened">
- <summary>
- Raise the opened event.
- </summary>
- <remarks>
- Raises the opened event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.Closed">
- <summary>
- Occurs when the folder is closed.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.Closed"/> event is emitted when the folder is closed.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnClosed">
- <summary>
- Raise the closed event.
- </summary>
- <remarks>
- Raises the closed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.Deleted">
- <summary>
- Occurs when the folder is deleted.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.Deleted"/> event is emitted when the folder is deleted.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnDeleted">
- <summary>
- Raise the deleted event.
- </summary>
- <remarks>
- Raises the deleted event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.Renamed">
- <summary>
- Occurs when the folder is renamed.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.Renamed"/> event is emitted when the folder is renamed.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnRenamed(System.String,System.String)">
- <summary>
- Raise the renamed event.
- </summary>
- <remarks>
- Raises the renamed event.
- </remarks>
- <param name="oldName">The old name of the folder.</param>
- <param name="newName">The new name of the folder.</param>
- </member>
- <member name="M:MailKit.MailFolder.OnParentFolderRenamed">
- <summary>
- Notifies the folder that a parent folder has been renamed.
- </summary>
- <remarks>
- <see cref="T:MailKit.IMailFolder"/> implementations should override this method
- to update their state (such as updating their <see cref="P:MailKit.MailFolder.FullName"/>
- property).
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.Subscribed">
- <summary>
- Occurs when the folder is subscribed.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.Subscribed"/> event is emitted when the folder is subscribed.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnSubscribed">
- <summary>
- Raise the subscribed event.
- </summary>
- <remarks>
- Raises the subscribed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.Unsubscribed">
- <summary>
- Occurs when the folder is unsubscribed.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.Unsubscribed"/> event is emitted when the folder is unsubscribed.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnUnsubscribed">
- <summary>
- Raise the unsubscribed event.
- </summary>
- <remarks>
- Raises the unsubscribed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.MessageExpunged">
- <summary>
- Occurs when a message is expunged from the folder.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.MessageExpunged"/> event is emitted when a message is expunged from the folder.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- </member>
- <member name="M:MailKit.MailFolder.OnMessageExpunged(MailKit.MessageEventArgs)">
- <summary>
- Raise the message expunged event.
- </summary>
- <remarks>
- Raises the message expunged event.
- </remarks>
- <param name="args">The message expunged event args.</param>
- </member>
- <member name="E:MailKit.MailFolder.MessagesVanished">
- <summary>
- Occurs when a message vanishes from the folder.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.MessagesVanished"/> event is emitted when messages vanish from the folder.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnMessagesVanished(MailKit.MessagesVanishedEventArgs)">
- <summary>
- Raise the messages vanished event.
- </summary>
- <remarks>
- Raises the messages vanished event.
- </remarks>
- <param name="args">The messages vanished event args.</param>
- </member>
- <member name="E:MailKit.MailFolder.MessageFlagsChanged">
- <summary>
- Occurs when flags changed on a message.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> event is emitted when the flags for a message are changed.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- </member>
- <member name="M:MailKit.MailFolder.OnMessageFlagsChanged(MailKit.MessageFlagsChangedEventArgs)">
- <summary>
- Raise the message flags changed event.
- </summary>
- <remarks>
- Raises the message flags changed event.
- </remarks>
- <param name="args">The message flags changed event args.</param>
- </member>
- <member name="E:MailKit.MailFolder.MessageLabelsChanged">
- <summary>
- Occurs when labels changed on a message.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> event is emitted when the labels for a message are changed.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnMessageLabelsChanged(MailKit.MessageLabelsChangedEventArgs)">
- <summary>
- Raise the message labels changed event.
- </summary>
- <remarks>
- Raises the message labels changed event.
- </remarks>
- <param name="args">The message labels changed event args.</param>
- </member>
- <member name="E:MailKit.MailFolder.AnnotationsChanged">
- <summary>
- Occurs when annotations changed on a message.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.AnnotationsChanged"/> event is emitted when the annotations for a message are changed.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnAnnotationsChanged(MailKit.AnnotationsChangedEventArgs)">
- <summary>
- Raise the message annotations changed event.
- </summary>
- <remarks>
- Raises the message annotations changed event.
- </remarks>
- <param name="args">The message annotations changed event args.</param>
- </member>
- <member name="E:MailKit.MailFolder.MessageSummaryFetched">
- <summary>
- Occurs when a message summary is fetched from the folder.
- </summary>
- <remarks>
- <para>Emitted when a message summary is fetched from the folder.</para>
- <para>When multiple message summaries are being fetched from a remote folder,
- it is possible that the connection will drop or some other exception will
- occur, causing the Fetch method to fail and lose all of the data that has been
- downloaded up to that point, requiring the client to request the same set of
- message summaries all over again after it reconnects. This is obviously
- inefficient. To alleviate this potential problem, this event will be emitted
- as soon as the <see cref="T:MailKit.IMailFolder"/> successfully parses each untagged FETCH
- response from the server, allowing the client to commit this data immediately to
- its local cache.</para>
- <note type="note">Depending on the IMAP server, it is possible that the
- <see cref="E:MailKit.MailFolder.MessageSummaryFetched"/> event will be emitted for the same message
- multiple times if the IMAP server happens to split the requested fields into
- multiple untagged FETCH responses. Use the <see cref="P:MailKit.IMessageSummary.Fields"/>
- property to determine which f<see cref="T:MailKit.IMessageSummary"/> properties have
- been populated.</note>
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnMessageSummaryFetched(MailKit.IMessageSummary)">
- <summary>
- Raise the message summary fetched event.
- </summary>
- <remarks>
- <para>Raises the message summary fetched event.</para>
- <para>When multiple message summaries are being fetched from a remote folder,
- it is possible that the connection will drop or some other exception will
- occur, causing the Fetch method to fail and lose all of the data that has been
- downloaded up to that point, requiring the client to request the same set of
- message summaries all over again after it reconnects. This is obviously
- inefficient. To alleviate this potential problem, this event will be emitted
- as soon as the <see cref="T:MailKit.IMailFolder"/> successfully parses each untagged FETCH
- response from the server, allowing the client to commit this data immediately to
- its local cache.</para>
- <note type="note">Depending on the IMAP server, it is possible that
- <see cref="M:MailKit.MailFolder.OnMessageSummaryFetched(MailKit.IMessageSummary)"/> will be invoked for the same message
- multiple times if the IMAP server happens to split the requested fields into
- multiple untagged FETCH responses. Use the <see cref="P:MailKit.IMessageSummary.Fields"/>
- property to determine which f<see cref="T:MailKit.IMessageSummary"/> properties have
- been populated.</note>
- </remarks>
- <param name="message">The message summary.</param>
- </member>
- <member name="E:MailKit.MailFolder.MetadataChanged">
- <summary>
- Occurs when metadata changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.MetadataChanged"/> event is emitted when metadata changes.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnMetadataChanged(MailKit.Metadata)">
- <summary>
- Raise the metadata changed event.
- </summary>
- <remarks>
- Raises the metadata changed event.
- </remarks>
- <param name="metadata">The metadata that changed.</param>
- </member>
- <member name="E:MailKit.MailFolder.ModSeqChanged">
- <summary>
- Occurs when the mod-sequence changed on a message.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.ModSeqChanged"/> event is emitted when the mod-sequence for a message is changed.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnModSeqChanged(MailKit.ModSeqChangedEventArgs)">
- <summary>
- Raise the message mod-sequence changed event.
- </summary>
- <remarks>
- Raises the message mod-sequence changed event.
- </remarks>
- <param name="args">The mod-sequence changed event args.</param>
- </member>
- <member name="E:MailKit.MailFolder.HighestModSeqChanged">
- <summary>
- Occurs when the highest mod-sequence changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.HighestModSeqChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.HighestModSeq"/> value changes.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnHighestModSeqChanged">
- <summary>
- Raise the highest mod-sequence changed event.
- </summary>
- <remarks>
- Raises the highest mod-sequence changed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.UidNextChanged">
- <summary>
- Occurs when the next UID changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.UidNextChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.UidNext"/> value changes.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnUidNextChanged">
- <summary>
- Raise the next UID changed event.
- </summary>
- <remarks>
- Raises the next UID changed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.UidValidityChanged">
- <summary>
- Occurs when the UID validity changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.UidValidityChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.UidValidity"/> value changes.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnUidValidityChanged">
- <summary>
- Raise the uid validity changed event.
- </summary>
- <remarks>
- Raises the uid validity changed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.IdChanged">
- <summary>
- Occurs when the folder ID changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.IdChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.Id"/> value changes.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnIdChanged">
- <summary>
- Raise the ID changed event.
- </summary>
- <remarks>
- Raises the ID changed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.SizeChanged">
- <summary>
- Occurs when the folder size changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.SizeChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.Size"/> value changes.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnSizeChanged">
- <summary>
- Raise the size changed event.
- </summary>
- <remarks>
- Raises the size changed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.CountChanged">
- <summary>
- Occurs when the message count changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.CountChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.Count"/> value changes.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapIdleExample.cs"/>
- </example>
- </member>
- <member name="M:MailKit.MailFolder.OnCountChanged">
- <summary>
- Raise the message count changed event.
- </summary>
- <remarks>
- Raises the message count changed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.RecentChanged">
- <summary>
- Occurs when the recent message count changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.RecentChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.Recent"/> value changes.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnRecentChanged">
- <summary>
- Raise the recent message count changed event.
- </summary>
- <remarks>
- Raises the recent message count changed event.
- </remarks>
- </member>
- <member name="E:MailKit.MailFolder.UnreadChanged">
- <summary>
- Occurs when the unread message count changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailFolder.UnreadChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.Unread"/> value changes.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.OnUnreadChanged">
- <summary>
- Raise the unread message count changed event.
- </summary>
- <remarks>
- Raises the unread message count changed event.
- </remarks>
- </member>
- <member name="M:MailKit.MailFolder.GetEnumerator">
- <summary>
- Get an enumerator for the messages in the folder.
- </summary>
- <remarks>
- Gets an enumerator for the messages in the folder.
- </remarks>
- <returns>The enumerator.</returns>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Get an enumerator for the messages in the folder.
- </summary>
- <remarks>
- Gets an enumerator for the messages in the folder.
- </remarks>
- <returns>The enumerator.</returns>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotOpenException">
- The folder is not currently open.
- </exception>
- </member>
- <member name="M:MailKit.MailFolder.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.MailFolder"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.MailFolder"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.MailFolder"/>.</returns>
- </member>
- <member name="T:MailKit.MailService">
- <summary>
- An abstract mail service implementation.
- </summary>
- <remarks>
- An abstract mail service implementation.
- </remarks>
- </member>
- <member name="M:MailKit.MailService.#ctor(MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MailService"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.MailService"/> class.
- </remarks>
- <param name="protocolLogger">The protocol logger.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="protocolLogger"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.MailService.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MailService"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.MailService"/> class.
- </remarks>
- </member>
- <member name="M:MailKit.MailService.Finalize">
- <summary>
- Releases unmanaged resources and performs other cleanup operations before the
- <see cref="T:MailKit.MailService"/> is reclaimed by garbage collection.
- </summary>
- <remarks>
- Releases unmanaged resources and performs other cleanup operations before the
- <see cref="T:MailKit.MailService"/> is reclaimed by garbage collection.
- </remarks>
- </member>
- <member name="P:MailKit.MailService.SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the service.
- </summary>
- <remarks>
- <para>Gets an object that can be used to synchronize access to the service.</para>
- </remarks>
- <value>The sync root.</value>
- </member>
- <member name="P:MailKit.MailService.Protocol">
- <summary>
- Gets the protocol supported by the message service.
- </summary>
- <remarks>
- Gets the protocol supported by the message service.
- </remarks>
- <value>The protocol.</value>
- </member>
- <member name="P:MailKit.MailService.ProtocolLogger">
- <summary>
- Get the protocol logger.
- </summary>
- <remarks>
- Gets the protocol logger.
- </remarks>
- <value>The protocol logger.</value>
- </member>
- <member name="P:MailKit.MailService.SslProtocols">
- <summary>
- Gets or sets the SSL and TLS protocol versions that the client is allowed to use.
- </summary>
- <remarks>
- <para>Gets or sets the SSL and TLS protocol versions that the client is allowed to use.</para>
- <para>By default, MailKit initializes this value to support only TLS v1.1 and greater and
- does not support TLS v1.0 or any version of SSL due to those protocols no longer being considered
- secure.</para>
- <para>This property should be set before calling any of the
- <a href="Overload_MailKit_MailService_Connect.htm">Connect</a> methods.</para>
- </remarks>
- <value>The SSL and TLS protocol versions that are supported.</value>
- </member>
- <member name="P:MailKit.MailService.ClientCertificates">
- <summary>
- Gets or sets the client SSL certificates.
- </summary>
- <remarks>
- <para>Some servers may require the client SSL certificates in order
- to allow the user to connect.</para>
- <para>This property should be set before calling any of the
- <a href="Overload_MailKit_MailService_Connect.htm">Connect</a> methods.</para>
- </remarks>
- <value>The client SSL certificates.</value>
- </member>
- <member name="P:MailKit.MailService.CheckCertificateRevocation">
- <summary>
- Get or set whether connecting via SSL/TLS should check certificate revocation.
- </summary>
- <remarks>
- <para>Gets or sets whether connecting via SSL/TLS should check certificate revocation.</para>
- <para>Normally, the value of this property should be set to <c>true</c> (the default) for security
- reasons, but there are times when it may be necessary to set it to <c>false</c>.</para>
- <para>For example, most Certificate Authorities are probably pretty good at keeping their CRL and/or
- OCSP servers up 24/7, but occasionally they do go down or are otherwise unreachable due to other
- network problems between the client and the Certificate Authority. When this happens, it becomes
- impossible to check the revocation status of one or more of the certificates in the chain
- resulting in an <see cref="T:MailKit.Security.SslHandshakeException"/> being thrown in the
- <a href="Overload_MailKit_MailService_Connect.htm">Connect</a> method. If this becomes a problem,
- it may become desirable to set <see cref="P:MailKit.MailService.CheckCertificateRevocation"/> to <c>false</c>.</para>
- </remarks>
- <value><c>true</c> if certificate revocation should be checked; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailService.ServerCertificateValidationCallback">
- <summary>
- Get or sets a callback function to validate the server certificate.
- </summary>
- <remarks>
- <para>Gets or sets a callback function to validate the server certificate.</para>
- <para>This property should be set before calling any of the
- <a href="Overload_MailKit_MailService_Connect.htm">Connect</a> methods.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\SslCertificateValidation.cs"/>
- </example>
- <value>The server certificate validation callback function.</value>
- </member>
- <member name="P:MailKit.MailService.LocalEndPoint">
- <summary>
- Get or set the local IP end point to use when connecting to the remote host.
- </summary>
- <remarks>
- Gets or sets the local IP end point to use when connecting to the remote host.
- </remarks>
- <value>The local IP end point or <c>null</c> to use the default end point.</value>
- </member>
- <member name="P:MailKit.MailService.ProxyClient">
- <summary>
- Get or set the proxy client to use when connecting to a remote host.
- </summary>
- <remarks>
- Gets or sets the proxy client to use when connecting to a remote host via any of the
- <a href="Overload_MailKit_MailService_Connect.htm">Connect</a> methods.
- </remarks>
- <value>The proxy client.</value>
- </member>
- <member name="P:MailKit.MailService.AuthenticationMechanisms">
- <summary>
- Gets the authentication mechanisms supported by the mail server.
- </summary>
- <remarks>
- The authentication mechanisms are queried as part of the
- <a href="Overload_MailKit_MailService_Connect.htm">Connect</a> method.
- </remarks>
- <value>The authentication mechanisms.</value>
- </member>
- <member name="P:MailKit.MailService.IsConnected">
- <summary>
- Gets whether or not the client is currently connected to an mail server.
- </summary>
- <remarks>
- <para>The <see cref="P:MailKit.MailService.IsConnected"/> state is set to <c>true</c> immediately after
- one of the <a href="Overload_MailKit_MailService_Connect.htm">Connect</a>
- methods succeeds and is not set back to <c>false</c> until either the client
- is disconnected via <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> or until a
- <see cref="T:MailKit.ProtocolException"/> is thrown while attempting to read or write to
- the underlying network socket.</para>
- <para>When an <see cref="T:MailKit.ProtocolException"/> is caught, the connection state of the
- <see cref="T:MailKit.MailService"/> should be checked before continuing.</para>
- </remarks>
- <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailService.IsSecure">
- <summary>
- Get whether or not the connection is secure (typically via SSL or TLS).
- </summary>
- <remarks>
- Gets whether or not the connection is secure (typically via SSL or TLS).
- </remarks>
- <value><c>true</c> if the connection is secure; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailService.IsAuthenticated">
- <summary>
- Get whether or not the client is currently authenticated with the mail server.
- </summary>
- <remarks>
- <para>Gets whether or not the client is currently authenticated with the mail server.</para>
- <para>To authenticate with the mail server, use one of the
- <a href="Overload_MailKit_MailService_Authenticate.htm">Authenticate</a> methods
- or any of the Async alternatives.</para>
- </remarks>
- <value><c>true</c> if the client is authenticated; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailService.Timeout">
- <summary>
- Gets or sets the timeout for network streaming operations, in milliseconds.
- </summary>
- <remarks>
- Gets or sets the underlying socket stream's <see cref="P:System.IO.Stream.ReadTimeout"/>
- and <see cref="P:System.IO.Stream.WriteTimeout"/> values.
- </remarks>
- <value>The timeout in milliseconds.</value>
- </member>
- <!-- Badly formed XML comment ignored for member "M:MailKit.MailService.DefaultServerCertificateValidationCallback(System.Object,System.Security.Cryptography.X509Certificates.X509Certificate,System.Security.Cryptography.X509Certificates.X509Chain,System.Net.Security.SslPolicyErrors)" -->
- <member name="M:MailKit.MailService.Connect(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified mail server.
- </summary>
- <remarks>
- Establishes a connection to the specified mail server.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
- </example>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.ConnectAsync(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified mail server.
- </summary>
- <remarks>
- Asynchronously establishes a connection to the specified mail server.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Connect(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified mail server using the provided socket.
- </summary>
- <remarks>
- <para>Establish a connection to the specified mail server using the provided socket.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- <para>The <paramref name="host"/> is a zero-length string.</para>
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.MailService.ConnectAsync(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified mail server using the provided socket.
- </summary>
- <remarks>
- <para>Asynchronously establishes a connection to the specified mail server using the provided socket.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="socket">The socket to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="socket"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="socket"/> is not connected.</para>
- <para>-or-</para>
- <para>The <paramref name="host"/> is a zero-length string.</para>
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Connect(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified mail server using the provided stream.
- </summary>
- <remarks>
- <para>Establish a connection to the specified mail server using the provided stream.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <param name="stream">The stream to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.MailService.ConnectAsync(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified mail server using the provided stream.
- </summary>
- <remarks>
- <para>Asynchronously establishes a connection to the specified mail server using the provided stream.</para>
- <para>If a successful connection is made, the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/>
- property will be populated.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="stream">The stream to use for the connection.</param>
- <param name="host">The host name to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="options">The secure socket options to when connecting.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="stream"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="host"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.IMailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Connect(System.Uri,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified mail server.
- </summary>
- <remarks>
- Establishes a connection to the specified mail server.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessageUri"/>
- </example>
- <param name="uri">The server URI.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="uri"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="uri"/> is not an absolute URI.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.ConnectAsync(System.Uri,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified mail server.
- </summary>
- <remarks>
- Asynchronously establishes a connection to the specified mail server.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="uri">The server URI.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="uri"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="uri"/> is not an absolute URI.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Connect(System.String,System.Int32,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Establish a connection to the specified mail server.
- </summary>
- <remarks>
- <para>Establishes a connection to the specified mail server.</para>
- <note type="note">
- <para>The <paramref name="useSsl"/> argument only controls whether or
- not the client makes an SSL-wrapped connection. In other words, even if the
- <paramref name="useSsl"/> parameter is <c>false</c>, SSL/TLS may still be used if
- the mail server supports the STARTTLS extension.</para>
- <para>To disable all use of SSL/TLS, use the
- <see cref="M:MailKit.MailService.Connect(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)"/>
- overload with a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.None">SecureSocketOptions.None</see>
- instead.</para>
- </note>
- </remarks>
- <param name="host">The host to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="useSsl"><value>true</value> if the client should make an SSL-wrapped connection to the server; otherwise, <value>false</value>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is out of range (<value>0</value> to <value>65535</value>, inclusive).
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.ConnectAsync(System.String,System.Int32,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously establish a connection to the specified mail server.
- </summary>
- <remarks>
- <para>Asynchronously establishes a connection to the specified mail server.</para>
- <note type="note">
- <para>The <paramref name="useSsl"/> argument only controls whether or
- not the client makes an SSL-wrapped connection. In other words, even if the
- <paramref name="useSsl"/> parameter is <c>false</c>, SSL/TLS may still be used if
- the mail server supports the STARTTLS extension.</para>
- <para>To disable all use of SSL/TLS, use the
- <see cref="M:MailKit.MailService.ConnectAsync(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)"/>
- overload with a value of
- <see cref="F:MailKit.Security.SecureSocketOptions.None">SecureSocketOptions.None</see>
- instead.</para>
- </note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="host">The host to connect to.</param>
- <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
- <param name="useSsl"><value>true</value> if the client should make an SSL-wrapped connection to the server; otherwise, <value>false</value>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="host"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="port"/> is out of range (<value>0</value> to <value>65535</value>, inclusive).
- </exception>
- <exception cref="T:System.ArgumentException">
- The <paramref name="host"/> is a zero-length string.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is already connected.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.Net.Sockets.SocketException">
- A socket error occurred trying to connect to the remote host.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Authenticate(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.AuthenticateAsync(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="credentials"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Authenticate(System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.AuthenticateAsync(System.Net.ICredentials,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the supplied credentials.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="credentials">The user's credentials.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="credentials"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Authenticate(System.Text.Encoding,System.String,System.String,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the specified user name and password.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.AuthenticateAsync(System.Text.Encoding,System.String,System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the specified user name and password.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="encoding">The encoding to use for the user's credentials.</param>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="encoding"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Authenticate(System.String,System.String,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the specified user name and password.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
- </example>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.AuthenticateAsync(System.String,System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the specified user name and password.
- </summary>
- <remarks>
- <para>If the server supports one or more SASL authentication mechanisms,
- then the SASL mechanisms that both the client and server support are tried
- in order of greatest security to weakest security. Once a SASL
- authentication mechanism is found that both client and server support,
- the credentials are used to authenticate.</para>
- <para>If the server does not support SASL or if no common SASL mechanisms
- can be found, then the default login command is used as a fallback.</para>
- <note type="tip">To prevent the usage of certain authentication mechanisms,
- simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
- before calling this method.</note>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="userName">The user name.</param>
- <param name="password">The password.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="userName"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="password"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Authenticate(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.AuthenticateAsync(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
- <summary>
- Asynchronously authenticate using the specified SASL mechanism.
- </summary>
- <remarks>
- <para>Authenticates using the specified SASL mechanism.</para>
- <para>For a list of available SASL authentication mechanisms supported by the server,
- check the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> property after the service has been
- connected.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="mechanism">The SASL mechanism.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="mechanism"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.Security.AuthenticationException">
- Authentication using the supplied credentials has failed.
- </exception>
- <exception cref="T:MailKit.Security.SaslException">
- A SASL authentication error occurred.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Disconnect the service.
- </summary>
- <remarks>
- If <paramref name="quit"/> is <c>true</c>, a logout/quit command will be issued in order to disconnect cleanly.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
- </example>
- <param name="quit">If set to <c>true</c>, a logout/quit command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.MailService.DisconnectAsync(System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously disconnect the service.
- </summary>
- <remarks>
- If <paramref name="quit"/> is <c>true</c>, a logout/quit command will be issued in order to disconnect cleanly.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="quit">If set to <c>true</c>, a logout/quit command will be issued in order to disconnect cleanly.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- </member>
- <member name="M:MailKit.MailService.NoOp(System.Threading.CancellationToken)">
- <summary>
- Ping the mail server to keep the connection alive.
- </summary>
- <remarks>
- Mail servers, if left idle for too long, will automatically drop the connection.
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>The <see cref="T:MailKit.MailService"/> is not connected.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.MailService"/> is not authenticated.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="M:MailKit.MailService.NoOpAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously ping the mail server to keep the connection alive.
- </summary>
- <remarks>
- Mail servers, if left idle for too long, will automatically drop the connection.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailService"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>The <see cref="T:MailKit.MailService"/> is not connected.</para>
- <para>-or-</para>
- <para>The <see cref="T:MailKit.MailService"/> is not authenticated.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command was rejected by the mail server.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server responded with an unexpected token.
- </exception>
- </member>
- <member name="E:MailKit.MailService.Connected">
- <summary>
- Occurs when the client has been successfully connected.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailService.Connected"/> event is raised when the client
- successfully connects to the mail server.
- </remarks>
- </member>
- <member name="M:MailKit.MailService.OnConnected(System.String,System.Int32,MailKit.Security.SecureSocketOptions)">
- <summary>
- Raise the connected event.
- </summary>
- <remarks>
- Raises the connected event.
- </remarks>
- <param name="host">The name of the host that the client connected to.</param>
- <param name="port">The port that the client connected to on the remote host.</param>
- <param name="options">The SSL/TLS options that were used when connecting.</param>
- </member>
- <member name="E:MailKit.MailService.Disconnected">
- <summary>
- Occurs when the client gets disconnected.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailService.Disconnected"/> event is raised whenever the client
- gets disconnected.
- </remarks>
- </member>
- <member name="M:MailKit.MailService.OnDisconnected(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Boolean)">
- <summary>
- Raise the disconnected event.
- </summary>
- <remarks>
- Raises the disconnected event.
- </remarks>
- <param name="host">The name of the host that the client was connected to.</param>
- <param name="port">The port that the client was connected to on the remote host.</param>
- <param name="options">The SSL/TLS options that were used by the client.</param>
- <param name="requested"><c>true</c> if the disconnect was explicitly requested; otherwise, <c>false</c>.</param>
- </member>
- <member name="E:MailKit.MailService.Authenticated">
- <summary>
- Occurs when the client has been successfully authenticated.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailService.Authenticated"/> event is raised whenever the client
- has been authenticated.
- </remarks>
- </member>
- <member name="M:MailKit.MailService.OnAuthenticated(System.String)">
- <summary>
- Raise the authenticated event.
- </summary>
- <remarks>
- Raises the authenticated event.
- </remarks>
- <param name="message">The notification sent by the server when the client successfully authenticates.</param>
- </member>
- <member name="M:MailKit.MailService.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.MailService"/> and
- optionally releases the managed resources.
- </summary>
- <remarks>
- Releases the unmanaged resources used by the <see cref="T:MailKit.MailService"/> and
- optionally releases the managed resources.
- </remarks>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="M:MailKit.MailService.Dispose">
- <summary>
- Releases all resource used by the <see cref="T:MailKit.MailService"/> object.
- </summary>
- <remarks>Call <see cref="M:MailKit.MailService.Dispose"/> when you are finished using the <see cref="T:MailKit.MailService"/>. The
- <see cref="M:MailKit.MailService.Dispose"/> method leaves the <see cref="T:MailKit.MailService"/> in an unusable state. After
- calling <see cref="M:MailKit.MailService.Dispose"/>, you must release all references to the <see cref="T:MailKit.MailService"/> so
- the garbage collector can reclaim the memory that the <see cref="T:MailKit.MailService"/> was occupying.</remarks>
- </member>
- <member name="T:MailKit.MailSpool">
- <summary>
- An abstract mail spool implementation.
- </summary>
- <remarks>
- An abstract mail spool implementation.
- </remarks>
- </member>
- <member name="M:MailKit.MailSpool.#ctor(MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MailSpool"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.MailSpool"/> class.
- </remarks>
- <param name="protocolLogger">The protocol logger.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="protocolLogger"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.MailSpool.Count">
- <summary>
- Get the number of messages available in the message spool.
- </summary>
- <remarks>
- <para>Gets the number of messages available in the message spool.</para>
- <para>Once authenticated, the <see cref="P:MailKit.MailSpool.Count"/> property will be set
- to the number of available messages in the spool.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <value>The message count.</value>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- </member>
- <member name="P:MailKit.MailSpool.SupportsUids">
- <summary>
- Get whether or not the service supports referencing messages by UIDs.
- </summary>
- <remarks>
- <para>Not all servers support referencing messages by UID, so this property should
- be checked before using <see cref="M:MailKit.MailSpool.GetMessageUid(System.Int32,System.Threading.CancellationToken)"/>
- and <see cref="M:MailKit.MailSpool.GetMessageUids(System.Threading.CancellationToken)"/>.</para>
- <para>If the server does not support UIDs, then all methods that take UID arguments
- along with <see cref="M:MailKit.MailSpool.GetMessageUid(System.Int32,System.Threading.CancellationToken)"/> and
- <see cref="M:MailKit.MailSpool.GetMessageUids(System.Threading.CancellationToken)"/> will fail.</para>
- </remarks>
- <value><c>true</c> if supports uids; otherwise, <c>false</c>.</value>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageCount(System.Threading.CancellationToken)">
- <summary>
- Get the message count.
- </summary>
- <remarks>
- Gets the message count.
- </remarks>
- <returns>The message count.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageCountAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the message count.
- </summary>
- <remarks>
- Asynchronously gets the message count.
- </remarks>
- <returns>The message count.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageUid(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the UID of the message at the specified index.
- </summary>
- <remarks>
- Not all servers support UIDs, so you should first check
- the <see cref="P:MailKit.MailSpool.SupportsUids"/> property.
- </remarks>
- <returns>The message UID.</returns>
- <param name="index">The message index.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail spool does not support UIDs.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageUidAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the UID of the message at the specified index.
- </summary>
- <remarks>
- Not all servers support UIDs, so you should first check
- the <see cref="P:MailKit.MailSpool.SupportsUids"/> property.
- </remarks>
- <returns>The message UID.</returns>
- <param name="index">The message index.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail spool does not support UIDs.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageUids(System.Threading.CancellationToken)">
- <summary>
- Get the full list of available message UIDs.
- </summary>
- <remarks>
- Not all servers support UIDs, so you should first check
- the <see cref="P:MailKit.MailSpool.SupportsUids"/> property.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadNewMessages"/>
- </example>
- <returns>The message uids.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail spool does not support UIDs.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageUidsAsync(System.Threading.CancellationToken)">
- <summary>
- Get the full list of available message UIDs.
- </summary>
- <remarks>
- Not all servers support UIDs, so you should first check
- the <see cref="P:MailKit.MailSpool.SupportsUids"/> property.
- </remarks>
- <returns>The message uids.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail spool does not support UIDs.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageSize(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the size of the specified message, in bytes.
- </summary>
- <remarks>
- Gets the size of the specified message, in bytes.
- </remarks>
- <returns>The message size, in bytes.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageSizeAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the size of the specified message, in bytes.
- </summary>
- <remarks>
- Asynchronously gets the size of the specified message, in bytes.
- </remarks>
- <returns>The message size, in bytes.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageSizes(System.Threading.CancellationToken)">
- <summary>
- Get the sizes for all available messages, in bytes.
- </summary>
- <remarks>
- Gets the sizes for all available messages, in bytes.
- </remarks>
- <returns>The message sizes, in bytes.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageSizesAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the sizes for all available messages, in bytes.
- </summary>
- <remarks>
- Asynchronously gets the sizes for all available messages, in bytes.
- </remarks>
- <returns>The message sizes, in bytes.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the headers for the specified message.
- </summary>
- <remarks>
- Gets the headers for the specified message.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageHeadersAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the headers for the specified message.
- </summary>
- <remarks>
- Asynchronously gets the headers for the specified message.
- </remarks>
- <returns>The message headers.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageHeaders(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Get the headers for the specified messages.
- </summary>
- <remarks>
- Gets the headers for the specified messages.
- </remarks>
- <returns>The headers for the specified messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> are invalid.</para>
- <para>-or-</para>
- <para>No indexes were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageHeadersAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the headers for the specified messages.
- </summary>
- <remarks>
- Asynchronously gets the headers for the specified messages.
- </remarks>
- <returns>The headers for the specified messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> are invalid.</para>
- <para>-or-</para>
- <para>No indexes were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageHeaders(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the headers of the messages within the specified range.
- </summary>
- <remarks>
- Gets the headers of the messages within the specified range.
- </remarks>
- <returns>The headers of the messages within the specified range.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageHeadersAsync(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Get the headers of the messages within the specified range.
- </summary>
- <remarks>
- Gets the headers of the messages within the specified range.
- </remarks>
- <returns>The headers of the messages within the specified range.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message at the specified index.
- </summary>
- <remarks>
- Gets the message at the specified index.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessageAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message at the specified index.
- </summary>
- <remarks>
- Asynchronously gets the message at the specified index.
- </remarks>
- <returns>The message.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessages(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the messages at the specified indexes.
- </summary>
- <remarks>
- Get the messages at the specified indexes.
- </remarks>
- <returns>The messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> are invalid.</para>
- <para>-or-</para>
- <para>No indexes were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessagesAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the messages at the specified indexes.
- </summary>
- <remarks>
- Asynchronously get the messages at the specified indexes.
- </remarks>
- <returns>The messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> are invalid.</para>
- <para>-or-</para>
- <para>No indexes were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessages(System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the messages within the specified range.
- </summary>
- <remarks>
- Gets the messages within the specified range.
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="BatchDownloadMessages"/>
- </example>
- <returns>The messages.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetMessagesAsync(System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the messages within the specified range.
- </summary>
- <remarks>
- Asynchronously gets the messages within the specified range.
- </remarks>
- <returns>The messages.</returns>
- <param name="startIndex">The index of the first message to get.</param>
- <param name="count">The number of messages to get.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message or header stream at the specified index.
- </summary>
- <remarks>
- Gets the message or header stream at the specified index.
- </remarks>
- <returns>The message or header stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetStreamAsync(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message or header stream at the specified index.
- </summary>
- <remarks>
- Asynchronously gets the message or header stream at the specified index.
- </remarks>
- <returns>The message or header stream.</returns>
- <param name="index">The index of the message.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetStreams(System.Collections.Generic.IList{System.Int32},System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message or header streams at the specified indexes.
- </summary>
- <remarks>
- <para>Get the message or header streams at the specified indexes.</para>
- <para>If the mail server supports pipelining, this method will likely be more
- efficient than using <see cref="M:MailKit.MailSpool.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for
- each message because it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The message or header streams.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> are invalid.</para>
- <para>-or-</para>
- <para>No indexes were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetStreamsAsync(System.Collections.Generic.IList{System.Int32},System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message or header streams at the specified indexes.
- </summary>
- <remarks>
- Asynchronously get the message or header streams at the specified indexes.
- </remarks>
- <returns>The messages.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> are invalid.</para>
- <para>-or-</para>
- <para>No indexes were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetStreams(System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Get the message or header streams within the specified range.
- </summary>
- <remarks>
- <para>Gets the message or header streams within the specified range.</para>
- <para>If the mail server supports pipelining, this method will likely be more
- efficient than using <see cref="M:MailKit.MailSpool.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for
- each message because it will batch the commands to reduce latency.</para>
- </remarks>
- <returns>The message or header streams.</returns>
- <param name="startIndex">The index of the first stream to get.</param>
- <param name="count">The number of streams to get.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetStreamsAsync(System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously get the message or header streams within the specified range.
- </summary>
- <remarks>
- Asynchronously gets the message or header streams within the specified range.
- </remarks>
- <returns>The messages.</returns>
- <param name="startIndex">The index of the first stream to get.</param>
- <param name="count">The number of streams to get.</param>
- <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.DeleteMessage(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Mark the specified message for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
- </example>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.DeleteMessageAsync(System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark the specified message for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="index">The index of the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid message index.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.DeleteMessages(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Mark the specified messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> are invalid.</para>
- <para>-or-</para>
- <para>No indexes were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.DeleteMessagesAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark the specified messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="indexes">The indexes of the messages.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="indexes"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para>One or more of the <paramref name="indexes"/> are invalid.</para>
- <para>-or-</para>
- <para>No indexes were specified.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.DeleteMessages(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Mark the specified range of messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <example>
- <code language="c#" source="Examples\Pop3Examples.cs" region="BatchDownloadMessages"/>
- </example>
- <param name="startIndex">The index of the first message to mark for deletion.</param>
- <param name="count">The number of messages to mark for deletion.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.DeleteMessagesAsync(System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark the specified range of messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="startIndex">The index of the first message to mark for deletion.</param>
- <param name="count">The number of messages to mark for deletion.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="startIndex"/> and <paramref name="count"/> do not specify
- a valid range of messages.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.DeleteAllMessages(System.Threading.CancellationToken)">
- <summary>
- Mark all messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.DeleteAllMessagesAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously mark all messages for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.Reset(System.Threading.CancellationToken)">
- <summary>
- Reset the state of all messages marked for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.ResetAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously reset the state of all messages marked for deletion.
- </summary>
- <remarks>
- Messages marked for deletion are not actually deleted until the session
- is cleanly disconnected
- (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.GetEnumerator">
- <summary>
- Get an enumerator for the messages in the folder.
- </summary>
- <remarks>
- Gets an enumerator for the messages in the folder.
- </remarks>
- <returns>The enumerator.</returns>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- A command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailSpool.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Get an enumerator for the messages in the folder.
- </summary>
- <remarks>
- Gets an enumerator for the messages in the folder.
- </remarks>
- <returns>The enumerator.</returns>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailSpool"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailSpool"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailSpool"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- A command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- </member>
- <member name="T:MailKit.MailStore">
- <summary>
- An abstract mail store implementation.
- </summary>
- <remarks>
- An abstract mail store implementation.
- </remarks>
- </member>
- <member name="M:MailKit.MailStore.#ctor(MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MailStore"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.MailStore"/> class.
- </remarks>
- <param name="protocolLogger">The protocol logger.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="protocolLogger"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.MailStore.PersonalNamespaces">
- <summary>
- Gets the personal namespaces.
- </summary>
- <remarks>
- The personal folder namespaces contain a user's personal mailbox folders.
- </remarks>
- <value>The personal namespaces.</value>
- </member>
- <member name="P:MailKit.MailStore.SharedNamespaces">
- <summary>
- Gets the shared namespaces.
- </summary>
- <remarks>
- The shared folder namespaces contain mailbox folders that are shared with the user.
- </remarks>
- <value>The shared namespaces.</value>
- </member>
- <member name="P:MailKit.MailStore.OtherNamespaces">
- <summary>
- Gets the other namespaces.
- </summary>
- <remarks>
- The other folder namespaces contain other mailbox folders.
- </remarks>
- <value>The other namespaces.</value>
- </member>
- <member name="P:MailKit.MailStore.SupportsQuotas">
- <summary>
- Get whether or not the mail store supports quotas.
- </summary>
- <remarks>
- Gets whether or not the mail store supports quotas.
- </remarks>
- <value><c>true</c> if the mail store supports quotas; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MailStore.ThreadingAlgorithms">
- <summary>
- Get the threading algorithms supported by the mail store.
- </summary>
- <remarks>
- The threading algorithms are queried as part of the
- <a href="Overload_MailKit_MailStore_Connect.htm">Connect</a>
- and <a href="Overload_MailKit_MailStore_Authenticate.htm">Authenticate</a> methods.
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
- </example>
- <value>The supported threading algorithms.</value>
- </member>
- <member name="P:MailKit.MailStore.Inbox">
- <summary>
- Get the Inbox folder.
- </summary>
- <remarks>
- <para>The Inbox folder is the default folder and always exists on the mail store.</para>
- <note type="note">This property will only be available after the client has been authenticated.</note>
- </remarks>
- <value>The Inbox folder.</value>
- </member>
- <member name="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)">
- <summary>
- Enable the quick resynchronization feature.
- </summary>
- <remarks>
- <para>Enables quick resynchronization when a folder is opened using the
- <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/>
- method.</para>
- <para>If this feature is enabled, the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event is replaced
- with the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event.</para>
- <para>This method needs to be called immediately after calling one of the
- <a href="Overload_MailKit_MailService_Authenticate.htm">Authenticate</a> methods, before
- opening any folders.</para>
- </remarks>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Quick resynchronization needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support quick resynchronization.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.EnableQuickResyncAsync(System.Threading.CancellationToken)">
- <summary>
- Asynchronously enable the quick resynchronization feature.
- </summary>
- <remarks>
- <para>Enables quick resynchronization when a folder is opened using the
- <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/>
- method.</para>
- <para>If this feature is enabled, the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event is replaced
- with the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event.</para>
- <para>This method needs to be called immediately after calling one of the
- <a href="Overload_MailKit_MailService_Authenticate.htm">Authenticate</a> methods, before
- opening any folders.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- Quick resynchronization needs to be enabled before selecting a folder.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The mail store does not support quick resynchronization.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetFolder(MailKit.SpecialFolder)">
- <summary>
- Get the specified special folder.
- </summary>
- <remarks>
- Not all mail stores support special folders. Each implementation
- should provide a way to determine if special folders are supported.
- </remarks>
- <returns>The folder if available; otherwise <c>null</c>.</returns>
- <param name="folder">The type of special folder.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="folder"/> is out of range.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetFolder(MailKit.FolderNamespace)">
- <summary>
- Get the folder for the specified namespace.
- </summary>
- <remarks>
- Gets the folder for the specified namespace.
- </remarks>
- <returns>The folder.</returns>
- <param name="namespace">The namespace.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The folder could not be found.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetFolders(MailKit.FolderNamespace,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetFoldersAsync(MailKit.FolderNamespace,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Asynchronously gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetFolders(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetFoldersAsync(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get all of the folders within the specified namespace.
- </summary>
- <remarks>
- Asynchronously gets all of the folders within the specified namespace.
- </remarks>
- <returns>The folders.</returns>
- <param name="namespace">The namespace.</param>
- <param name="items">The status items to pre-populate.</param>
- <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="namespace"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetFolder(System.String,System.Threading.CancellationToken)">
- <summary>
- Get the folder for the specified path.
- </summary>
- <remarks>
- Gets the folder for the specified path.
- </remarks>
- <returns>The folder.</returns>
- <param name="path">The folder path.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="path"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetFolderAsync(System.String,System.Threading.CancellationToken)">
- <summary>
- Asynchronously get the folder for the specified path.
- </summary>
- <remarks>
- Asynchronously gets the folder for the specified path.
- </remarks>
- <returns>The folder.</returns>
- <param name="path">The folder path.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="path"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.MailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:MailKit.FolderNotFoundException">
- The folder could not be found.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetMetadata(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetMetadataAsync(MailKit.MetadataTag,System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata value.</returns>
- <param name="tag">The metadata tag.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetMetadata(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="tags"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetMetadataAsync(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="tags"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetMetadata(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Gets the specified metadata.
- </summary>
- <remarks>
- Gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="tags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.GetMetadataAsync(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
- <summary>
- Asynchronously gets the specified metadata.
- </summary>
- <remarks>
- Asynchronously gets the specified metadata.
- </remarks>
- <returns>The requested metadata.</returns>
- <param name="options">The metadata options.</param>
- <param name="tags">The metadata tags.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="tags"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.SetMetadata(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Sets the specified metadata.
- </summary>
- <remarks>
- Sets the specified metadata.
- </remarks>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="metadata"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="M:MailKit.MailStore.SetMetadataAsync(MailKit.MetadataCollection,System.Threading.CancellationToken)">
- <summary>
- Asynchronously sets the specified metadata.
- </summary>
- <remarks>
- Asynchronously sets the specified metadata.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="metadata">The metadata.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="metadata"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.IMailStore"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.IMailStore"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- The <see cref="T:MailKit.IMailStore"/> is not authenticated.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The folder does not support metadata.
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation was canceled via the cancellation token.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- The server's response contained unexpected tokens.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The command failed.
- </exception>
- </member>
- <member name="E:MailKit.MailStore.Alert">
- <summary>
- Occurs when a remote message store receives an alert message from the server.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailStore.Alert"/> event is raised whenever the mail server sends an
- alert message.
- </remarks>
- </member>
- <member name="M:MailKit.MailStore.OnAlert(System.String)">
- <summary>
- Raise the alert event.
- </summary>
- <remarks>
- Raises the alert event.
- </remarks>
- <param name="message">The alert message.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- </member>
- <member name="E:MailKit.MailStore.FolderCreated">
- <summary>
- Occurs when a folder is created.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailStore.FolderCreated"/> event is emitted when a new folder is created.
- </remarks>
- </member>
- <member name="M:MailKit.MailStore.OnFolderCreated(MailKit.IMailFolder)">
- <summary>
- Raise the folder created event.
- </summary>
- <remarks>
- Raises the folder created event.
- </remarks>
- <param name="folder">The folder that was just created.</param>
- </member>
- <member name="E:MailKit.MailStore.MetadataChanged">
- <summary>
- Occurs when metadata changes.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailStore.MetadataChanged"/> event is emitted when metadata changes.
- </remarks>
- </member>
- <member name="M:MailKit.MailStore.OnMetadataChanged(MailKit.Metadata)">
- <summary>
- Raise the metadata changed event.
- </summary>
- <remarks>
- Raises the metadata changed event.
- </remarks>
- <param name="metadata">The metadata that changed.</param>
- </member>
- <member name="T:MailKit.MailTransport">
- <summary>
- An abstract mail transport implementation.
- </summary>
- <remarks>
- An abstract mail transport implementation.
- </remarks>
- </member>
- <member name="M:MailKit.MailTransport.#ctor(MailKit.IProtocolLogger)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MailTransport"/> class.
- </summary>
- <remarks>
- Initializes a new instance of the <see cref="T:MailKit.MailTransport"/> class.
- </remarks>
- <param name="protocolLogger">The protocol logger.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="protocolLogger"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.MailTransport.Send(MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message.
- </summary>
- <remarks>
- <para>Sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
- </example>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailTransport"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailTransport"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The send command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailTransport.SendAsync(MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message.
- </summary>
- <remarks>
- <para>Asynchronously sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailTransport"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailTransport"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The send command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailTransport.Send(MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Sends the specified message using the supplied sender and recipients.
- </remarks>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="message"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="sender"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="recipients"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailTransport"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailTransport"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The send command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailTransport.SendAsync(MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Asynchronously sends the specified message using the supplied sender and recipients.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="message"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="sender"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="recipients"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailTransport"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailTransport"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The send command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailTransport.Send(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message.
- </summary>
- <remarks>
- <para>Sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessageWithOptions"/>
- </example>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailTransport"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailTransport"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>Internationalized formatting was requested but is not supported by the transport.</para>
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The send command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailTransport.SendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message.
- </summary>
- <remarks>
- <para>Asynchronously sends the specified message.</para>
- <para>The sender address is determined by checking the following
- message headers (in order of precedence): Resent-Sender,
- Resent-From, Sender, and From.</para>
- <para>If either the Resent-Sender or Resent-From addresses are present,
- the recipients are collected from the Resent-To, Resent-Cc, and
- Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailTransport"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailTransport"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>Internationalized formatting was requested but is not supported by the transport.</para>
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The send command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailTransport.Send(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Sends the specified message using the supplied sender and recipients.
- </remarks>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="sender"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="recipients"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailTransport"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailTransport"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>Internationalized formatting was requested but is not supported by the transport.</para>
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The send command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol exception occurred.
- </exception>
- </member>
- <member name="M:MailKit.MailTransport.SendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
- <summary>
- Asynchronously send the specified message using the supplied sender and recipients.
- </summary>
- <remarks>
- Asynchronously sends the specified message using the supplied sender and recipients.
- </remarks>
- <returns>An asynchronous task context.</returns>
- <param name="options">The formatting options.</param>
- <param name="message">The message.</param>
- <param name="sender">The mailbox address to use for sending the message.</param>
- <param name="recipients">The mailbox addresses that should receive the message.</param>
- <param name="cancellationToken">The cancellation token.</param>
- <param name="progress">The progress reporting mechanism.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="options"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="message"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="sender"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="recipients"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The <see cref="T:MailKit.MailTransport"/> has been disposed.
- </exception>
- <exception cref="T:MailKit.ServiceNotConnectedException">
- The <see cref="T:MailKit.MailTransport"/> is not connected.
- </exception>
- <exception cref="T:MailKit.ServiceNotAuthenticatedException">
- Authentication is required before sending a message.
- </exception>
- <exception cref="T:System.InvalidOperationException">
- <para>A sender has not been specified.</para>
- <para>-or-</para>
- <para>No recipients have been specified.</para>
- </exception>
- <exception cref="T:System.OperationCanceledException">
- The operation has been canceled.
- </exception>
- <exception cref="T:System.NotSupportedException">
- <para>Internationalized formatting was requested but is not supported by the transport.</para>
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- <exception cref="T:MailKit.CommandException">
- The send command failed.
- </exception>
- <exception cref="T:MailKit.ProtocolException">
- A protocol exception occurred.
- </exception>
- </member>
- <member name="E:MailKit.MailTransport.MessageSent">
- <summary>
- Occurs when a message is successfully sent via the transport.
- </summary>
- <remarks>
- The <see cref="E:MailKit.MailTransport.MessageSent"/> event will be emitted each time a message is successfully sent.
- </remarks>
- </member>
- <member name="M:MailKit.MailTransport.OnMessageSent(MailKit.MessageSentEventArgs)">
- <summary>
- Raise the message sent event.
- </summary>
- <remarks>
- Raises the message sent event.
- </remarks>
- <param name="e">The message sent event args.</param>
- </member>
- <member name="T:MailKit.MessageEventArgs">
- <summary>
- Event args used when the state of a message changes.
- </summary>
- <remarks>
- Event args used when the state of a message changes.
- </remarks>
- </member>
- <member name="M:MailKit.MessageEventArgs.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageEventArgs.#ctor(System.Int32,MailKit.UniqueId)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="uid">The unique id of the message.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="P:MailKit.MessageEventArgs.Index">
- <summary>
- Gets the index of the message that changed.
- </summary>
- <remarks>
- Gets the index of the message that changed.
- </remarks>
- <value>The index of the message.</value>
- </member>
- <member name="P:MailKit.MessageEventArgs.UniqueId">
- <summary>
- Gets the unique ID of the message that changed, if available.
- </summary>
- <remarks>
- Gets the unique ID of the message that changed, if available.
- </remarks>
- <value>The unique ID of the message.</value>
- </member>
- <member name="T:MailKit.MessageFlags">
- <summary>
- An enumeration of message flags.
- </summary>
- <remarks>
- An enumeration of message flags.
- </remarks>
- </member>
- <member name="F:MailKit.MessageFlags.None">
- <summary>
- No message flags are set.
- </summary>
- </member>
- <member name="F:MailKit.MessageFlags.Seen">
- <summary>
- The message has been read.
- </summary>
- </member>
- <member name="F:MailKit.MessageFlags.Answered">
- <summary>
- The message has been answered (replied to).
- </summary>
- </member>
- <member name="F:MailKit.MessageFlags.Flagged">
- <summary>
- The message has been flagged for importance.
- </summary>
- </member>
- <member name="F:MailKit.MessageFlags.Deleted">
- <summary>
- The message has been marked for deletion.
- </summary>
- </member>
- <member name="F:MailKit.MessageFlags.Draft">
- <summary>
- The message is marked as a draft.
- </summary>
- </member>
- <member name="F:MailKit.MessageFlags.Recent">
- <summary>
- The message has just recently arrived in the folder.
- </summary>
- </member>
- <member name="F:MailKit.MessageFlags.UserDefined">
- <summary>
- User-defined flags are allowed by the folder.
- </summary>
- </member>
- <member name="T:MailKit.MessageFlagsChangedEventArgs">
- <summary>
- Event args for the <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> event.
- </summary>
- <remarks>
- Event args for the <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> event.
- </remarks>
- </member>
- <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- </member>
- <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.MessageFlags)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="flags">The message flags.</param>
- </member>
- <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="flags">The message flags.</param>
- <param name="keywords">The user-defined message flags.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="keywords"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.MessageFlags,System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="flags">The message flags.</param>
- <param name="modseq">The modification sequence value.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="flags">The message flags.</param>
- <param name="keywords">The user-defined message flags.</param>
- <param name="modseq">The modification sequence value.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="keywords"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,MailKit.MessageFlags)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="uid">The unique id of the message.</param>
- <param name="flags">The message flags.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="uid">The unique id of the message.</param>
- <param name="flags">The message flags.</param>
- <param name="keywords">The user-defined message flags.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="keywords"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,MailKit.MessageFlags,System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="uid">The unique id of the message.</param>
- <param name="flags">The message flags.</param>
- <param name="modseq">The modification sequence value.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="uid">The unique id of the message.</param>
- <param name="flags">The message flags.</param>
- <param name="keywords">The user-defined message flags.</param>
- <param name="modseq">The modification sequence value.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="keywords"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="P:MailKit.MessageFlagsChangedEventArgs.Flags">
- <summary>
- Gets the updated message flags.
- </summary>
- <remarks>
- Gets the updated message flags.
- </remarks>
- <value>The updated message flags.</value>
- </member>
- <member name="P:MailKit.MessageFlagsChangedEventArgs.Keywords">
- <summary>
- Gets the updated user-defined message flags.
- </summary>
- <remarks>
- Gets the updated user-defined message flags.
- </remarks>
- <value>The updated user-defined message flags.</value>
- </member>
- <member name="P:MailKit.MessageFlagsChangedEventArgs.UserFlags">
- <summary>
- Gets the updated user-defined message flags.
- </summary>
- <remarks>
- Gets the updated user-defined message flags.
- </remarks>
- <value>The updated user-defined message flags.</value>
- </member>
- <member name="P:MailKit.MessageFlagsChangedEventArgs.ModSeq">
- <summary>
- Gets the updated mod-sequence value of the message, if available.
- </summary>
- <remarks>
- Gets the updated mod-sequence value of the message, if available.
- </remarks>
- <value>The mod-sequence value.</value>
- </member>
- <member name="T:MailKit.MessageLabelsChangedEventArgs">
- <summary>
- Event args for the <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> event.
- </summary>
- <remarks>
- Event args for the <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> event.
- </remarks>
- </member>
- <member name="M:MailKit.MessageLabelsChangedEventArgs.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageLabelsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageLabelsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageLabelsChangedEventArgs.#ctor(System.Int32,System.Collections.Generic.IList{System.String})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageLabelsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageLabelsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="labels">The message labels.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageLabelsChangedEventArgs.#ctor(System.Int32,System.Collections.Generic.IList{System.String},System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageLabelsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageLabelsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="labels">The message labels.</param>
- <param name="modseq">The modification sequence value.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageLabelsChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,System.Collections.Generic.IList{System.String})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageLabelsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageLabelsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="uid">The unique id of the message.</param>
- <param name="labels">The message labels.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.MessageLabelsChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageLabelsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageLabelsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="uid">The unique id of the message.</param>
- <param name="labels">The message labels.</param>
- <param name="modseq">The modification sequence value.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="labels"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="P:MailKit.MessageLabelsChangedEventArgs.Labels">
- <summary>
- Gets the updated labels.
- </summary>
- <remarks>
- Gets the updated labels.
- </remarks>
- <value>The updated labels.</value>
- </member>
- <member name="P:MailKit.MessageLabelsChangedEventArgs.ModSeq">
- <summary>
- Gets the updated mod-sequence value of the message, if available.
- </summary>
- <remarks>
- Gets the updated mod-sequence value of the message, if available.
- </remarks>
- <value>The mod-sequence value.</value>
- </member>
- <member name="T:MailKit.MessageNotFoundException">
- <summary>
- The exception that is thrown when a message (or body part) could not be found.
- </summary>
- <remarks>
- This exception is thrown by methods such as
- <a href="Overload_MailKit_IMailFolder_GetMessage.htm">IMailFolder.GetMessage</a>,
- <a href="Overload_MailKit_IMailFolder_GetBodyPart.htm">IMailFolder.GetBodyPart</a>, or
- <a href="Overload_MailKit_IMailFolder_GetStream.htm">IMailFolder.GetStream</a>
- when the server's response does not contain the message, body part, or stream data requested.
- </remarks>
- </member>
- <member name="M:MailKit.MessageNotFoundException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageNotFoundException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageNotFoundException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">The inner exception.</param>
- <exception cref="T:System.ArgumentNullException">
- </exception>
- </member>
- <member name="M:MailKit.MessageNotFoundException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageNotFoundException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageNotFoundException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="T:MailKit.MessageSentEventArgs">
- <summary>
- Event args used when a message is successfully sent.
- </summary>
- <remarks>
- Event args used when message is successfully sent.
- </remarks>
- </member>
- <member name="M:MailKit.MessageSentEventArgs.#ctor(MimeKit.MimeMessage,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageSentEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageSentEventArgs"/>.
- </remarks>
- <param name="message">The message that was just sent.</param>
- <param name="response">The response from the server.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="message"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="response"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.MessageSentEventArgs.Message">
- <summary>
- Get the message that was just sent.
- </summary>
- <remarks>
- Gets the message that was just sent.
- </remarks>
- <value>The message.</value>
- </member>
- <member name="P:MailKit.MessageSentEventArgs.Response">
- <summary>
- Get the server's response.
- </summary>
- <remarks>
- Gets the server's response.
- </remarks>
- <value>The response.</value>
- </member>
- <member name="T:MailKit.MessageSorter">
- <summary>
- Routines for sorting messages.
- </summary>
- <remarks>
- Routines for sorting messages.
- </remarks>
- </member>
- <member name="M:MailKit.MessageSorter.Sort``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IList{MailKit.Search.OrderBy})">
- <summary>
- Sorts the messages by the specified ordering.
- </summary>
- <remarks>
- Sorts the messages by the specified ordering.
- </remarks>
- <returns>The sorted messages.</returns>
- <typeparam name="T">The message items must implement the <see cref="T:MailKit.IMessageSummary"/> interface.</typeparam>
- <param name="messages">The messages to sort.</param>
- <param name="orderBy">The sort ordering.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="messages"/> contains one or more items that is missing information needed for sorting.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is an empty list.</para>
- </exception>
- </member>
- <member name="M:MailKit.MessageSorter.Sort``1(System.Collections.Generic.List{``0},System.Collections.Generic.IList{MailKit.Search.OrderBy})">
- <summary>
- Sorts the messages by the specified ordering.
- </summary>
- <remarks>
- Sorts the messages by the specified ordering.
- </remarks>
- <returns>The sorted messages.</returns>
- <typeparam name="T">The message items must implement the <see cref="T:MailKit.IMessageSummary"/> interface.</typeparam>
- <param name="messages">The messages to sort.</param>
- <param name="orderBy">The sort ordering.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="messages"/> contains one or more items that is missing information needed for sorting.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is an empty list.</para>
- </exception>
- </member>
- <member name="T:MailKit.MessageSummary">
- <summary>
- A summary of a message.
- </summary>
- <remarks>
- A <see cref="T:MailKit.MessageSummary"/> is returned by
- <see cref="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)"/>.
- The properties of the <see cref="T:MailKit.MessageSummary"/> that will be available
- depend on the <see cref="T:MailKit.MessageSummaryItems"/> passed to the aformentioned method.
- </remarks>
- </member>
- <member name="M:MailKit.MessageSummary.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageSummary"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageSummary"/>.
- </remarks>
- <param name="index">The message index.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is negative.
- </exception>
- </member>
- <member name="P:MailKit.MessageSummary.Fields">
- <summary>
- Get a bitmask of fields that have been populated.
- </summary>
- <remarks>
- Gets a bitmask of fields that have been populated.
- </remarks>
- <value>The fields that have been populated.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Body">
- <summary>
- Gets the body structure of the message, if available.
- </summary>
- <remarks>
- <para>The body will be one of <see cref="T:MailKit.BodyPartText"/>,
- <see cref="T:MailKit.BodyPartMessage"/>, <see cref="T:MailKit.BodyPartBasic"/>,
- or <see cref="T:MailKit.BodyPartMultipart"/>.</para>
- <para>This property will only be set if either the
- <see cref="F:MailKit.MessageSummaryItems.Body"/> flag or the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The body structure of the message.</value>
- </member>
- <member name="P:MailKit.MessageSummary.TextBody">
- <summary>
- Gets the text body part of the message if it exists.
- </summary>
- <remarks>
- <para>Gets the <c>text/plain</c> body part of the message.</para>
- <para>This property will only be usable if the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <value>The text body if it exists; otherwise, <c>null</c>.</value>
- </member>
- <member name="P:MailKit.MessageSummary.HtmlBody">
- <summary>
- Gets the html body part of the message if it exists.
- </summary>
- <remarks>
- <para>Gets the <c>text/html</c> body part of the message.</para>
- <para>This property will only be usable if the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The html body if it exists; otherwise, <c>null</c>.</value>
- </member>
- <member name="P:MailKit.MessageSummary.BodyParts">
- <summary>
- Gets the body parts of the message.
- </summary>
- <remarks>
- <para>Traverses over the <see cref="P:MailKit.MessageSummary.Body"/>, enumerating all of the
- <see cref="T:MailKit.BodyPartBasic"/> objects.</para>
- <para>This property will only be usable if either the
- <see cref="F:MailKit.MessageSummaryItems.Body"/> flag or the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The body parts.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Attachments">
- <summary>
- Gets the attachments.
- </summary>
- <remarks>
- <para>Traverses over the <see cref="P:MailKit.MessageSummary.Body"/>, enumerating all of the
- <see cref="T:MailKit.BodyPartBasic"/> objects that have a <c>Content-Disposition</c>
- header set to <c>"attachment"</c>.</para>
- <para>This property will only be usable if the
- <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <example>
- <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
- </example>
- <value>The attachments.</value>
- </member>
- <member name="P:MailKit.MessageSummary.PreviewText">
- <summary>
- Gets the preview text of the message.
- </summary>
- <remarks>
- <para>The preview text is a short snippet of the beginning of the message
- text, typically shown in a mail client's message list to provide the user
- with a sense of what the message is about.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.PreviewText"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The preview text.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Envelope">
- <summary>
- Gets the envelope of the message, if available.
- </summary>
- <remarks>
- <para>The envelope of a message contains information such as the
- date the message was sent, the subject of the message,
- the sender of the message, who the message was sent to,
- which message(s) the message may be in reply to,
- and the message id.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Envelope"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The envelope of the message.</value>
- </member>
- <member name="P:MailKit.MessageSummary.NormalizedSubject">
- <summary>
- Gets the normalized subject.
- </summary>
- <remarks>
- A normalized Subject header value where prefixes such as
- "Re:", "Re[#]:", etc have been pruned.
- </remarks>
- <value>The normalized subject.</value>
- </member>
- <member name="P:MailKit.MessageSummary.IsReply">
- <summary>
- Gets whether or not the message is a reply.
- </summary>
- <remarks>
- This value should be based on whether the message subject contained any "Re:" or "Fwd:" prefixes.
- </remarks>
- <value><c>true</c> if the message is a reply; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Date">
- <summary>
- Gets the Date header value.
- </summary>
- <remarks>
- Gets the Date header value. If the Date header is not present, the arrival date is used.
- If neither are known, <see cref="F:System.DateTimeOffset.MinValue"/> is returned.
- </remarks>
- <value>The date.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Flags">
- <summary>
- Gets the message flags, if available.
- </summary>
- <remarks>
- <para>Gets the message flags, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Flags"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The message flags.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Keywords">
- <summary>
- Gets the user-defined message flags, if available.
- </summary>
- <remarks>
- <para>Gets the user-defined message flags, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Flags"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The user-defined message flags.</value>
- </member>
- <member name="P:MailKit.MessageSummary.UserFlags">
- <summary>
- Gets the user-defined message flags, if available.
- </summary>
- <remarks>
- <para>Gets the user-defined message flags, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Flags"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The user-defined message flags.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Annotations">
- <summary>
- Gets the message annotations, if available.
- </summary>
- <remarks>
- <para>Gets the message annotations, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Annotations"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The message annotations.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Headers">
- <summary>
- Gets the list of headers, if available.
- </summary>
- <remarks>
- <para>Gets the list of headers, if available.</para>
- <para>This property will only be set if <see cref="F:MailKit.MessageSummaryItems.Headers"/>
- is specified in a call to one of the
- <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods or specific headers are requested via a one of the Fetch or FetchAsync methods
- that accept list of specific headers to request for each message such as
- <see cref="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)"/>.
- </para>
- </remarks>
- <value>The list of headers.</value>
- </member>
- <member name="P:MailKit.MessageSummary.InternalDate">
- <summary>
- Gets the internal date of the message (i.e. the "received" date), if available.
- </summary>
- <remarks>
- <para>Gets the internal date of the message (i.e. the "received" date), if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.InternalDate"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The internal date of the message.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Size">
- <summary>
- Gets the size of the message, in bytes, if available.
- </summary>
- <remarks>
- <para>Gets the size of the message, in bytes, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.Size"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The size of the message.</value>
- </member>
- <member name="P:MailKit.MessageSummary.ModSeq">
- <summary>
- Gets the mod-sequence value for the message, if available.
- </summary>
- <remarks>
- <para>Gets the mod-sequence value for the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.ModSeq"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The mod-sequence value.</value>
- </member>
- <member name="P:MailKit.MessageSummary.References">
- <summary>
- Gets the message-ids that the message references, if available.
- </summary>
- <remarks>
- <para>Gets the message-ids that the message references, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.References"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The references.</value>
- </member>
- <member name="P:MailKit.MessageSummary.EmailId">
- <summary>
- Get the globally unique identifier for the message, if available.
- </summary>
- <remarks>
- <para>Gets the globally unique identifier of the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.EmailId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- <note type="info">This property maps to the <c>EMAILID</c> value defined in the
- <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
- </remarks>
- <value>The globally unique message identifier.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Id">
- <summary>
- Get the globally unique identifier for the message, if available.
- </summary>
- <remarks>
- <para>Gets the globally unique identifier of the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.EmailId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- <note type="info">This property maps to the <c>EMAILID</c> value defined in the
- <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
- </remarks>
- <value>The globally unique message identifier.</value>
- </member>
- <member name="P:MailKit.MessageSummary.ThreadId">
- <summary>
- Get the globally unique thread identifier for the message, if available.
- </summary>
- <remarks>
- <para>Gets the globally unique thread identifier for the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.ThreadId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- <note type="info">This property maps to the <c>THREADID</c> value defined in the
- <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
- </remarks>
- <value>The globally unique thread identifier.</value>
- </member>
- <member name="P:MailKit.MessageSummary.UniqueId">
- <summary>
- Gets the unique identifier of the message, if available.
- </summary>
- <remarks>
- <para>Gets the unique identifier of the message, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.UniqueId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The uid of the message.</value>
- </member>
- <member name="P:MailKit.MessageSummary.Index">
- <summary>
- Gets the index of the message.
- </summary>
- <remarks>
- <para>Gets the index of the message.</para>
- <para>This property is always set.</para>
- </remarks>
- <value>The index of the message.</value>
- </member>
- <member name="P:MailKit.MessageSummary.GMailMessageId">
- <summary>
- Gets the GMail message identifier, if available.
- </summary>
- <remarks>
- <para>Gets the GMail message identifier, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.GMailMessageId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The GMail message identifier.</value>
- </member>
- <member name="P:MailKit.MessageSummary.GMailThreadId">
- <summary>
- Gets the GMail thread identifier, if available.
- </summary>
- <remarks>
- <para>Gets the GMail thread identifier, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.GMailThreadId"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The GMail thread identifier.</value>
- </member>
- <member name="P:MailKit.MessageSummary.GMailLabels">
- <summary>
- Gets the list of GMail labels, if available.
- </summary>
- <remarks>
- <para>Gets the list of GMail labels, if available.</para>
- <para>This property will only be set if the
- <see cref="F:MailKit.MessageSummaryItems.GMailLabels"/> flag is passed to
- one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
- or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
- methods.</para>
- </remarks>
- <value>The GMail labels.</value>
- </member>
- <member name="T:MailKit.MessageSummaryFetchedEventArgs">
- <summary>
- Event args used when a message summary has been fetched from a folder.
- </summary>
- <remarks>
- Event args used when a message summary has been fetched from a folder.
- </remarks>
- </member>
- <member name="M:MailKit.MessageSummaryFetchedEventArgs.#ctor(MailKit.IMessageSummary)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageSummaryFetchedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageSummaryFetchedEventArgs"/>
- </remarks>
- <param name="message">The message summary.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="message"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.MessageSummaryFetchedEventArgs.Message">
- <summary>
- Get the message summary.
- </summary>
- <remarks>
- Gets the message summary.
- </remarks>
- <value>The message summary.</value>
- </member>
- <member name="T:MailKit.MessageSummaryItems">
- <summary>
- A bitfield of <see cref="T:MailKit.MessageSummary"/> fields.
- </summary>
- <remarks>
- <see cref="T:MailKit.MessageSummaryItems"/> are used to specify which properties
- of <see cref="T:MailKit.MessageSummary"/> should be populated by calls to
- <see cref="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)"/>,
- <see cref="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)"/>, or
- <see cref="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)"/>.
- </remarks>
- </member>
- <member name="F:MailKit.MessageSummaryItems.None">
- <summary>
- Don't fetch any summary items.
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.Annotations">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.Annotations"/>.</para>
- <para>Fetches all <c>ANNOATION</c> values as defined in
- <a href="https://tools.ietf.org/html/rfc5257">rfc5257</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.Body">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.Body"/>.</para>
- <para>Fetches the <c>BODY</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- <note type="note">Unlike <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/>, <c>Body</c> will not populate the
- <see cref="P:MailKit.BodyPart.ContentType"/> parameters nor will it populate the
- <see cref="P:MailKit.BodyPartBasic.ContentDisposition"/>, <see cref="P:MailKit.BodyPartBasic.ContentLanguage"/>
- or <see cref="P:MailKit.BodyPartBasic.ContentLocation"/> properties of each <see cref="T:MailKit.BodyPartBasic"/>
- body part. This makes <c>Body</c> far less useful than <c>BodyStructure</c> especially when
- it is desirable to determine whether or not a body part is an attachment.</note>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.BodyStructure">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.Body"/> (but with more details than <see cref="F:MailKit.MessageSummaryItems.Body"/>).</para>
- <para>Fetches the <c>BODYSTRUCTURE</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- <note type="note">Unlike <see cref="F:MailKit.MessageSummaryItems.Body"/>, <c>BodyStructure</c> will also populate the
- <see cref="P:MailKit.BodyPart.ContentType"/> parameters as well as the
- <see cref="P:MailKit.BodyPartBasic.ContentDisposition"/>, <see cref="P:MailKit.BodyPartBasic.ContentLanguage"/>
- and <see cref="P:MailKit.BodyPartBasic.ContentLocation"/> properties of each <see cref="T:MailKit.BodyPartBasic"/>
- body part. The <c>Content-Disposition</c> information is especially important when trying to
- determine whether or not a body part is an attachment, for example.</note>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.Envelope">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.Envelope"/>.</para>
- <para>Fetches the <c>ENVELOPE</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.Flags">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.Flags"/>.</para>
- <para>Fetches the <c>FLAGS</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.InternalDate">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.InternalDate"/>.</para>
- <para>Fetches the <c>INTERNALDATE</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.Size">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.Size"/>.</para>
- <para>Fetches the <c>RFC822.SIZE</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.ModSeq">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.ModSeq"/>.</para>
- <para>Fetches the <c>MODSEQ</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc4551">rfc4551</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.References">
- <summary>
- Fetch the <see cref="P:MailKit.IMessageSummary.References"/>.
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.UniqueId">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.UniqueId"/>.</para>
- <para>Fetches the <c>UID</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.EmailId">
- <summary>
- <para></para>Fetch the <see cref="P:MailKit.IMessageSummary.EmailId"/>.
- <para>Fetches the <c>EMAILID</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc8474">rfc8474</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.Id">
- <summary>
- <para></para>Fetch the <see cref="P:MailKit.IMessageSummary.EmailId"/>.
- <para>Fetches the <c>EMAILID</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc8474">rfc8474</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.ThreadId">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.ThreadId"/>.</para>
- <para>Fetches the <c>THREADID</c> value as defined in
- <a href="https://tools.ietf.org/html/rfc8474">rfc8474</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.GMailMessageId">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.GMailMessageId"/>.</para>
- <para>Fetches the <c>X-GM-MSGID</c> value as defined in Google's
- <a href="https://developers.google.com/gmail/imap/imap-extensions">IMAP extensions</a>
- documentation.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.GMailThreadId">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.GMailThreadId"/>.</para>
- <para>Fetches the <c>X-GM-THRID</c> value as defined in Google's
- <a href="https://developers.google.com/gmail/imap/imap-extensions">IMAP extensions</a>
- documentation.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.GMailLabels">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.GMailLabels"/>.</para>
- <para>Fetches the <c>X-GM-LABELS</c> value as defined in Google's
- <a href="https://developers.google.com/gmail/imap/imap-extensions">IMAP extensions</a>
- documentation.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.Headers">
- <summary>
- <para>Fetch the the complete list of <see cref="P:MailKit.IMessageSummary.Headers"/> for each message.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.PreviewText">
- <summary>
- <para>Fetch the <see cref="P:MailKit.IMessageSummary.PreviewText"/>.</para>
- <note type="note">This property is quite expensive to calculate because it is not an
- item that is cached on the IMAP server. Instead, MailKit must download a hunk of the
- message body so that it can decode and parse it in order to generate a meaningful
- text snippet. This usually involves downloading the first 512 bytes for <c>text/plain</c>
- message bodies and the first 16 kilobytes for <c>text/html</c> message bodies. If a
- message contains both a <c>text/plain</c> body and a <c>text/html</c> body, then the
- <c>text/plain</c> content is used in order to reduce network traffic.</note>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.All">
- <summary>
- <para>A macro for fetching the <see cref="F:MailKit.MessageSummaryItems.Envelope"/>, <see cref="F:MailKit.MessageSummaryItems.Flags"/>,
- <see cref="F:MailKit.MessageSummaryItems.InternalDate"/>, and <see cref="F:MailKit.MessageSummaryItems.Size"/> values.</para>
- <para>This macro maps to the equivalent <c>ALL</c> macro as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.Fast">
- <summary>
- <para>A macro for fetching the <see cref="F:MailKit.MessageSummaryItems.Flags"/>, <see cref="F:MailKit.MessageSummaryItems.InternalDate"/>, and
- <see cref="F:MailKit.MessageSummaryItems.Size"/> values.</para>
- <para>This macro maps to the equivalent <c>FAST</c> macro as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- </summary>
- </member>
- <member name="F:MailKit.MessageSummaryItems.Full">
- <summary>
- <para>A macro for fetching the <see cref="F:MailKit.MessageSummaryItems.Body"/>, <see cref="F:MailKit.MessageSummaryItems.Envelope"/>,
- <see cref="F:MailKit.MessageSummaryItems.Flags"/>, <see cref="F:MailKit.MessageSummaryItems.InternalDate"/>, and <see cref="F:MailKit.MessageSummaryItems.Size"/> values.</para>
- <para>This macro maps to the equivalent <c>FULL</c> macro as defined in
- <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
- </summary>
- </member>
- <member name="T:MailKit.MessagesVanishedEventArgs">
- <summary>
- Event args used when a message vanishes from a folder.
- </summary>
- <remarks>
- Event args used when a message vanishes from a folder.
- </remarks>
- </member>
- <member name="M:MailKit.MessagesVanishedEventArgs.#ctor(System.Collections.Generic.IList{MailKit.UniqueId},System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessagesVanishedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessagesVanishedEventArgs"/>.
- </remarks>
- <param name="uids">The list of unique identifiers.</param>
- <param name="earlier">If set to <c>true</c>, the messages vanished in the past as opposed to just now.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.MessagesVanishedEventArgs.UniqueIds">
- <summary>
- Gets the unique identifiers of the messages that vanished.
- </summary>
- <remarks>
- Gets the unique identifiers of the messages that vanished.
- </remarks>
- <value>The unique identifiers.</value>
- </member>
- <member name="P:MailKit.MessagesVanishedEventArgs.Earlier">
- <summary>
- Gets whether the messages vanished inthe past as opposed to just now.
- </summary>
- <remarks>
- Gets whether the messages vanished inthe past as opposed to just now.
- </remarks>
- <value><c>true</c> if the messages vanished earlier; otherwise, <c>false</c>.</value>
- </member>
- <member name="T:MailKit.MessageThread">
- <summary>
- A message thread.
- </summary>
- <remarks>
- A message thread.
- </remarks>
- </member>
- <member name="M:MailKit.MessageThread.#ctor(System.Nullable{MailKit.UniqueId})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageThread"/> class.
- </summary>
- <remarks>
- Creates a new message thread node.
- </remarks>
- <param name="uid">The unique identifier of the message.</param>
- </member>
- <member name="P:MailKit.MessageThread.UniqueId">
- <summary>
- Gets the unique identifier of the message.
- </summary>
- <remarks>
- The unique identifier may be <c>null</c> if the message is missing
- from the <see cref="T:MailKit.IMailFolder"/> or did not match the
- <see cref="T:MailKit.Search.SearchQuery"/>.
- </remarks>
- <value>The unique identifier.</value>
- </member>
- <member name="P:MailKit.MessageThread.Children">
- <summary>
- Gets the children.
- </summary>
- <remarks>
- Each child represents a reply to the message referenced by <see cref="P:MailKit.MessageThread.UniqueId"/>.
- </remarks>
- <value>The children.</value>
- </member>
- <member name="T:MailKit.MessageThreader">
- <summary>
- Threads messages according to the algorithms defined in rfc5256.
- </summary>
- <remarks>
- Threads messages according to the algorithms defined in rfc5256.
- </remarks>
- </member>
- <member name="M:MailKit.MessageThreader.Thread(System.Collections.Generic.IEnumerable{MailKit.IMessageSummary},MailKit.ThreadingAlgorithm)">
- <summary>
- Thread the messages according to the specified threading algorithm.
- </summary>
- <remarks>
- Thread the messages according to the specified threading algorithm.
- </remarks>
- <returns>The threaded messages.</returns>
- <param name="messages">The messages.</param>
- <param name="algorithm">The threading algorithm.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="messages"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not a valid threading algorithm.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="messages"/> contains one or more items that is missing information needed for threading.
- </exception>
- </member>
- <member name="M:MailKit.MessageThreader.Thread(System.Collections.Generic.IEnumerable{MailKit.IMessageSummary},MailKit.ThreadingAlgorithm,System.Collections.Generic.IList{MailKit.Search.OrderBy})">
- <summary>
- Threads the messages according to the specified threading algorithm
- and sorts the resulting threads by the specified ordering.
- </summary>
- <remarks>
- Threads the messages according to the specified threading algorithm
- and sorts the resulting threads by the specified ordering.
- </remarks>
- <returns>The threaded messages.</returns>
- <param name="messages">The messages.</param>
- <param name="algorithm">The threading algorithm.</param>
- <param name="orderBy">The requested sort ordering.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="messages"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is <c>null</c>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="algorithm"/> is not a valid threading algorithm.
- </exception>
- <exception cref="T:System.ArgumentException">
- <para><paramref name="messages"/> contains one or more items that is missing information needed for threading or sorting.</para>
- <para>-or-</para>
- <para><paramref name="orderBy"/> is an empty list.</para>
- </exception>
- </member>
- <member name="M:MailKit.MessageThreader.GetThreadableSubject(System.String,System.Int32@)">
- <summary>
- Gets the threadable subject.
- </summary>
- <remarks>
- Gets the threadable subject.
- </remarks>
- <returns>The threadable subject.</returns>
- <param name="subject">The Subject header value.</param>
- <param name="replyDepth">The reply depth.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="subject"/> is <c>null</c>.
- </exception>
- </member>
- <member name="T:MailKit.Metadata">
- <summary>
- A metadata tag and value.
- </summary>
- <remarks>
- A metadata tag and value.
- </remarks>
- </member>
- <member name="M:MailKit.Metadata.#ctor(MailKit.MetadataTag,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.Metadata"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.Metadata"/>.
- </remarks>
- <param name="tag">The metadata tag.</param>
- <param name="value">The metadata value.</param>
- </member>
- <member name="P:MailKit.Metadata.Tag">
- <summary>
- Gets the metadata tag.
- </summary>
- <remarks>
- Gets the metadata tag.
- </remarks>
- <value>The metadata tag.</value>
- </member>
- <member name="P:MailKit.Metadata.Value">
- <summary>
- Gets the metadata value.
- </summary>
- <remarks>
- Gets the metadata value.
- </remarks>
- <value>The metadata value.</value>
- </member>
- <member name="T:MailKit.MetadataChangedEventArgs">
- <summary>
- Event args used when a metadata changes.
- </summary>
- <remarks>
- Event args used when a metadata changes.
- </remarks>
- </member>
- <member name="M:MailKit.MetadataChangedEventArgs.#ctor(MailKit.Metadata)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MetadataChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MetadataChangedEventArgs"/>.
- </remarks>
- <param name="metadata">The metadata that changed.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="metadata"/> is <c>null</c>.
- </exception>
- </member>
- <member name="P:MailKit.MetadataChangedEventArgs.Metadata">
- <summary>
- Get the metadata that changed.
- </summary>
- <remarks>
- Gets the metadata that changed.
- </remarks>
- <value>The metadata.</value>
- </member>
- <member name="T:MailKit.MetadataCollection">
- <summary>
- A collection of metadata.
- </summary>
- <remarks>
- A collection of metadata.
- </remarks>
- </member>
- <member name="M:MailKit.MetadataCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MetadataCollection"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MetadataCollection"/>
- </remarks>
- </member>
- <member name="M:MailKit.MetadataCollection.#ctor(System.Collections.Generic.IEnumerable{MailKit.Metadata})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MetadataCollection"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MetadataCollection"/>.
- </remarks>
- <param name="collection">A collection of metadata.</param>
- </member>
- <member name="T:MailKit.MetadataOptions">
- <summary>
- A set of options to use when requesting metadata.
- </summary>
- <remarks>
- A set of options to use when requesting metadata.
- </remarks>
- </member>
- <member name="M:MailKit.MetadataOptions.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MetadataOptions"/> class.
- </summary>
- <remarks>
- Creates a new set of options to use when requesting metadata.
- </remarks>
- </member>
- <member name="P:MailKit.MetadataOptions.Depth">
- <summary>
- Get or set the depth.
- </summary>
- <remarks>
- <para>When the <see cref="P:MailKit.MetadataOptions.Depth"/> option is specified, it extends the list of metadata tag
- values returned by the GetMetadata() call. For each <see cref="T:MailKit.MetadataTag"/> specified in the
- the GetMetadata() call, the method returns the value of the specified metadata tag (if it exists),
- plus all metadata tags below the specified entry up to the specified depth.</para>
- <para>Three values are allowed for <see cref="P:MailKit.MetadataOptions.Depth"/>:</para>
- <para><c>0</c> - no entries below the specified metadata tag are returned.</para>
- <para><c>1</c> - only entries immediately below the specified metadata tag are returned.</para>
- <para><see cref="F:System.Int32.MaxValue"/> - all entries below the specified metadata tag are returned.</para>
- <para>Thus, a depth of <c>1</c> for a tag entry of <c>"/a"</c> will match <c>"/a"</c> as well as its children
- entries (e.g., <c>"/a/b"</c>), but will not match grandchildren entries (e.g., <c>"/a/b/c"</c>).</para>
- <para>If the Depth option is not specified, this is the same as specifying <c>0</c>.</para>
- </remarks>
- <value>The depth.</value>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="value"/> is out of range.
- </exception>
- </member>
- <member name="P:MailKit.MetadataOptions.MaxSize">
- <summary>
- Get or set the max size of the metadata tags to request.
- </summary>
- <remarks>
- When specified, the <see cref="P:MailKit.MetadataOptions.MaxSize"/> property is used to filter the metadata tags
- returned by the GetMetadata() call to only those with a value shorter than the max size
- specified.
- </remarks>
- <value>The size of the max.</value>
- </member>
- <member name="P:MailKit.MetadataOptions.LongEntries">
- <summary>
- Get the length of the longest metadata value.
- </summary>
- <remarks>
- If the <see cref="P:MailKit.MetadataOptions.MaxSize"/> property is specified, once the GetMetadata() call returns,
- the <see cref="P:MailKit.MetadataOptions.LongEntries"/> property will be set to the length of the longest metadata
- value that exceeded the <see cref="P:MailKit.MetadataOptions.MaxSize"/> limit, otherwise a value of <c>0</c> will
- be set.
- </remarks>
- <value>The length of the longest metadata value that exceeded the max size.</value>
- </member>
- <member name="T:MailKit.MetadataTag">
- <summary>
- A metadata tag.
- </summary>
- <remarks>
- A metadata tag.
- </remarks>
- </member>
- <member name="F:MailKit.MetadataTag.SharedAdmin">
- <summary>
- A metadata tag for specifying the contact information for the server administrator.
- </summary>
- <remarks>
- Used to get the contact information of the administrator on a
- <see cref="T:MailKit.IMailStore"/>.
- </remarks>
- </member>
- <member name="F:MailKit.MetadataTag.PrivateComment">
- <summary>
- A metadata tag for private comments.
- </summary>
- <remarks>
- Used to get or set a private comment on a <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="F:MailKit.MetadataTag.SharedComment">
- <summary>
- A metadata tag for shared comments.
- </summary>
- <remarks>
- Used to get or set a shared comment on a <see cref="T:MailKit.IMailStore"/>
- or <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="F:MailKit.MetadataTag.PrivateSpecialUse">
- <summary>
- A metadata tag for specifying the special use of a folder.
- </summary>
- <remarks>
- Used to get or set the special use of a <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="M:MailKit.MetadataTag.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MetadataTag"/> struct.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MetadataTag"/>.
- </remarks>
- <param name="id">The metadata tag identifier.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="id"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="id"/> is an empty string.
- </exception>
- </member>
- <member name="P:MailKit.MetadataTag.Id">
- <summary>
- Get the metadata tag identifier.
- </summary>
- <remarks>
- Gets the metadata tag identifier.
- </remarks>
- <value>The metadata tag identifier.</value>
- </member>
- <member name="M:MailKit.MetadataTag.Equals(System.Object)">
- <summary>
- Determine whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.MetadataTag"/>.
- </summary>
- <remarks>
- Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.MetadataTag"/>.
- </remarks>
- <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:MailKit.MetadataTag"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current
- <see cref="T:MailKit.MetadataTag"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:MailKit.MetadataTag.GetHashCode">
- <summary>
- Serves as a hash function for a <see cref="T:MailKit.MetadataTag"/> object.
- </summary>
- <remarks>
- Serves as a hash function for a <see cref="T:MailKit.MetadataTag"/> object.
- </remarks>
- <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.</returns>
- </member>
- <member name="M:MailKit.MetadataTag.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.MetadataTag"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.MetadataTag"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.MetadataTag"/>.</returns>
- </member>
- <member name="T:MailKit.ModSeqChangedEventArgs">
- <summary>
- Event args for the <see cref="E:MailKit.IMailFolder.ModSeqChanged"/> event.
- </summary>
- <remarks>
- Event args for the <see cref="E:MailKit.IMailFolder.ModSeqChanged"/> event.
- </remarks>
- </member>
- <member name="M:MailKit.ModSeqChangedEventArgs.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ModSeqChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ModSeqChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- </member>
- <member name="M:MailKit.ModSeqChangedEventArgs.#ctor(System.Int32,System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="modseq">The modification sequence value.</param>
- </member>
- <member name="M:MailKit.ModSeqChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ModSeqChangedEventArgs"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ModSeqChangedEventArgs"/>.
- </remarks>
- <param name="index">The message index.</param>
- <param name="uid">The unique id of the message.</param>
- <param name="modseq">The modification sequence value.</param>
- </member>
- <member name="P:MailKit.ModSeqChangedEventArgs.ModSeq">
- <summary>
- Gets the updated mod-sequence value of the message.
- </summary>
- <remarks>
- Gets the updated mod-sequence value of the message.
- </remarks>
- <value>The mod-sequence value.</value>
- </member>
- <member name="T:MailKit.NullProtocolLogger">
- <summary>
- A protocol logger that does not log to anywhere.
- </summary>
- <remarks>
- By default, the <see cref="T:MailKit.Net.Smtp.SmtpClient"/>,
- <see cref="T:MailKit.Net.Pop3.Pop3Client"/>, and
- <see cref="T:MailKit.Net.Imap.ImapClient"/> all use a
- <see cref="T:MailKit.NullProtocolLogger"/>.
- </remarks>
- </member>
- <member name="M:MailKit.NullProtocolLogger.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.NullProtocolLogger"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.NullProtocolLogger"/>.
- </remarks>
- </member>
- <member name="M:MailKit.NullProtocolLogger.LogConnect(System.Uri)">
- <summary>
- Logs a connection to the specified URI.
- </summary>
- <remarks>
- This method does nothing.
- </remarks>
- <param name="uri">The URI.</param>
- </member>
- <member name="M:MailKit.NullProtocolLogger.LogClient(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Logs a sequence of bytes sent by the client.
- </summary>
- <remarks>
- This method does nothing.
- </remarks>
- <param name='buffer'>The buffer to log.</param>
- <param name='offset'>The offset of the first byte to log.</param>
- <param name='count'>The number of bytes to log.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.NullProtocolLogger.LogServer(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Logs a sequence of bytes sent by the server.
- </summary>
- <remarks>
- This method does nothing.
- </remarks>
- <param name='buffer'>The buffer to log.</param>
- <param name='offset'>The offset of the first byte to log.</param>
- <param name='count'>The number of bytes to log.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.NullProtocolLogger.Dispose">
- <summary>
- Releases all resource used by the <see cref="T:MailKit.NullProtocolLogger"/> object.
- </summary>
- <remarks>Call <see cref="M:MailKit.NullProtocolLogger.Dispose"/> when you are finished using the <see cref="T:MailKit.NullProtocolLogger"/>. The
- <see cref="M:MailKit.NullProtocolLogger.Dispose"/> method leaves the <see cref="T:MailKit.NullProtocolLogger"/> in an unusable state. After
- calling <see cref="M:MailKit.NullProtocolLogger.Dispose"/>, you must release all references to the <see cref="T:MailKit.NullProtocolLogger"/> so
- the garbage collector can reclaim the memory that the <see cref="T:MailKit.NullProtocolLogger"/> was occupying.</remarks>
- </member>
- <member name="T:MailKit.ProtocolException">
- <summary>
- The exception that is thrown when there is a protocol error.
- </summary>
- <remarks>
- <para>A <see cref="T:MailKit.ProtocolException"/> can be thrown by any of the various client
- methods in MailKit.</para>
- <para>Since many protocol exceptions are fatal, it is important to check whether
- or not the client is still connected using the <see cref="P:MailKit.IMailService.IsConnected"/>
- property when this exception is thrown.</para>
- </remarks>
- </member>
- <member name="M:MailKit.ProtocolException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">An inner exception.</param>
- </member>
- <member name="M:MailKit.ProtocolException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ProtocolException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.ProtocolException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ProtocolException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ProtocolException"/>.
- </remarks>
- </member>
- <member name="T:MailKit.ProtocolLogger">
- <summary>
- A default protocol logger for logging the communication between a client and server.
- </summary>
- <remarks>
- A default protocol logger for logging the communication between a client and server.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ProtocolLogger" />
- </example>
- </member>
- <member name="M:MailKit.ProtocolLogger.#ctor(System.String,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ProtocolLogger"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ProtocolLogger"/> to log to a specified file. The file is created if it does not exist.
- </remarks>
- <example>
- <code language="c#" source="Examples\SmtpExamples.cs" region="ProtocolLogger" />
- </example>
- <param name="fileName">The file name.</param>
- <param name="append"><c>true</c> if the file should be appended to; otherwise, <c>false</c>. Defaults to <c>true</c>.</param>
- </member>
- <member name="M:MailKit.ProtocolLogger.#ctor(System.IO.Stream,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ProtocolLogger"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ProtocolLogger"/> to log to a specified stream.
- </remarks>
- <param name="stream">The stream.</param>
- <param name="leaveOpen"><c>true</c> if the stream should be left open after the protocol logger is disposed.</param>
- </member>
- <member name="M:MailKit.ProtocolLogger.Finalize">
- <summary>
- Releases unmanaged resources and performs other cleanup operations before the <see cref="T:MailKit.ProtocolLogger"/>
- is reclaimed by garbage collection.
- </summary>
- <remarks>
- Releases unmanaged resources and performs other cleanup operations before the <see cref="T:MailKit.ProtocolLogger"/>
- is reclaimed by garbage collection.
- </remarks>
- </member>
- <member name="P:MailKit.ProtocolLogger.Stream">
- <summary>
- Get the log stream.
- </summary>
- <remarks>
- Gets the log stream.
- </remarks>
- <value>The log sstream.</value>
- </member>
- <member name="M:MailKit.ProtocolLogger.LogConnect(System.Uri)">
- <summary>
- Logs a connection to the specified URI.
- </summary>
- <remarks>
- Logs a connection to the specified URI.
- </remarks>
- <param name="uri">The URI.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uri"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The logger has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.ProtocolLogger.LogClient(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Logs a sequence of bytes sent by the client.
- </summary>
- <remarks>
- <para>Logs a sequence of bytes sent by the client.</para>
- <para><see cref="M:MailKit.ProtocolLogger.LogClient(System.Byte[],System.Int32,System.Int32)"/> is called by the <see cref="T:MailKit.IMailService"/> upon every successful
- write operation to its underlying network stream, passing the exact same <paramref name="buffer"/>,
- <paramref name="offset"/>, and <paramref name="count"/> arguments to the logging function.</para>
- </remarks>
- <param name='buffer'>The buffer to log.</param>
- <param name='offset'>The offset of the first byte to log.</param>
- <param name='count'>The number of bytes to log.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The logger has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.ProtocolLogger.LogServer(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Logs a sequence of bytes sent by the server.
- </summary>
- <remarks>
- <para>Logs a sequence of bytes sent by the server.</para>
- <para><see cref="M:MailKit.ProtocolLogger.LogServer(System.Byte[],System.Int32,System.Int32)"/> is called by the <see cref="T:MailKit.IMailService"/> upon every successful
- read of its underlying network stream with the exact buffer that was read.</para>
- </remarks>
- <param name='buffer'>The buffer to log.</param>
- <param name='offset'>The offset of the first byte to log.</param>
- <param name='count'>The number of bytes to log.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="buffer"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
- <para>-or-</para>
- <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
- at the specified <paramref name="offset"/>.</para>
- </exception>
- <exception cref="T:System.ObjectDisposedException">
- The logger has been disposed.
- </exception>
- <exception cref="T:System.IO.IOException">
- An I/O error occurred.
- </exception>
- </member>
- <member name="M:MailKit.ProtocolLogger.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:MailKit.ProtocolLogger"/> and
- optionally releases the managed resources.
- </summary>
- <remarks>
- Releases the unmanaged resources used by the <see cref="T:MailKit.ProtocolLogger"/> and
- optionally releases the managed resources.
- </remarks>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
- <c>false</c> to release only the unmanaged resources.</param>
- </member>
- <member name="M:MailKit.ProtocolLogger.Dispose">
- <summary>
- Releases all resource used by the <see cref="T:MailKit.ProtocolLogger"/> object.
- </summary>
- <remarks>Call <see cref="M:MailKit.ProtocolLogger.Dispose"/> when you are finished using the <see cref="T:MailKit.ProtocolLogger"/>. The
- <see cref="M:MailKit.ProtocolLogger.Dispose"/> method leaves the <see cref="T:MailKit.ProtocolLogger"/> in an unusable state. After calling
- <see cref="M:MailKit.ProtocolLogger.Dispose"/>, you must release all references to the <see cref="T:MailKit.ProtocolLogger"/> so the garbage
- collector can reclaim the memory that the <see cref="T:MailKit.ProtocolLogger"/> was occupying.</remarks>
- </member>
- <member name="T:MailKit.ServiceNotAuthenticatedException">
- <summary>
- The exception that is thrown when the <see cref="T:MailKit.IMailService"/> is not authenticated.
- </summary>
- <remarks>
- This exception is thrown when an operation on a service could not be completed
- due to the service not being authenticated.
- </remarks>
- </member>
- <member name="M:MailKit.ServiceNotAuthenticatedException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ServiceNotAuthenticatedException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ServiceNotAuthenticatedException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">The inner exception.</param>
- </member>
- <member name="M:MailKit.ServiceNotAuthenticatedException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ServiceNotAuthenticatedException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ServiceNotAuthenticatedException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.ServiceNotAuthenticatedException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ServiceNotAuthenticatedException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ServiceNotAuthenticatedException"/>.
- </remarks>
- </member>
- <member name="T:MailKit.ServiceNotConnectedException">
- <summary>
- The exception that is thrown when the <see cref="T:MailKit.IMailService"/> is not connected.
- </summary>
- <remarks>
- This exception is thrown when an operation on a service could not be completed
- due to the service not being connected.
- </remarks>
- </member>
- <member name="M:MailKit.ServiceNotConnectedException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ServiceNotConnectedException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ServiceNotConnectedException"/>.
- </remarks>
- <param name="message">The error message.</param>
- <param name="innerException">The inner exception.</param>
- </member>
- <member name="M:MailKit.ServiceNotConnectedException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ServiceNotConnectedException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ServiceNotConnectedException"/>.
- </remarks>
- <param name="message">The error message.</param>
- </member>
- <member name="M:MailKit.ServiceNotConnectedException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.ServiceNotConnectedException"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.ServiceNotConnectedException"/>.
- </remarks>
- </member>
- <member name="T:MailKit.SpecialFolder">
- <summary>
- An enumeration of special folders.
- </summary>
- <remarks>
- An enumeration of special folders.
- </remarks>
- </member>
- <member name="F:MailKit.SpecialFolder.All">
- <summary>
- The special folder containing an aggregate of all messages.
- </summary>
- </member>
- <member name="F:MailKit.SpecialFolder.Archive">
- <summary>
- The special folder that contains archived messages.
- </summary>
- </member>
- <member name="F:MailKit.SpecialFolder.Drafts">
- <summary>
- The special folder that contains message drafts.
- </summary>
- </member>
- <member name="F:MailKit.SpecialFolder.Flagged">
- <summary>
- The special folder that contains important messages.
- </summary>
- </member>
- <member name="F:MailKit.SpecialFolder.Junk">
- <summary>
- The special folder that contains spam messages.
- </summary>
- </member>
- <member name="F:MailKit.SpecialFolder.Sent">
- <summary>
- The special folder that contains sent messages.
- </summary>
- </member>
- <member name="F:MailKit.SpecialFolder.Trash">
- <summary>
- The special folder that contains deleted messages.
- </summary>
- </member>
- <member name="T:MailKit.StatusItems">
- <summary>
- Status items.
- </summary>
- <remarks>
- Used with <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
- </remarks>
- </member>
- <member name="F:MailKit.StatusItems.None">
- <summary>
- No status requested.
- </summary>
- </member>
- <member name="F:MailKit.StatusItems.Count">
- <summary>
- Updates <see cref="P:MailKit.IMailFolder.Count"/>.
- </summary>
- </member>
- <member name="F:MailKit.StatusItems.Recent">
- <summary>
- Updates <see cref="P:MailKit.IMailFolder.Recent"/>.
- </summary>
- </member>
- <member name="F:MailKit.StatusItems.UidNext">
- <summary>
- Updates <see cref="P:MailKit.IMailFolder.UidNext"/>.
- </summary>
- </member>
- <member name="F:MailKit.StatusItems.UidValidity">
- <summary>
- Updates <see cref="P:MailKit.IMailFolder.UidValidity"/>.
- </summary>
- </member>
- <member name="F:MailKit.StatusItems.Unread">
- <summary>
- Updates <see cref="P:MailKit.IMailFolder.Unread"/>.
- </summary>
- </member>
- <member name="F:MailKit.StatusItems.HighestModSeq">
- <summary>
- Updates <see cref="P:MailKit.IMailFolder.HighestModSeq"/>.
- </summary>
- </member>
- <member name="F:MailKit.StatusItems.AppendLimit">
- <summary>
- Updates <see cref="P:MailKit.IMailFolder.AppendLimit"/>.
- </summary>
- </member>
- <member name="F:MailKit.StatusItems.Size">
- <summary>
- Updates <see cref="P:MailKit.IMailFolder.Size"/>.
- </summary>
- </member>
- <member name="F:MailKit.StatusItems.MailboxId">
- <summary>
- Updates <see cref="P:MailKit.IMailFolder.Id"/>.
- </summary>
- </member>
- <member name="T:MailKit.ThreadingAlgorithm">
- <summary>
- An enumeration of threading algorithms.
- </summary>
- <remarks>
- A threading algorithm is used to group messages and their
- replies together.
- </remarks>
- </member>
- <member name="F:MailKit.ThreadingAlgorithm.OrderedSubject">
- <summary>
- Thread messages based on their Subject headers.
- </summary>
- </member>
- <member name="F:MailKit.ThreadingAlgorithm.References">
- <summary>
- Threads messages based on their References, In-Reply-To, and Message-Id headers.
- This algorithm is far better than <see cref="F:MailKit.ThreadingAlgorithm.OrderedSubject"/> but is also more
- expensive to calculate.
- </summary>
- </member>
- <member name="T:MailKit.UniqueId">
- <summary>
- A unique identifier.
- </summary>
- <remarks>
- Represents a unique identifier for messages in a <see cref="T:MailKit.IMailFolder"/>.
- </remarks>
- </member>
- <member name="F:MailKit.UniqueId.Invalid">
- <summary>
- The invalid <see cref="T:MailKit.UniqueId"/> value.
- </summary>
- <remarks>
- The invalid <see cref="T:MailKit.UniqueId"/> value.
- </remarks>
- </member>
- <member name="F:MailKit.UniqueId.MinValue">
- <summary>
- The minimum <see cref="T:MailKit.UniqueId"/> value.
- </summary>
- <remarks>
- The minimum <see cref="T:MailKit.UniqueId"/> value.
- </remarks>
- </member>
- <member name="F:MailKit.UniqueId.MaxValue">
- <summary>
- The maximum <see cref="T:MailKit.UniqueId"/> value.
- </summary>
- <remarks>
- The maximum <see cref="T:MailKit.UniqueId"/> value.
- </remarks>
- </member>
- <member name="M:MailKit.UniqueId.#ctor(System.UInt32,System.UInt32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.UniqueId"/> struct.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.UniqueId"/> with the specified validity and value.
- </remarks>
- <param name="validity">The uid validity.</param>
- <param name="id">The unique identifier.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="id"/> is <c>0</c>.
- </exception>
- </member>
- <member name="M:MailKit.UniqueId.#ctor(System.UInt32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.UniqueId"/> struct.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.UniqueId"/> with the specified value.
- </remarks>
- <param name="id">The unique identifier.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="id"/> is <c>0</c>.
- </exception>
- </member>
- <member name="P:MailKit.UniqueId.Id">
- <summary>
- Gets the identifier.
- </summary>
- <remarks>
- The identifier.
- </remarks>
- <value>The identifier.</value>
- </member>
- <member name="P:MailKit.UniqueId.Validity">
- <summary>
- Gets the validity, if non-zero.
- </summary>
- <remarks>
- Gets the UidValidity of the containing folder.
- </remarks>
- <value>The UidValidity of the containing folder.</value>
- </member>
- <member name="P:MailKit.UniqueId.IsValid">
- <summary>
- Gets whether or not the unique identifier is valid.
- </summary>
- <remarks>
- Gets whether or not the unique identifier is valid.
- </remarks>
- <value><c>true</c> if the unique identifier is valid; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.UniqueId.CompareTo(MailKit.UniqueId)">
- <summary>
- Compares two <see cref="T:MailKit.UniqueId"/> objects.
- </summary>
- <remarks>
- Compares two <see cref="T:MailKit.UniqueId"/> objects.
- </remarks>
- <returns>
- A value less than <c>0</c> if this <see cref="T:MailKit.UniqueId"/> is less than <paramref name="other"/>,
- a value of <c>0</c> if this <see cref="T:MailKit.UniqueId"/> is equal to <paramref name="other"/>, or
- a value greater than <c>0</c> if this <see cref="T:MailKit.UniqueId"/> is greater than <paramref name="other"/>.
- </returns>
- <param name="other">The other unique identifier.</param>
- </member>
- <member name="M:MailKit.UniqueId.Equals(MailKit.UniqueId)">
- <summary>
- Determines whether the specified <see cref="T:MailKit.UniqueId"/> is equal to the current <see cref="T:MailKit.UniqueId"/>.
- </summary>
- <remarks>
- Determines whether the specified <see cref="T:MailKit.UniqueId"/> is equal to the current <see cref="T:MailKit.UniqueId"/>.
- </remarks>
- <param name="other">The <see cref="T:MailKit.UniqueId"/> to compare with the current <see cref="T:MailKit.UniqueId"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:MailKit.UniqueId"/> is equal to the current
- <see cref="T:MailKit.UniqueId"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:MailKit.UniqueId.op_Equality(MailKit.UniqueId,MailKit.UniqueId)">
- <summary>
- Determines whether two unique identifiers are equal.
- </summary>
- <remarks>
- Determines whether two unique identifiers are equal.
- </remarks>
- <returns><c>true</c> if <paramref name="uid1"/> and <paramref name="uid2"/> are equal; otherwise, <c>false</c>.</returns>
- <param name="uid1">The first unique id to compare.</param>
- <param name="uid2">The second unique id to compare.</param>
- </member>
- <member name="M:MailKit.UniqueId.op_GreaterThan(MailKit.UniqueId,MailKit.UniqueId)">
- <summary>
- Determines whether one unique identifier is greater than another unique identifier.
- </summary>
- <remarks>
- Determines whether one unique identifier is greater than another unique identifier.
- </remarks>
- <returns><c>true</c> if <paramref name="uid1"/> is greater than <paramref name="uid2"/>; otherwise, <c>false</c>.</returns>
- <param name="uid1">The first unique id to compare.</param>
- <param name="uid2">The second unique id to compare.</param>
- </member>
- <member name="M:MailKit.UniqueId.op_GreaterThanOrEqual(MailKit.UniqueId,MailKit.UniqueId)">
- <summary>
- Determines whether one unique identifier is greater than or equal to another unique identifier.
- </summary>
- <remarks>
- Determines whether one unique identifier is greater than or equal to another unique identifier.
- </remarks>
- <returns><c>true</c> if <paramref name="uid1"/> is greater than or equal to <paramref name="uid2"/>; otherwise, <c>false</c>.</returns>
- <param name="uid1">The first unique id to compare.</param>
- <param name="uid2">The second unique id to compare.</param>
- </member>
- <member name="M:MailKit.UniqueId.op_Inequality(MailKit.UniqueId,MailKit.UniqueId)">
- <summary>
- Determines whether two unique identifiers are not equal.
- </summary>
- <remarks>
- Determines whether two unique identifiers are not equal.
- </remarks>
- <returns><c>true</c> if <paramref name="uid1"/> and <paramref name="uid2"/> are not equal; otherwise, <c>false</c>.</returns>
- <param name="uid1">The first unique id to compare.</param>
- <param name="uid2">The second unique id to compare.</param>
- </member>
- <member name="M:MailKit.UniqueId.op_LessThan(MailKit.UniqueId,MailKit.UniqueId)">
- <summary>
- Determines whether one unique identifier is less than another unique identifier.
- </summary>
- <remarks>
- Determines whether one unique identifier is less than another unique identifier.
- </remarks>
- <returns><c>true</c> if <paramref name="uid1"/> is less than <paramref name="uid2"/>; otherwise, <c>false</c>.</returns>
- <param name="uid1">The first unique id to compare.</param>
- <param name="uid2">The second unique id to compare.</param>
- </member>
- <member name="M:MailKit.UniqueId.op_LessThanOrEqual(MailKit.UniqueId,MailKit.UniqueId)">
- <summary>
- Determines whether one unique identifier is less than or equal to another unique identifier.
- </summary>
- <remarks>
- Determines whether one unique identifier is less than or equal to another unique identifier.
- </remarks>
- <returns><c>true</c> if <paramref name="uid1"/> is less than or equal to <paramref name="uid2"/>; otherwise, <c>false</c>.</returns>
- <param name="uid1">The first unique id to compare.</param>
- <param name="uid2">The second unique id to compare.</param>
- </member>
- <member name="M:MailKit.UniqueId.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.UniqueId"/>.
- </summary>
- <remarks>
- Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.UniqueId"/>.
- </remarks>
- <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:MailKit.UniqueId"/>.</param>
- <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.UniqueId"/>;
- otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:MailKit.UniqueId.GetHashCode">
- <summary>
- Serves as a hash function for a <see cref="T:MailKit.UniqueId"/> object.
- </summary>
- <remarks>
- Serves as a hash function for a <see cref="T:MailKit.UniqueId"/> object.
- </remarks>
- <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.</returns>
- </member>
- <member name="M:MailKit.UniqueId.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueId"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueId"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueId"/>.</returns>
- </member>
- <member name="M:MailKit.UniqueId.TryParse(System.String,System.Int32@,System.UInt32@)">
- <summary>
- Attempt to parse a unique identifier.
- </summary>
- <remarks>
- Attempts to parse a unique identifier.
- </remarks>
- <returns><c>true</c> if the unique identifier was successfully parsed; otherwise, <c>false.</c>.</returns>
- <param name="token">The token to parse.</param>
- <param name="index">The index to start parsing.</param>
- <param name="uid">The unique identifier.</param>
- </member>
- <member name="M:MailKit.UniqueId.TryParse(System.String,System.UInt32,MailKit.UniqueId@)">
- <summary>
- Attempt to parse a unique identifier.
- </summary>
- <remarks>
- Attempts to parse a unique identifier.
- </remarks>
- <returns><c>true</c> if the unique identifier was successfully parsed; otherwise, <c>false.</c>.</returns>
- <param name="token">The token to parse.</param>
- <param name="validity">The UIDVALIDITY value.</param>
- <param name="uid">The unique identifier.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="token"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.UniqueId.TryParse(System.String,MailKit.UniqueId@)">
- <summary>
- Attempt to parse a unique identifier.
- </summary>
- <remarks>
- Attempts to parse a unique identifier.
- </remarks>
- <returns><c>true</c> if the unique identifier was successfully parsed; otherwise, <c>false.</c>.</returns>
- <param name="token">The token to parse.</param>
- <param name="uid">The unique identifier.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="token"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.UniqueId.Parse(System.String,System.UInt32)">
- <summary>
- Parse a unique identifier.
- </summary>
- <remarks>
- Parses a unique identifier.
- </remarks>
- <returns>The unique identifier.</returns>
- <param name="token">A string containing the unique identifier.</param>
- <param name="validity">The UIDVALIDITY.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="token"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.FormatException">
- <paramref name="token"/> is not in the correct format.
- </exception>
- <exception cref="T:System.OverflowException">
- The unique identifier is greater than <see cref="F:MailKit.UniqueId.MaxValue"/>.
- </exception>
- </member>
- <member name="M:MailKit.UniqueId.Parse(System.String)">
- <summary>
- Parse a unique identifier.
- </summary>
- <remarks>
- Parses a unique identifier.
- </remarks>
- <returns>The unique identifier.</returns>
- <param name="token">A string containing the unique identifier.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="token"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.FormatException">
- <paramref name="token"/> is not in the correct format.
- </exception>
- <exception cref="T:System.OverflowException">
- The unique identifier is greater than <see cref="F:MailKit.UniqueId.MaxValue"/>.
- </exception>
- </member>
- <member name="T:MailKit.UniqueIdMap">
- <summary>
- A mapping of unique identifiers.
- </summary>
- <remarks>
- <para>A <see cref="T:MailKit.UniqueIdMap"/> can be used to discover the mapping of one set of unique identifiers
- to another.</para>
- <para>For example, when copying or moving messages from one folder to another, it is often desirable
- to know what the unique identifiers are for each of the messages in the destination folder.</para>
- </remarks>
- </member>
- <member name="F:MailKit.UniqueIdMap.Empty">
- <summary>
- Any empty mapping of unique identifiers.
- </summary>
- <remarks>
- Any empty mapping of unique identifiers.
- </remarks>
- </member>
- <member name="M:MailKit.UniqueIdMap.#ctor(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.UniqueId})">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.UniqueIdMap"/> class.
- </summary>
- <remarks>
- Creates a new <see cref="T:MailKit.UniqueIdMap"/>.
- </remarks>
- <param name="source">The unique identifiers used in the source folder.</param>
- <param name="destination">The unique identifiers used in the destination folder.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="source"/> is <c>null</c>.</para>
- <para>-or-</para>
- <para><paramref name="destination"/> is <c>null</c>.</para>
- </exception>
- </member>
- <member name="P:MailKit.UniqueIdMap.Source">
- <summary>
- Gets the list of unique identifiers used in the source folder.
- </summary>
- <remarks>
- Gets the list of unique identifiers used in the source folder.
- </remarks>
- <value>The unique identifiers used in the source folder.</value>
- </member>
- <member name="P:MailKit.UniqueIdMap.Destination">
- <summary>
- Gets the list of unique identifiers used in the destination folder.
- </summary>
- <remarks>
- Gets the list of unique identifiers used in the destination folder.
- </remarks>
- <value>The unique identifiers used in the destination folder.</value>
- </member>
- <member name="P:MailKit.UniqueIdMap.Count">
- <summary>
- Gets the number of unique identifiers that have been remapped.
- </summary>
- <remarks>
- Gets the number of unique identifiers that have been remapped.
- </remarks>
- <value>The count.</value>
- </member>
- <member name="P:MailKit.UniqueIdMap.Keys">
- <summary>
- Gets the keys.
- </summary>
- <remarks>
- Gets the keys.
- </remarks>
- <value>The keys.</value>
- </member>
- <member name="P:MailKit.UniqueIdMap.Values">
- <summary>
- Gets the values.
- </summary>
- <remarks>
- Gets the values.
- </remarks>
- <value>The values.</value>
- </member>
- <member name="M:MailKit.UniqueIdMap.ContainsKey(MailKit.UniqueId)">
- <summary>
- Checks if the specified unique identifier has been remapped.
- </summary>
- <remarks>
- Checks if the specified unique identifier has been remapped.
- </remarks>
- <returns><c>true</c> if the unique identifier has been remapped; otherwise, <c>false</c>.</returns>
- <param name="key">The unique identifier.</param>
- </member>
- <member name="M:MailKit.UniqueIdMap.TryGetValue(MailKit.UniqueId,MailKit.UniqueId@)">
- <summary>
- Tries to get the remapped unique identifier.
- </summary>
- <remarks>
- Attempts to get the remapped unique identifier.
- </remarks>
- <returns><c>true</c> on success; otherwise, <c>false</c>.</returns>
- <param name="key">The unique identifier of the message in the source folder.</param>
- <param name="value">The unique identifier of the message in the destination folder.</param>
- </member>
- <member name="P:MailKit.UniqueIdMap.Item(MailKit.UniqueId)">
- <summary>
- Gets the remapped unique identifier.
- </summary>
- <remarks>
- Gets the remapped unique identifier.
- </remarks>
- <param name="index">The unique identifier of the message in the source folder.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdMap.GetEnumerator">
- <summary>
- Gets the enumerator for the remapped unique identifiers.
- </summary>
- <remarks>
- Gets the enumerator for the remapped unique identifiers.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.UniqueIdMap.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Gets the enumerator for the remapped unique identifiers.
- </summary>
- <remarks>
- Gets the enumerator for the remapped unique identifiers.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="T:MailKit.UniqueIdRange">
- <summary>
- A range of <see cref="T:MailKit.UniqueId"/> items.
- </summary>
- <remarks>
- When dealing with a large range, it is more efficient to use a
- <see cref="T:MailKit.UniqueIdRange"/> than a typical
- IList<<see cref="T:MailKit.UniqueId"/>>.
- </remarks>
- </member>
- <member name="F:MailKit.UniqueIdRange.All">
- <summary>
- A <see cref="T:MailKit.UniqueIdRange"/> that encompases all messages in the folder.
- </summary>
- <remarks>
- Represents the range of messages from <see cref="F:MailKit.UniqueId.MinValue"/> to
- <see cref="F:MailKit.UniqueId.MaxValue"/>.
- </remarks>
- </member>
- <member name="M:MailKit.UniqueIdRange.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.UniqueIdRange"/> class.
- </summary>
- <remarks>
- Creates a new (invalid) range of unique identifiers.
- </remarks>
- </member>
- <member name="M:MailKit.UniqueIdRange.#ctor(System.UInt32,System.UInt32,System.UInt32)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.UniqueIdRange"/> class.
- </summary>
- <remarks>
- Creates a new range of unique identifiers.
- </remarks>
- <param name="validity">The uid validity.</param>
- <param name="start">The first unique identifier in the range.</param>
- <param name="end">The last unique identifier in the range.</param>
- </member>
- <member name="M:MailKit.UniqueIdRange.#ctor(MailKit.UniqueId,MailKit.UniqueId)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.UniqueIdRange"/> class.
- </summary>
- <remarks>
- Creates a new range of unique identifiers.
- </remarks>
- <param name="start">The first <see cref="T:MailKit.UniqueId"/> in the range.</param>
- <param name="end">The last <see cref="T:MailKit.UniqueId"/> in the range.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="start"/> is invalid.</para>
- <para>-or-</para>
- <para><paramref name="end"/> is invalid.</para>
- </exception>
- </member>
- <member name="P:MailKit.UniqueIdRange.Validity">
- <summary>
- Gets the validity, if non-zero.
- </summary>
- <remarks>
- Gets the UidValidity of the containing folder.
- </remarks>
- <value>The UidValidity of the containing folder.</value>
- </member>
- <member name="P:MailKit.UniqueIdRange.Min">
- <summary>
- Gets the minimum unique identifier in the range.
- </summary>
- <remarks>
- Gets the minimum unique identifier in the range.
- </remarks>
- <value>The minimum unique identifier.</value>
- </member>
- <member name="P:MailKit.UniqueIdRange.Max">
- <summary>
- Gets the maximum unique identifier in the range.
- </summary>
- <remarks>
- Gets the maximum unique identifier in the range.
- </remarks>
- <value>The maximum unique identifier.</value>
- </member>
- <member name="P:MailKit.UniqueIdRange.Start">
- <summary>
- Get the start of the unique identifier range.
- </summary>
- <remarks>
- Gets the start of the unique identifier range.
- </remarks>
- <value>The start of the range.</value>
- </member>
- <member name="P:MailKit.UniqueIdRange.End">
- <summary>
- Get the end of the unique identifier range.
- </summary>
- <remarks>
- Gets the end of the unique identifier range.
- </remarks>
- <value>The end of the range.</value>
- </member>
- <member name="P:MailKit.UniqueIdRange.Count">
- <summary>
- Get the number of unique identifiers in the range.
- </summary>
- <remarks>
- Gets the number of unique identifiers in the range.
- </remarks>
- <value>The count.</value>
- </member>
- <member name="P:MailKit.UniqueIdRange.IsReadOnly">
- <summary>
- Get whether or not the range is read only.
- </summary>
- <remarks>
- A <see cref="T:MailKit.UniqueIdRange"/> is always read-only.
- </remarks>
- <value><c>true</c> if the range is read only; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.UniqueIdRange.Add(MailKit.UniqueId)">
- <summary>
- Adds the unique identifier to the range.
- </summary>
- <remarks>
- Since a <see cref="T:MailKit.UniqueIdRange"/> is read-only, unique ids cannot
- be added to the range.
- </remarks>
- <param name="uid">The unique identifier to add.</param>
- <exception cref="T:System.NotSupportedException">
- The list does not support adding items.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdRange.Clear">
- <summary>
- Clears the list.
- </summary>
- <remarks>
- Since a <see cref="T:MailKit.UniqueIdRange"/> is read-only, the range cannot be cleared.
- </remarks>
- <exception cref="T:System.NotSupportedException">
- The list does not support being cleared.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdRange.Contains(MailKit.UniqueId)">
- <summary>
- Checks if the range contains the specified unique id.
- </summary>
- <remarks>
- Determines whether or not the range contains the specified unique id.
- </remarks>
- <returns><value>true</value> if the specified unique identifier is in the range; otherwise <value>false</value>.</returns>
- <param name="uid">The unique id.</param>
- </member>
- <member name="M:MailKit.UniqueIdRange.CopyTo(MailKit.UniqueId[],System.Int32)">
- <summary>
- Copies all of the unique ids in the range to the specified array.
- </summary>
- <remarks>
- Copies all of the unique ids within the range into the array,
- starting at the specified array index.
- </remarks>
- <param name="array">The array to copy the unique ids to.</param>
- <param name="arrayIndex">The index into the array.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="array"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="arrayIndex"/> is out of range.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdRange.Remove(MailKit.UniqueId)">
- <summary>
- Removes the unique identifier from the range.
- </summary>
- <remarks>
- Since a <see cref="T:MailKit.UniqueIdRange"/> is read-only, unique ids cannot be removed.
- </remarks>
- <returns><value>true</value> if the unique identifier was removed; otherwise <value>false</value>.</returns>
- <param name="uid">The unique identifier to remove.</param>
- <exception cref="T:System.NotSupportedException">
- The list does not support removing items.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdRange.IndexOf(MailKit.UniqueId)">
- <summary>
- Gets the index of the specified unique id, if it exists.
- </summary>
- <remarks>
- Finds the index of the specified unique id, if it exists.
- </remarks>
- <returns>The index of the specified unique id; otherwise <value>-1</value>.</returns>
- <param name="uid">The unique id.</param>
- </member>
- <member name="M:MailKit.UniqueIdRange.Insert(System.Int32,MailKit.UniqueId)">
- <summary>
- Inserts the specified unique identifier at the given index.
- </summary>
- <remarks>
- Inserts the unique identifier at the specified index in the range.
- </remarks>
- <param name="index">The index to insert the unique id.</param>
- <param name="uid">The unique id.</param>
- <exception cref="T:System.NotSupportedException">
- The list does not support inserting items.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdRange.RemoveAt(System.Int32)">
- <summary>
- Removes the unique identifier at the specified index.
- </summary>
- <remarks>
- Removes the unique identifier at the specified index.
- </remarks>
- <param name="index">The index.</param>
- <exception cref="T:System.NotSupportedException">
- The list does not support removing items.
- </exception>
- </member>
- <member name="P:MailKit.UniqueIdRange.Item(System.Int32)">
- <summary>
- Gets or sets the unique identifier at the specified index.
- </summary>
- <remarks>
- Gets or sets the unique identifier at the specified index.
- </remarks>
- <value>The unique identifier at the specified index.</value>
- <param name="index">The index.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The list does not support setting items.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdRange.GetEnumerator">
- <summary>
- Gets an enumerator for the range of unique ids.
- </summary>
- <remarks>
- Gets an enumerator for the range of unique ids.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.UniqueIdRange.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Gets an enumerator for the range of unique ids.
- </summary>
- <remarks>
- Gets an enumerator for the range of unique ids.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.UniqueIdRange.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueIdRange"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueIdRange"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueIdRange"/>.</returns>
- </member>
- <member name="M:MailKit.UniqueIdRange.TryParse(System.String,System.UInt32,MailKit.UniqueIdRange@)">
- <summary>
- Attempt to parse a unique identifier range.
- </summary>
- <remarks>
- Attempts to parse a unique identifier range.
- </remarks>
- <returns><c>true</c> if the unique identifier range was successfully parsed; otherwise, <c>false.</c>.</returns>
- <param name="token">The token to parse.</param>
- <param name="validity">The UIDVALIDITY value.</param>
- <param name="range">The unique identifier range.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="token"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdRange.TryParse(System.String,MailKit.UniqueIdRange@)">
- <summary>
- Attempt to parse a unique identifier range.
- </summary>
- <remarks>
- Attempts to parse a unique identifier range.
- </remarks>
- <returns><c>true</c> if the unique identifier range was successfully parsed; otherwise, <c>false.</c>.</returns>
- <param name="token">The token to parse.</param>
- <param name="range">The unique identifier range.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="token"/> is <c>null</c>.
- </exception>
- </member>
- <member name="T:MailKit.UniqueIdSet">
- <summary>
- A set of unique identifiers.
- </summary>
- <remarks>
- When dealing with a large number of unique identifiers, it may be more efficient to use a
- <see cref="T:MailKit.UniqueIdSet"/> than a typical IList<<see cref="T:MailKit.UniqueId"/>>.
- </remarks>
- </member>
- <member name="M:MailKit.UniqueIdSet.#ctor(System.UInt32,MailKit.Search.SortOrder)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.UniqueIdSet"/> class.
- </summary>
- <remarks>
- Creates a new unique identifier set.
- </remarks>
- <param name="validity">The uid validity.</param>
- <param name="order">The sorting order to use for the unique identifiers.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="order"/> is invalid.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.#ctor(MailKit.Search.SortOrder)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.UniqueIdSet"/> class.
- </summary>
- <remarks>
- Creates a new unique identifier set.
- </remarks>
- <param name="order">The sorting order to use for the unique identifiers.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="order"/> is invalid.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.#ctor(System.Collections.Generic.IEnumerable{MailKit.UniqueId},MailKit.Search.SortOrder)">
- <summary>
- Initializes a new instance of the <see cref="T:MailKit.UniqueIdSet"/> class.
- </summary>
- <remarks>
- Creates a new set of unique identifier set containing the specified uids.
- </remarks>
- <param name="uids">An initial set of unique ids.</param>
- <param name="order">The sorting order to use for the unique identifiers.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="order"/> is invalid.
- </exception>
- </member>
- <member name="P:MailKit.UniqueIdSet.SortOrder">
- <summary>
- Gets the sort order of the unique identifiers.
- </summary>
- <remarks>
- Gets the sort order of the unique identifiers.
- </remarks>
- <value>The sort order.</value>
- </member>
- <member name="P:MailKit.UniqueIdSet.Validity">
- <summary>
- Gets the validity, if non-zero.
- </summary>
- <remarks>
- Gets the UidValidity of the containing folder.
- </remarks>
- <value>The UidValidity of the containing folder.</value>
- </member>
- <member name="P:MailKit.UniqueIdSet.Count">
- <summary>
- Get the number of unique ids in the set.
- </summary>
- <remarks>
- Gets the number of unique ids in the set.
- </remarks>
- <value>The count.</value>
- </member>
- <member name="P:MailKit.UniqueIdSet.IsReadOnly">
- <summary>
- Get whether or not the set is read only.
- </summary>
- <remarks>
- Gets whether or not the set is read-only.
- </remarks>
- <value><c>true</c> if the set is read only; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:MailKit.UniqueIdSet.Add(MailKit.UniqueId)">
- <summary>
- Adds the unique identifier to the set.
- </summary>
- <remarks>
- Adds the unique identifier to the set.
- </remarks>
- <param name="uid">The unique identifier to add.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="uid"/> is invalid.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.AddRange(System.Collections.Generic.IEnumerable{MailKit.UniqueId})">
- <summary>
- Adds all of the uids to the set.
- </summary>
- <remarks>
- Adds all of the uids to the set.
- </remarks>
- <param name="uids">The collection of uids.</param>
- </member>
- <member name="M:MailKit.UniqueIdSet.Clear">
- <summary>
- Clears the list.
- </summary>
- <remarks>
- Clears the list.
- </remarks>
- <exception cref="T:System.InvalidOperationException">
- The collection is readonly.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.Contains(MailKit.UniqueId)">
- <summary>
- Checks if the set contains the specified unique id.
- </summary>
- <remarks>
- Determines whether or not the set contains the specified unique id.
- </remarks>
- <returns><value>true</value> if the specified unique identifier is in the set; otherwise <value>false</value>.</returns>
- <param name="uid">The unique id.</param>
- </member>
- <member name="M:MailKit.UniqueIdSet.CopyTo(MailKit.UniqueId[],System.Int32)">
- <summary>
- Copies all of the unique ids in the set to the specified array.
- </summary>
- <remarks>
- Copies all of the unique ids within the set into the array,
- starting at the specified array index.
- </remarks>
- <param name="array">The array to copy the unique ids to.</param>
- <param name="arrayIndex">The index into the array.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="array"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="arrayIndex"/> is out of set.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.Remove(MailKit.UniqueId)">
- <summary>
- Removes the unique identifier from the set.
- </summary>
- <remarks>
- Removes the unique identifier from the set.
- </remarks>
- <returns><value>true</value> if the unique identifier was removed; otherwise <value>false</value>.</returns>
- <param name="uid">The unique identifier to remove.</param>
- </member>
- <member name="M:MailKit.UniqueIdSet.IndexOf(MailKit.UniqueId)">
- <summary>
- Gets the index of the specified unique id, if it exists.
- </summary>
- <remarks>
- Finds the index of the specified unique id, if it exists.
- </remarks>
- <returns>The index of the specified unique id; otherwise <value>-1</value>.</returns>
- <param name="uid">The unique id.</param>
- </member>
- <member name="M:MailKit.UniqueIdSet.Insert(System.Int32,MailKit.UniqueId)">
- <summary>
- Inserts the specified unique identifier at the given index.
- </summary>
- <remarks>
- Inserts the unique identifier at the specified index in the set.
- </remarks>
- <param name="index">The index to insert the unique id.</param>
- <param name="uid">The unique id.</param>
- <exception cref="T:System.NotSupportedException">
- The list does not support inserting items.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.RemoveAt(System.Int32)">
- <summary>
- Removes the unique identifier at the specified index.
- </summary>
- <remarks>
- Removes the unique identifier at the specified index.
- </remarks>
- <param name="index">The index.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- </member>
- <member name="P:MailKit.UniqueIdSet.Item(System.Int32)">
- <summary>
- Gets or sets the unique identifier at the specified index.
- </summary>
- <remarks>
- Gets or sets the unique identifier at the specified index.
- </remarks>
- <value>The unique identifier at the specified index.</value>
- <param name="index">The index.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is out of range.
- </exception>
- <exception cref="T:System.NotSupportedException">
- The list does not support setting items.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.GetEnumerator">
- <summary>
- Gets an enumerator for the set of unique ids.
- </summary>
- <remarks>
- Gets an enumerator for the set of unique ids.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.UniqueIdSet.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Gets an enumerator for the set of unique ids.
- </summary>
- <remarks>
- Gets an enumerator for the set of unique ids.
- </remarks>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:MailKit.UniqueIdSet.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueIdSet"/>.
- </summary>
- <remarks>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueIdSet"/>.
- </remarks>
- <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueIdSet"/>.</returns>
- </member>
- <member name="M:MailKit.UniqueIdSet.ToString(System.Collections.Generic.IList{MailKit.UniqueId})">
- <summary>
- Format a generic list of unique identifiers as a string.
- </summary>
- <remarks>
- Formats a generic list of unique identifiers as a string.
- </remarks>
- <returns>The string representation of the collection of unique identifiers.</returns>
- <param name="uids">The unique identifiers.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the unique identifiers is invalid (has a value of <c>0</c>).
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.EnumerateSerializedSubsets(System.Int32)">
- <summary>
- Format the set of unique identifiers as multiple strings that fit within the maximum defined character length.
- </summary>
- <remarks>
- Formats the set of unique identifiers as multiple strings that fit within the maximum defined character length.
- </remarks>
- <returns>A list of strings representing the collection of unique identifiers.</returns>
- <param name="maxLength">The maximum length of any returned string of UIDs.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="maxLength"/> is negative.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.EnumerateSerializedSubsets(System.Collections.Generic.IList{MailKit.UniqueId},System.Int32)">
- <summary>
- Format a generic list of unique identifiers as multiple strings that fit within the maximum defined character length.
- </summary>
- <remarks>
- Formats a generic list of unique identifiers as multiple strings that fit within the maximum defined character length.
- </remarks>
- <returns>A list of strings representing the collection of unique identifiers.</returns>
- <param name="uids">The unique identifiers.</param>
- <param name="maxLength">The maximum length of any returned string of UIDs.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uids"/> is <c>null</c>.
- </exception>
- <exception cref="T:System.ArgumentException">
- One or more of the unique identifiers is invalid (has a value of <c>0</c>).
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="maxLength"/> is negative.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.TryParse(System.String,System.UInt32,MailKit.UniqueIdSet@)">
- <summary>
- Attempt to parse the specified token as a set of unique identifiers.
- </summary>
- <remarks>
- Attempts to parse the specified token as a set of unique identifiers.
- </remarks>
- <returns><c>true</c> if the set of unique identifiers were successfully parsed; otherwise, <c>false</c>.</returns>
- <param name="token">The token containing the set of unique identifiers.</param>
- <param name="validity">The UIDVALIDITY value.</param>
- <param name="uids">The set of unique identifiers.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="token"/> is <c>null</c>.
- </exception>
- </member>
- <member name="M:MailKit.UniqueIdSet.TryParse(System.String,MailKit.UniqueIdSet@)">
- <summary>
- Attempt to parse the specified token as a set of unique identifiers.
- </summary>
- <remarks>
- Attempts to parse the specified token as a set of unique identifiers.
- </remarks>
- <returns><c>true</c> if the set of unique identifiers were successfully parsed; otherwise, <c>false</c>.</returns>
- <param name="token">The token containing the set of unique identifiers.</param>
- <param name="uids">The set of unique identifiers.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="token"/> is <c>null</c>.
- </exception>
- </member>
- </members>
- </doc>
|